Struct Player 

pub struct Player<'d> { /* private fields */ }

Audio output.

Implementations

impl Player<'_>

pub async fn write(&mut self, samples: &[i16]) -> Result<(), Error>

Queues interleaved stereo samples, waiting for space as needed, and returns once all are queued. Unmutes on first use.

Keep the queue fed: if it runs dry the stream stops, returns Error::Underrun once, and is restarted.

Not cancel-safe: a cancelled call may have queued any prefix of samples, and there is no way to learn how much. Use write_some in a select.

pub async fn write_some(&mut self, samples: &[i16]) -> Result<usize, Error>

Waits for space, queues as many whole frames from samples as fit, and returns how many i16 samples were taken (always even, at least two unless samples has fewer). Unmutes on first use.

Cancel-safe: it only waits before queueing, so a cancelled call has queued nothing.

pub async fn set_volume(&mut self, volume: Volume) -> Result<(), Error>

Digital output volume.

pub async fn set_mute(&mut self, mute: bool) -> Result<(), Error>

Soft mute.

pub fn rate(&self) -> SampleRate

The sample rate.

pub fn codec(&mut self) -> &mut Codec

The codec, for advanced control.

pub async fn shutdown(self) -> Result<(), Error>

Mutes, powers the codec down, then stops the stream. Prefer this over a plain drop, which can click.