FlowCombiner

Added in version 1.4.

class FlowCombiner(**kwargs)
Constructors:

new() -> GstBase.FlowCombiner

Constructors

class FlowCombiner
classmethod new() → FlowCombiner

Creates a new FlowCombiner, use free() to free it.

Added in version 1.4.

Methods

class FlowCombiner
add_pad(pad: Pad) → None

Adds a new Pad to the FlowCombiner.

Added in version 1.4.

Parameters:

pad – the Pad that is being added

clear() → None

Removes all pads from a FlowCombiner and resets it to its initial state.

Added in version 1.6.

free() → None

Frees a FlowCombiner struct and all its internal data.

Added in version 1.4.

remove_pad(pad: Pad) → None

Removes a Pad from the FlowCombiner.

Added in version 1.4.

Parameters:

pad – the Pad to remove

reset() → None

Reset flow combiner and all pads to their initial state without removing pads.

Added in version 1.6.

update_flow(fret: FlowReturn) → FlowReturn

Computes the combined flow return for the pads in it.

The FlowReturn parameter should be the last flow return update for a pad in this FlowCombiner. It will use this value to be able to shortcut some combinations and avoid looking over all pads again. e.g. The last combined return is the same as the latest obtained FlowReturn.

Added in version 1.4.

Parameters:

fret – the latest FlowReturn received for a pad in this FlowCombiner

update_pad_flow(pad: Pad, fret: FlowReturn) → FlowReturn

Sets the provided pad’s last flow return to provided value and computes the combined flow return for the pads in it.

The FlowReturn parameter should be the last flow return update for a pad in this FlowCombiner. It will use this value to be able to shortcut some combinations and avoid looking over all pads again. e.g. The last combined return is the same as the latest obtained FlowReturn.

Added in version 1.6.

Parameters: