Struct CpalOutput 

pub struct CpalOutput { /* private fields */ }

Available on crate feature cpal-output only.

Audio output device impl using cpal.

Implementations

impl CpalOutput

pub fn open() -> Result<Self, Error>

Open an audio output device using the default configuration.

pub fn open_with_config(config: CpalOutputConfig) -> Result<Self, Error>

Open an audio output device using the given configuration.

Use CpalOutput::available_drivers, CpalOutput::available_devices and CpalOutput::supported_sample_rates to enumerate available options dynamically.

pub fn available_drivers() -> Vec<CpalOutputDeviceDriver>

Returns all audio drivers available on this platform.

Always includes CpalOutputDeviceDriver::Default, followed by any named drivers that are currently available (e.g. ASIO, WASAPI on Windows; ALSA, JACK on Linux).

pub fn available_devices( driver: CpalOutputDeviceDriver, ) -> Result<Vec<(DeviceId, String)>, Error>

Returns (id, name)s of all output devices available for the given driver.

pub fn supported_sample_rates( driver: CpalOutputDeviceDriver, device_id: Option<CpalDeviceId>, ) -> Result<Vec<u32>, Error>

Returns unique sample rates supported by an output device, sorted ascending.

Pass device_name = None to query the driver’s default device.

Trait Implementations

impl OutputDevice for CpalOutput

fn channel_count(&self) -> usize

Returns the output buffer channel count (e.g., 1 for mono, 2 for stereo).

fn sample_rate(&self) -> u32

Returns the output sample rate in Hz.

fn sample_position(&self) -> u64

Returns the current playhead position in samples (not frames). Tracks the total number of samples output since device creation.

fn volume(&self) -> f32

Returns the current output volume (typically 0.0 to 1.0).

fn set_volume(&mut self, volume: f32)

Sets the output volume.

fn is_suspended(&self) -> bool

Returns true if audio output is suspended by the system. Only relevant for web audio backends; always returns false for desktop backends.

fn is_running(&self) -> bool

Returns true if audio is currently playing (not paused).

fn pause(&mut self)

Pauses playback while keeping the output source active.

fn resume(&mut self)

Resumes playback from a paused state.

fn play(&mut self, source: Box<dyn Source>)

Starts playback of a new audio source.

fn stop(&mut self)

Stops playback and replaces the source with silence.

fn close(&mut self)

Releases the audio device and cleans up resources.