Struct mediasoup::consumer::Consumer

pub struct Consumer { /* fields omitted */ }

Implementations

impl Consumer

pub fn id(&self) -> ConsumerId

Consumer id.

pub fn producer_id(&self) -> ProducerId

Associated Producer id.

pub fn kind(&self) -> MediaKind

Media kind.

pub fn rtp_parameters(&self) -> &RtpParameters

RTP parameters.

pub fn type(&self) -> ConsumerType

Consumer type.

pub fn paused(&self) -> bool

Whether the Consumer is paused.

pub fn producer_paused(&self) -> bool

Whether the associate Producer is paused.

pub fn priority(&self) -> u8

Current priority.

pub fn score(&self) -> ConsumerScore

Consumer score.

pub fn preferred_layers(&self) -> Option<ConsumerLayers>

Preferred video layers.

pub fn current_layers(&self) -> Option<ConsumerLayers>

Current video layers.

pub fn app_data(&self) -> &AppData

App custom data.

pub async fn get_stats<'_>(&'_ self) -> Result<ConsumerStats, RequestError>

Get Consumer stats.

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

Pause the Consumer.

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

Resume the Consumer.

pub async fn set_preferred_layers<'_>(
    &'_ self,
    consumer_layers: ConsumerLayers
) -> Result<(), RequestError>

Set preferred video layers.

pub async fn set_priority<'_>(
    &'_ self,
    priority: u8
) -> Result<(), RequestError>

Set priority.

pub async fn unset_priority<'_>(&'_ self) -> Result<(), RequestError>

Unset priority.

pub async fn request_key_frame<'_>(&'_ self) -> Result<(), RequestError>

Request a key frame to the Producer.

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

Enable 'trace' event.

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for Consumer

pub fn clone(&self) -> Consumer

Returns a copy of the value.

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

Performs copy-assignment from source.