Enum mediasoup::producer::Producer

#[non_exhaustive]
pub enum Producer {
    Regular(RegularProducer),
    Direct(DirectProducer),
}

A producer represents an audio or video source being injected into a mediasoup router. It’s created on top of a transport that defines how the media packets are carried.

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(RegularProducer)

Producer created on transport other than DirectTransport.

Direct(DirectProducer)

Producer created on DirectTransport.

Implementations

impl Producer

pub fn id(&self) -> ProducerId

Producer identifier.

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

Transport to which producer belongs.

pub fn kind(&self) -> MediaKind

Media kind.

pub fn rtp_parameters(&self) -> &RtpParameters

Producer RTP parameters.

Notes on usage

Check the RTP Parameters and Capabilities section for more details (TypeScript-oriented, but concepts apply here as well).

pub fn type(&self) -> ProducerType

Producer type.

pub fn paused(&self) -> bool

Whether the Producer is paused.

pub fn score(&self) -> Vec<ProducerScore>

The score of each RTP stream being received, representing their transmission quality.

pub fn app_data(&self) -> &AppData

Custom application data.

pub fn closed(&self) -> bool

Whether the producer is closed.

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

Returns current RTC statistics of the 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 producer (no RTP is sent to its associated consumers). Calls Consumer::on_producer_pause callback on all its associated consumers.

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

Resumes the producer (RTP is sent to its associated consumers). Calls Consumer::on_producer_resume callback on all its associated consumers.

pub async fn enable_trace_event( &self, types: Vec<ProducerTraceEventType> ) -> Result<(), RequestError>

Instructs the procuer to emit “trace” events. For monitoring purposes. Use with caution.

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

Callback is called when the producer score changes.

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

Callback is called when the video orientation changes. This is just possible if the urn:3gpp:video-orientation RTP extension has been negotiated in the producer RTP parameters.

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

Callback is called when the producer is paused.

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

Callback is called when the producer is resumed.

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

See Producer::enable_trace_event method.

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

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

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 producer is already closed.

pub fn downgrade(&self) -> WeakProducer

Downgrade Producer to WeakProducer instance.

Trait Implementations

impl Clone for Producer

fn clone(&self) -> Producer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Producer

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

Formats the value using the given formatter.

impl From<DirectProducer> for Producer

fn from(producer: DirectProducer) -> Self

Converts to this type from the input type.

impl From<RegularProducer> for Producer

fn from(producer: RegularProducer) -> Self

Converts to this type from the input type.