Struct mediasoup::audio_level_observer::AudioLevelObserver

pub struct AudioLevelObserver { /* fields omitted */ }

An audio level observer monitors the volume of the selected audio producers.

It just handles audio producers (if AudioLevelObserver::add_producer() is called with a video producer it will fail).

Audio levels are read from an RTP header extension. No decoding of audio data is done. See RFC6464 for more information.

Implementations

impl AudioLevelObserver

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

Callback is called at most every interval (see AudioLevelObserverOptions).

Audio volumes entries ordered by volume (louder ones go first).

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

Callback is called when no one of the producers in this RTP observer is generating audio with a volume beyond the given threshold.

pub fn downgrade(&self) -> WeakAudioLevelObserver

Downgrade AudioLevelObserver to WeakAudioLevelObserver instance.

Trait Implementations

impl Clone for AudioLevelObserver

fn clone(&self) -> AudioLevelObserver

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioLevelObserver

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

Formats the value using the given formatter.

impl RtpObserver for AudioLevelObserver

fn id(&self) -> RtpObserverId

RtpObserver id.

fn paused(&self) -> bool

Whether the RtpObserver is paused.

fn app_data(&self) -> &AppData

Custom application data.

fn closed(&self) -> bool

Whether the RTP observer is closed.

fn pause<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<(), RequestError>> + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Pauses the RTP observer. No RTP is inspected until resume() is called.

fn resume<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<(), RequestError>> + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Resumes the RTP observer. RTP is inspected again.

fn add_producer<'life0, 'async_trait>(
    &'life0 self,
    __arg1: RtpObserverAddProducerOptions
) -> Pin<Box<dyn Future<Output = Result<(), RequestError>> + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Provides the RTP observer with a new producer to monitor.

fn remove_producer<'life0, 'async_trait>(
    &'life0 self,
    producer_id: ProducerId
) -> Pin<Box<dyn Future<Output = Result<(), RequestError>> + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Removes the given producer from the RTP observer.

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

Callback is called when the RTP observer is paused.

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

Callback is called when the RTP observer is resumed.

fn on_add_producer(
    &self,
    callback: Box<dyn Fn(&Producer) + Send + Sync + 'static>
) -> HandlerId

Callback is called when a new producer is added into the RTP observer.

fn on_remove_producer(
    &self,
    callback: Box<dyn Fn(&Producer) + Send + Sync + 'static>
) -> HandlerId

Callback is called when a producer is removed from the RTP observer.

fn on_router_close(
    &self,
    callback: Box<dyn FnOnce() + Send + 'static>
) -> HandlerId

Callback is called when the router this RTP observer belongs to is closed for whatever reason. The RTP observer itself is also closed.

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

Callback is called when the RTP observer is closed for whatever reason.