Enum DataProducer

#[non_exhaustive]
pub enum DataProducer {
    Regular(RegularDataProducer),
    Direct(DirectDataProducer),
}

A data producer represents an endpoint capable of injecting data messages into a mediasoup Router.

A data producer can use SCTP (AKA DataChannel) to deliver those messages, or can directly send them from the Rust application if the data producer was created on top of a DirectTransport.

Variants (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.

Regular(RegularDataProducer)

Data producer created on transport other than DirectTransport.

Direct(DirectDataProducer)

Data producer created on DirectTransport.

Implementations

impl DataProducer

pub fn id(&self) -> DataProducerId

Data producer identifier.

pub fn transport(&self) -> &Arc<dyn Transport>

Transport to which data producer belongs.

pub fn type(&self) -> DataProducerType

The type of the data producer.

pub fn sctp_stream_parameters(&self) -> Option<SctpStreamParameters>

The SCTP stream parameters (just if the data producer type is Sctp).

pub fn paused(&self) -> bool

Whether the DataProducer is paused.

pub fn label(&self) -> &String

The data producer label.

pub fn protocol(&self) -> &String

The data producer sub-protocol.

pub fn app_data(&self) -> &AppData

Custom application data.

pub fn closed(&self) -> bool

Whether the data producer is closed.

pub async fn get_stats(&self) -> Result<Vec<DataProducerStat>, RequestError>

Returns current statistics of the data producer.

Check the RTC Statistics section for more details (TypeScript-oriented, but concepts apply here as well).

pub async fn pause(&self) -> Result<(), RequestError>

Pauses the data producer (no message is sent to its associated data consumers). Calls DataConsumer::on_data_producer_pause callback on all its associated data consumers.

pub async fn resume(&self) -> Result<(), RequestError>

Resumes the data producer (messages are sent to its associated data consumers). Calls DataConsumer::on_data_producer_resume callback on all its associated data consumers.

pub fn on_transport_close<F: FnOnce() + Send + 'static>( &self, callback: F, ) -> HandlerId

Callback is called when the transport this data producer belongs to is closed for whatever reason. The producer itself is also closed. A on_data_producer_close callback is called on all its associated consumers.

pub fn on_pause<F: Fn() + Send + Sync + 'static>( &self, callback: F, ) -> HandlerId

Callback is called when the data producer is paused.

pub fn on_resume<F: Fn() + Send + Sync + 'static>( &self, callback: F, ) -> HandlerId

Callback is called when the data producer is resumed.

pub fn on_close<F: FnOnce() + Send + 'static>(&self, callback: F) -> HandlerId

Callback is called when the producer is closed for whatever reason.

NOTE: Callback will be called in place if data producer is already closed.

pub fn downgrade(&self) -> WeakDataProducer

Downgrade DataProducer to WeakDataProducer instance.

Trait Implementations

impl Clone for DataProducer

fn clone(&self) -> DataProducer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataProducer

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

Formats the value using the given formatter.

impl From<DirectDataProducer> for DataProducer

fn from(producer: DirectDataProducer) -> Self

Converts to this type from the input type.

impl From<RegularDataProducer> for DataProducer

fn from(producer: RegularDataProducer) -> Self

Converts to this type from the input type.