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)

Configures a consumer appsrc for later use in a StreamProducer.

This function configures the appsrc in a suitable state to act as a consumer and also sets the internal queue properties as follows:

• max-buffers <- 0 (unlimited)
• max-bytes <- 0 (unlimited)
• max-time <- 500ms

If you need different settings, call StreamProducer::configure_consumer_with instead.

This is automatically invoked when calling StreamProducer::add_consumer.

pub fn configure_consumer_with(consumer: &AppSrc, settings: ConsumerSettings)

Configures a consumer appsrc for later use in a StreamProducer.

This function configures the appsrc in a suitable state to act as a consumer and applies the provided settings.

If unsure, call StreamProducer::configure_consumer instead.

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

Adds an appsrc to dispatch data to.

This function configures the appsrc in a suitable state to act as a consumer and also sets the internal queue properties as follows:

• max-buffers <- 0 (unlimited)
• max-bytes <- 0 (unlimited)
• max-time <- 500ms

If you need different values, call StreamProducer::add_consumer_with instead.

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

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

Adds a configured appsrc to dispatch data to.

This function configures the appsrc in a suitable state to act as a consumer and applies the provided settings.

If unsure, call StreamProducer::add_consumer instead.

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 get_forwarded_events(&self) -> Vec<EventType>

get event types the appsink should forward to all its consumers

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.

impl StreamProducer

pub fn from(appsink: &AppSink) -> Self

Adds an appsink to dispatch data from.

This function configures the appsink in a suitable state to act as a producer and also sets the properties as follows:

• sync <- true (sync on the clock)

If you need a different value, use StreamProducer::with instead.

pub fn with(appsink: &AppSink, settings: ProducerSettings) -> Self

Adds an appsink to dispatch data from.

This function configures the appsink in a suitable state to act as a producer and applies the provided settings.

If unsure, use StreamProducer::from instead.

Trait Implementations

impl Clone for StreamProducer

fn clone(&self) -> StreamProducer

Returns a duplicate 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 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