Struct Conference 

pub struct Conference { /* private fields */ }

Several calls mixed together.

Participants join and leave while it runs. Neither disturbs the others: the mixing clock does not stop, and a participant who leaves simply stops contributing and stops being sent to.

Implementations

impl Conference

pub fn new( samples_per_frame: usize, interval: Duration, ) -> Result<Self, ConferenceError>

Start an empty conference, mixing at this frame size and interval.

The interval must match what the participants’ sessions send at, or the conference produces frames faster or slower than they can be played and the queues drift. It must also be at least one millisecond.

Errors

Returns ConferenceError::IntervalTooShort before spawning the mixer when interval is shorter than one millisecond.

pub fn narrowband() -> Result<Self, ConferenceError>

A conference at the usual telephony rate: 20 ms frames of 8 kHz audio.

Errors

The fixed interval currently satisfies ConferenceError’s minimum. The fallible return keeps this convenience constructor on the same explicit startup contract as Self::new.

pub async fn join(&self, session: Arc<MediaSession>) -> u64

Add a participant, and return the handle used to remove them.

pub async fn leave(&self, id: u64)

Remove a participant.

The others carry on. Their mixes simply stop containing this one, which is what leaving a conversation sounds like.

pub async fn len(&self) -> usize

How many are in it.

pub async fn is_empty(&self) -> bool

Whether nobody is in it.

pub fn samples_per_frame(&self) -> usize

The frame size being mixed at.

pub async fn close(&self)

Stop mixing. The participants’ sessions are left running.

Trait Implementations

impl Debug for Conference

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

Formats the value using the given formatter.

impl Drop for Conference

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.