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,
}

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.

Implementations

impl EventType

pub fn flags(self) -> EventTypeFlags

pub fn name<'a>(self) -> &'a GStr

pub fn to_quark(self) -> Quark

impl EventType

pub fn is_upstream(self) -> bool

pub fn is_downstream(self) -> bool

pub fn is_serialized(self) -> bool

pub fn is_sticky(self) -> bool

pub fn is_sticky_multi(self) -> bool

Trait Implementations

impl Clone for EventType

fn clone(&self) -> EventType

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EventType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for EventType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<EventType> for Value

fn from(v: EventType) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for EventType

type Checker = GenericValueTypeChecker<EventType>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl HasParamSpec for EventType

type ParamSpec = ParamSpecEnum

type SetValue = EventType

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str, _: EventType) -> ParamSpecEnumBuilder<'_, EventType>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for EventType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EventType

fn eq(&self, other: &EventType) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for EventType

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for EventType

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for EventType

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ValueType for EventType

type Type = EventType

Type to get the Type from.

impl Copy for EventType

impl Eq for EventType

impl StructuralPartialEq for EventType