Struct ActiveSpeakerObserver

pub struct ActiveSpeakerObserver { /* private fields */ }

An active speaker observer monitors the volume of the selected audio producers.

It just handles audio producers (if ActiveSpeakerObserver::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 ActiveSpeakerObserver

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

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

pub fn downgrade(&self) -> WeakActiveSpeakerObserver

Downgrade ActiveSpeakerObserver to WeakActiveSpeakerObserver instance.

Trait Implementations

impl Clone for ActiveSpeakerObserver

fn clone(&self) -> ActiveSpeakerObserver

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ActiveSpeakerObserver

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

Formats the value using the given formatter.

impl RtpObserver for ActiveSpeakerObserver

fn id(&self) -> RtpObserverId

RtpObserver id.

fn router(&self) -> &Router

Router to which RTP observer belongs.

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>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: '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>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: '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>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: '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>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: '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.