Struct StreamProducer

pub struct StreamProducer { /* private fields */ }

The interface for transporting media data from one node to another.

A producer is essentially a GStreamer appsink whose output is sent to a set of consumers, who are essentially appsrc wrappers

Implementations

impl StreamProducer

pub fn configure_consumer(consumer: &AppSrc)

Configure a consumer appsrc for later use in a StreamProducer

This is automatically called when calling add_consumer().

pub fn add_consumer( &self, consumer: &AppSrc, ) -> Result<ConsumptionLink, AddConsumerError>

Add an appsrc to dispatch data to.

Dropping the returned ConsumptionLink will automatically disconnect the consumer from the producer.

pub fn remove_consumer(&self, consumer: &AppSrc)

Remove a consumer appsrc by id

pub fn set_forward_events( &self, events_to_forward: impl IntoIterator<Item = EventType>, )

configure event types the appsink should forward to all its consumers (default: Eos).

pub fn set_forward_preroll(&self, forward_preroll: bool)

configure whether the preroll sample should be forwarded (default: true)

pub fn appsink(&self) -> &AppSink

Get the GStreamer appsink wrapped by this producer

pub fn error(&self, error: &Error, debug: Option<&str>)

Signals an error on all consumers

pub fn last_sample(&self) -> Option<Sample>

The last sample produced by this producer.

Trait Implementations

impl Clone for StreamProducer

fn clone(&self) -> StreamProducer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamProducer

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

Formats the value using the given formatter.

impl<'a> From<&'a AppSink> for StreamProducer

fn from(appsink: &'a AppSink) -> Self

Converts to this type from the input type.

impl PartialEq for StreamProducer

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for StreamProducer