Gst.Stream¶

Subclasses:: None

Methods¶

Inherited:: Gst.Object (27), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (stream_id, caps, type, flags)
	`get_caps` ()
	`get_stream_flags` ()
	`get_stream_id` ()
	`get_stream_type` ()
	`get_tags` ()
	`set_caps` (caps)
	`set_stream_flags` (flags)
	`set_stream_type` (stream_type)
	`set_tags` (tags)

Virtual Methods¶

Inherited:: Gst.Object (1), GObject.Object (7)

Properties¶

Inherited:: Gst.Object (2)

Name	Type	Flags	Short Description
`caps`	`Gst.Caps`	r/w	The caps of the stream
`stream-flags`	`Gst.StreamFlags`	r/w/c	The stream flags
`stream-id`	`str`	r/w/co	The stream ID of the stream
`stream-type`	`Gst.StreamType`	r/w/c	The type of stream
`tags`	`Gst.TagList`	r/w	The tags of the stream

Signals¶

Inherited:: Gst.Object (1), GObject.Object (1)

Fields¶

Inherited:: Gst.Object (1), GObject.Object (1)

Name	Type	Access	Description
object	`Gst.Object`	r
stream_id	`str`	r	The Stream Identifier for this `Gst.Stream`

Class Details¶

class Gst.Stream(**kwargs)¶

Bases:: Gst.Object
Abstract:: No
Structure:: Gst.StreamClass

A high-level object representing a single stream. It might be backed, or not, by an actual flow of data in a pipeline (Gst.Pad).

A Gst.Stream does not care about data changes (such as decoding, encoding, parsing,…) as long as the underlying data flow corresponds to the same high-level flow (ex: a certain audio track).

A Gst.Stream contains all the information pertinent to a stream, such as stream-id, tags, caps, type, …

Elements can subclass a Gst.Stream for internal usage (to contain information pertinent to streams of data).

New in version 1.10.

classmethod new(stream_id, caps, type, flags)[source]¶

Parameters:

stream_id (str or None) – the id for the new stream. If None, a new one will be automatically generated
caps (Gst.Caps or None) – the Gst.Caps of the stream
type (Gst.StreamType) – the Gst.StreamType of the stream
flags (Gst.StreamFlags) – the Gst.StreamFlags of the stream

Returns:

The new Gst.Stream

Return type:

Gst.Stream

Create a new Gst.Stream for the given stream_id, caps, type and flags

New in version 1.10.

get_caps()[source]¶

Returns:: The Gst.Caps for self
Return type:: Gst.Caps or None

Retrieve the caps for self, if any

New in version 1.10.

get_stream_flags()[source]¶

Returns:: The Gst.StreamFlags for self
Return type:: Gst.StreamFlags

Retrieve the current stream flags for self

New in version 1.10.

get_stream_id()[source]¶

Returns:: the stream ID of self. Only valid during the lifetime of self.
Return type:: str or None

Returns the stream ID of self.

New in version 1.10.

get_stream_type()[source]¶

Returns:: The Gst.StreamType for self
Return type:: Gst.StreamType

Retrieve the stream type for self

New in version 1.10.

get_tags()[source]¶

Returns:: The Gst.TagList for self
Return type:: Gst.TagList or None

Retrieve the tags for self, if any

New in version 1.10.

set_caps(caps)[source]¶

Parameters:: caps (Gst.Caps or None) – a Gst.Caps

Set the caps for the Gst.Stream

New in version 1.10.

set_stream_flags(flags)[source]¶

Parameters:: flags (Gst.StreamFlags) – the flags to set on self

Set the flags for the self.

New in version 1.10.

set_stream_type(stream_type)[source]¶

Parameters:: stream_type (Gst.StreamType) – the type to set on self

Set the stream type of self

New in version 1.10.

set_tags(tags)[source]¶

Parameters:: tags (Gst.TagList or None) – a Gst.TagList

Set the tags for the Gst.Stream

New in version 1.10.

Property Details¶

Gst.Stream.props.caps¶

Name:: caps
Type:: Gst.Caps
Default Value:: None
Flags:: READABLE, WRITABLE

The Gst.Caps of the Gst.Stream.

Gst.Stream.props.stream_flags¶

Name:: stream-flags
Type:: Gst.StreamFlags
Default Value:: Gst.StreamFlags.NONE
Flags:: READABLE, WRITABLE, CONSTRUCT

The stream flags

Gst.Stream.props.stream_id¶

Name:: stream-id
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The unique identifier of the Gst.Stream. Can only be set at construction time.

Gst.Stream.props.stream_type¶

Name:: stream-type
Type:: Gst.StreamType
Default Value:: Gst.StreamType.UNKNOWN
Flags:: READABLE, WRITABLE, CONSTRUCT

The Gst.StreamType of the Gst.Stream. Can only be set at construction time.

Gst.Stream.props.tags¶

Name:: tags
Type:: Gst.TagList
Default Value:: None
Flags:: READABLE, WRITABLE

The Gst.TagList of the Gst.Stream.