Enum gstreamer::EventType

source ·
#[non_exhaustive]
pub enum EventType {
Show 32 variants Unknown, FlushStart, FlushStop, StreamStart, Caps, Segment, StreamCollection, Tag, Buffersize, SinkMessage, StreamGroupDone, Eos, Toc, Protection, SegmentDone, Gap, InstantRateChange, Qos, Seek, Navigation, Latency, Step, Reconfigure, TocSelect, SelectStreams, InstantRateSyncTime, CustomUpstream, CustomDownstream, CustomDownstreamOob, CustomDownstreamSticky, CustomBoth, CustomBothOob, // some variants omitted
}
Expand description

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.

Variants (Non-exhaustive)

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unknown

unknown event.

FlushStart

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

FlushStop

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

StreamStart

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.

Caps

Caps event. Notify the pad of a new media type.

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.

StreamCollection

A new StreamCollection is available (Since: 1.10)

Tag

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

Buffersize

Notification of buffering requirements. Currently not used yet.

SinkMessage

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

StreamGroupDone

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)

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.

Toc

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

Protection

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

SegmentDone

Marks the end of a segment playback.

Gap

Marks a gap in the datastream.

InstantRateChange

Available on crate feature v1_18 only.

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

Qos

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

Seek

A request for a new playback position and rate.

Navigation

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

Latency

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

Step

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

Reconfigure

A request for upstream renegotiating caps and reconfiguring.

TocSelect

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

SelectStreams

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

InstantRateSyncTime

Available on crate feature v1_18 only.

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)

CustomUpstream

Upstream custom event

CustomDownstream

Downstream custom event that travels in the data flow.

CustomDownstreamOob

Custom out-of-band downstream event.

CustomDownstreamSticky

Custom sticky downstream event.

CustomBoth

Custom upstream or downstream event. In-band when travelling downstream.

CustomBothOob

Custom upstream or downstream out-of-band event.

Implementations

Trait Implementations

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Formats the value using the given formatter. Read more
Value type checker.
Get the contained value from a Value. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Returns the type identifier of Self.
Convert a value to a Value.
Returns the type identifer of self. Read more
Type to get the Type from. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Ensures that the type has been registered with the type system.
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
Returns a SendValue clone of self.
Converts the given value to a String. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.