Struct gstreamer::Stream

pub struct Stream { /* private fields */ }

A high-level object representing a single stream. It might be backed, or not, by an actual flow of data in a pipeline (Pad).

A Stream does not care about data changes (such as decoding, encoding, parsing,…) as long as the underlying data flow corresponds to the same high-level flow (ex: a certain audio track).

A Stream contains all the information pertinent to a stream, such as stream-id, tags, caps, type, …

Elements can subclass a Stream for internal usage (to contain information pertinent to streams of data).

Properties

caps

The Caps of the Stream.

Readable | Writeable

stream-flags

Readable | Writeable | Construct

stream-id

The unique identifier of the Stream. Can only be set at construction time.

Readable | Writeable | Construct Only

stream-type

The StreamType of the Stream. Can only be set at construction time.

Readable | Writeable | Construct

tags

The TagList of the Stream.

Readable | Writeable

Object

name

Readable | Writeable | Construct

parent

The parent of the object. Please note, that when changing the ‘parent’ property, we don’t emit notify and deep-notify signals due to locking issues. In some cases one can use element-added or element-removed signals on the parent to achieve a similar effect.

Readable | Writeable

Implements

GstObjectExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Stream

pub fn new( stream_id: Option<&str>, caps: Option<&Caps>, type_: StreamType, flags: StreamFlags, ) -> Stream

Create a new Stream for the given stream_id, caps, type_ and flags

stream_id

the id for the new stream. If None, a new one will be automatically generated

caps

the Caps of the stream

type_

the StreamType of the stream

flags

the StreamFlags of the stream

Returns

The new Stream

pub fn caps(&self) -> Option<Caps>

Retrieve the caps for self, if any

Returns

The Caps for self

pub fn stream_flags(&self) -> StreamFlags

Retrieve the current stream flags for self

Returns

The StreamFlags for self

pub fn stream_id(&self) -> Option<GString>

Returns the stream ID of self.

Returns

the stream ID of self. Only valid during the lifetime of self.

pub fn stream_type(&self) -> StreamType

Retrieve the stream type for self

Returns

The StreamType for self

pub fn tags(&self) -> Option<TagList>

Retrieve the tags for self, if any

Returns

The TagList for self

pub fn set_caps(&self, caps: Option<&Caps>)

Set the caps for the Stream

caps

a Caps

pub fn set_stream_flags(&self, flags: StreamFlags)

Set the flags for the self.

flags

the flags to set on self

pub fn set_stream_type(&self, stream_type: StreamType)

Set the stream type of self

stream_type

the type to set on self

pub fn set_tags(&self, tags: Option<&TagList>)

Set the tags for the Stream

tags

a TagList

pub fn connect_caps_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_stream_flags_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_stream_type_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_tags_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

impl Stream

pub fn debug(&self) -> Debug<'_>

Trait Implementations

impl Clone for Stream

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for Stream

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

Formats the value using the given formatter.

impl HasParamSpec for Stream

type ParamSpec = ParamSpecObject

type SetValue = Stream

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

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Stream>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Stream

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

where H: Hasher,

Hashes the memory address of this object.

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 Ord for Stream

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for Stream

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Stream

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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<OT: ObjectType> PartialOrd<OT> for Stream

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 Stream

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Stream

impl IsA<Object> for Stream

impl Send for Stream

impl Sync for Stream