[][src]Enum gstreamer::EventType

#[non_exhaustive]pub enum EventType {
    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
}

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)

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

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

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.

Methods

impl EventType[src]

pub fn is_upstream(self) -> bool[src]

pub fn is_downstream(self) -> bool[src]

pub fn is_serialized(self) -> bool[src]

pub fn is_sticky(self) -> bool[src]

pub fn is_sticky_multi(self) -> bool[src]

Trait Implementations

impl Clone for EventType[src]

impl Copy for EventType[src]

impl Debug for EventType[src]

impl Eq for EventType[src]

impl<'a> FromValue<'a> for EventType[src]

impl<'a> FromValueOptional<'a> for EventType[src]

impl Hash for EventType[src]

impl PartialEq<EventType> for EventType[src]

impl PartialOrd<EventType> for EventType[src]

impl SetValue for EventType[src]

impl StaticType for EventType[src]

impl StructuralEq for EventType[src]

impl StructuralPartialEq for EventType[src]

Auto Trait Implementations

impl RefUnwindSafe for EventType

impl Send for EventType

impl Sync for EventType

impl Unpin for EventType

impl UnwindSafe for EventType

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToSendValue for T where
    T: ToValue + SetValue + Send + ?Sized
[src]

impl<T> ToValue for T where
    T: SetValue + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.