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

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§

source§

impl EventType

source

pub fn flags(self) -> EventTypeFlags

source

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

source

pub fn to_quark(self) -> Quark

source§

impl EventType

source

pub fn is_upstream(self) -> bool

source

pub fn is_downstream(self) -> bool

source

pub fn is_serialized(self) -> bool

source

pub fn is_sticky(self) -> bool

source

pub fn is_sticky_multi(self) -> bool

Trait Implementations§

source§

impl Clone for EventType

source§

fn clone(&self) -> EventType

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for EventType

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for EventType

source§

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

Formats the value using the given formatter. Read more
source§

impl From<EventType> for Value

source§

fn from(v: EventType) -> Self

Converts to this type from the input type.
source§

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

§

type Checker = GenericValueTypeChecker<EventType>

Value type checker.
source§

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

Get the contained value from a Value. Read more
source§

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>

source§

fn param_spec_builder() -> Self::BuilderFn

source§

impl Hash for EventType

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for EventType

source§

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

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

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.
source§

impl PartialOrd for EventType

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl StaticType for EventType

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl ToValue for EventType

source§

fn to_value(&self) -> Value

Convert a value to a Value.
source§

fn value_type(&self) -> Type

Returns the type identifier of self. Read more
source§

impl ValueType for EventType

§

type Type = EventType

Type to get the Type from. Read more
source§

impl Copy for EventType

source§

impl Eq for EventType

source§

impl StructuralPartialEq for EventType

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> IntoClosureReturnValue for T
where T: Into<Value>,

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Property for T
where T: HasParamSpec,

§

type Value = T

source§

impl<T> PropertyGet for T
where T: HasParamSpec,

§

type Value = T

source§

fn get<R, F>(&self, f: F) -> R
where F: Fn(&<T as PropertyGet>::Value) -> R,

source§

impl<T> StaticTypeExt for T
where T: StaticType,

source§

fn ensure_type()

Ensures that the type has been registered with the type system.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToSendValue for T
where T: Send + ToValue + ?Sized,

source§

fn to_send_value(&self) -> SendValue

Returns a SendValue clone of self.
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T> TryFromClosureReturnValue for T
where T: for<'a> FromValue<'a> + StaticType + 'static,

source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.