Struct gstreamer::StreamCollection

pub struct StreamCollection(_, _);

A collection of Stream that are available.

A StreamCollection will be provided by elements that can make those streams available. Applications can use the collection to show the user what streams are available by using StreamCollection::get_stream()

Once posted, a StreamCollection is immutable. Updates are made by sending a new StreamCollection message, which may or may not share some of the Stream objects from the collection it replaces. The receiver can check the sender of a stream collection message to know which collection is obsoleted.

Several elements in a pipeline can provide StreamCollection.

Applications can activate streams from a collection by using the EventType::SelectStreams event on a pipeline, bin or element.

Feature: v1_10

Implements

GstObjectExt, glib::object::ObjectExt

Methods

impl StreamCollection

pub fn add_stream(&self, stream: &Stream) -> bool

Add the given stream to the self.

Feature: v1_10

stream

the Stream to add

Returns

true if the stream was properly added, else false

pub fn get_size(&self) -> u32

Get the number of streams this collection contains

Feature: v1_10

Returns

The number of streams that self contains

pub fn get_stream(&self, index: u32) -> Option<Stream>

Retrieve the Stream with index index from the collection.

The caller should not modify the returned Stream

Feature: v1_10

index

Index of the stream to retrieve

Returns

A Stream

pub fn get_upstream_id(&self) -> Option<String>

Returns the upstream id of the self.

Feature: v1_10

Returns

The upstream id

pub fn get_property_upstream_id(&self) -> Option<String>

pub fn set_property_upstream_id(&self, upstream_id: Option<&str>)

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

impl StreamCollection

pub fn new<'a, P: Into<Option<&'a str>>>(upstream_id: P) -> StreamCollection

Create a new StreamCollection.

Feature: v1_10

upstream_id

The stream id of the parent stream

Returns

The new StreamCollection.

Important traits for Iter<'a>

impl<'a> Iterator for Iter<'a> type Item = Stream;

pub fn iter(&self) -> Iter

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for StreamCollection

fn clone(&self) -> StreamCollection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for StreamCollection

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,

Feeds a slice of this type into the given [Hasher].

impl Ord for StreamCollection

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl StaticType for StreamCollection

fn static_type() -> Type

Returns the type identifier of Self.

impl<T: IsA<Object>> PartialEq<T> for StreamCollection

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Eq for StreamCollection

impl<T: IsA<Object>> PartialOrd<T> for StreamCollection

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 Debug for StreamCollection

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

Formats the value using the given formatter.

impl IsA<Object> for StreamCollection

impl IsA<Object> for StreamCollection

impl Send for StreamCollection

impl Sync for StreamCollection