EventType

class EventType

EventType lists the standard event types that can be sent in a pipeline.

The custom event types can be used for private messages between elements that can’t be expressed using normal GStreamer buffer passing semantics. Custom events carry an arbitrary Structure. Specific custom events are distinguished by the name of the structure.

Methods

class EventType

get_flags(type: EventType) → EventTypeFlags

Gets the EventTypeFlags associated with type.

Parameters:: type – a EventType

get_name(type: EventType) → str

Get a printable name for the given event type. Do not modify or free.

Parameters:: type – the event type

to_quark(type: EventType) → int

Get the unique quark for the given event type.

Parameters:: type – the event type

to_sticky_ordering(type: EventType) → int

Converts the EventType to an unsigned integer that represents the ordering of sticky events when re-sending them. A lower value represents a higher-priority event.

Added in version 1.22.

Parameters:: type – a EventType

Fields

class EventType

BUFFERSIZE: Notification of buffering requirements. Currently not used yet.

CAPS: Caps event. Notify the pad of a new media type.

CUSTOM_BOTH: Custom upstream or downstream event. In-band when travelling downstream.

CUSTOM_BOTH_OOB: Custom upstream or downstream out-of-band event.

CUSTOM_DOWNSTREAM: Downstream custom event that travels in the data flow.

CUSTOM_DOWNSTREAM_OOB: Custom out-of-band downstream event.

CUSTOM_DOWNSTREAM_STICKY: Custom sticky downstream event.

CUSTOM_UPSTREAM: Upstream custom event

EOS: End-Of-Stream. No more data is to be expected to follow without either a STREAM_START event, or a FLUSH_STOP and a SEGMENT event.

FLUSH_START: Start a flush operation. This event clears all data from the pipeline and unblock all streaming threads.

FLUSH_STOP: Stop a flush operation. This event resets the running-time of the pipeline.

GAP: Marks a gap in the datastream.

INSTANT_RATE_CHANGE: Notify downstream that a playback rate override should be applied as soon as possible. (Since: 1.18)

INSTANT_RATE_SYNC_TIME: Sent by the pipeline to notify elements that handle the instant-rate-change event about the running-time when the rate multiplier should be applied (or was applied). (Since: 1.18)

LATENCY: Notification of new latency adjustment. Sinks will use the latency information to adjust their synchronisation.

NAVIGATION: Navigation events are usually used for communicating user requests, such as mouse or keyboard movements, to upstream elements.

PROTECTION: An event which indicates that new or updated encryption information has been found in the stream.

QOS: A quality message. Used to indicate to upstream elements that the downstream elements should adjust their processing rate.

RECONFIGURE: A request for upstream renegotiating caps and reconfiguring.

SEEK: A request for a new playback position and rate.

SEGMENT: A new media segment follows in the dataflow. The segment events contains information for clipping buffers and converting buffer timestamps to running-time and stream-time.

SEGMENT_DONE: Marks the end of a segment playback.

SELECT_STREAMS: A request to select one or more streams (Since: 1.10)

SINK_MESSAGE: An event that sinks turn into a message. Used to send messages that should be emitted in sync with rendering.

STEP: A request for stepping through the media. Sinks will usually execute the step operation.

STREAM_COLLECTION: A new StreamCollection is available (Since: 1.10)

STREAM_GROUP_DONE: Indicates that there is no more data for the stream group ID in the message. Sent before EOS in some instances and should be handled mostly the same. (Since: 1.10)

STREAM_START: Event to mark the start of a new stream. Sent before any other serialized event and only sent at the start of a new stream, not after flushing seeks.

TAG: A new set of metadata tags has been found in the stream.

TOC: An event which indicates that a new table of contents (TOC) was found or updated.

TOC_SELECT: A request for a new playback position based on TOC entry’s UID.

UNKNOWN: Unknown event.