StreamCollection

Added in version 1.10.

class StreamCollection(**properties: Any)

Superclasses: Object, InitiallyUnowned, Object

Constructors:

StreamCollection(**properties)
new(upstream_id:str=None) -> Gst.StreamCollection

Constructors

class StreamCollection

classmethod new(upstream_id: str | None = None) → StreamCollection

Create a new StreamCollection.

Added in version 1.10.

Parameters:

upstream_id – The stream id of the parent stream

Methods

class StreamCollection

add_stream(stream: Stream) → bool

Add the given stream to the collection.

Added in version 1.10.

Parameters:

stream – the Stream to add

get_size() → int

Get the number of streams this collection contains

Added in version 1.10.

get_stream(index: int) → Stream | None

Retrieve the Stream with index index from the collection.

The caller should not modify the returned Stream

Added in version 1.10.

Parameters:

index – Index of the stream to retrieve

get_upstream_id() → str | None

Returns the upstream id of the collection.

Added in version 1.10.

Properties

class StreamCollection

props.upstream_id: str

stream-id

Signals

class StreamCollection.signals

stream_notify(prop_stream: Stream, prop: ParamSpec) → None

The stream notify signal is used to be notified of property changes to streams within the collection.

Parameters:

• prop_stream – the Stream that originated the signal

• prop – the property that changed

Virtual Methods

class StreamCollection

do_stream_notify(stream: Stream, pspec: ParamSpec) → None

default signal handler for the stream-notify signal

Parameters:

• stream

• pspec

Fields

class StreamCollection

object

priv

upstream_id