Enum spectrusty_audio::host::cpal::AudioHandleAnyFormat

pub enum AudioHandleAnyFormat {
    I16(AudioHandle<i16>),
    U16(AudioHandle<u16>),
    F32(AudioHandle<f32>),
}

The enum for producing and controlling the audio playback regardless of the sample format used.

Variants

I16(AudioHandle<i16>)

U16(AudioHandle<u16>)

F32(AudioHandle<f32>)

Implementations

impl AudioHandleAnyFormat

pub fn sample_format(&self) -> SampleFormat

Returns the sample format of the current variant.

pub fn sample_rate(&self) -> u32

Returns the audio sample frequency of the output stream.

pub fn channels(&self) -> u8

Returns the number of audio channels in the output stream.

pub fn play(&self) -> Result<(), AudioHandleError>

Starts playback of the audio device.

pub fn pause(&self) -> Result<(), AudioHandleError>

Pauses playback of the audio device.

pub fn close(self)

Closes audio playback and frees underlying resources.

pub fn send_frame(&mut self) -> AudioFrameResult<()>

Calls the underlying AudioFrameProducer::send_frame.

pub fn create(
    host: &Host,
    frame_duration_nanos: u32,
    latency: usize
) -> Result<Self, AudioHandleError>

Creates an instance of the AudioHandleAnyFormat from the provided cpal host with the default output device and the default audio parameters.

• frame_duration_nanos is the duration in nanoseconds of the standard emulation frame.
• latency is the audio latency passed to the create_carousel.

pub fn create_with_device(
    device: &Device,
    frame_duration_nanos: u32,
    latency: usize
) -> Result<Self, AudioHandleError>

Creates an instance of the AudioHandleAnyFormat from the provided cpal device with the default audio parameters.

• frame_duration_nanos is the duration in nanoseconds of the standard emulation frame.
• latency is the audio latency passed to the create_carousel.

Examples found in repository

src/host/cpal.rs (line 127)

    pub fn create(
            host: &cpal::Host,
            frame_duration_nanos: u32,
            latency: usize
        ) -> Result<Self, AudioHandleError>
    {
        let device = host.default_output_device()
                     .ok_or_else(|| ("no default output device".to_string(),
                                    AudioHandleErrorKind::AudioSubsystem))?;
        Self::create_with_device(&device, frame_duration_nanos, latency)
    }

pub fn create_with_device_and_config(
    device: &Device,
    config: &StreamConfig,
    frame_duration_nanos: u32,
    latency: usize
) -> Result<Self, AudioHandleError>

Creates an instance of the AudioHandleAnyFormat from the provided cpal device with the desired audio parameters and sample format.

• config specifies the desired audio parameters.
• frame_duration_nanos is the duration in nanoseconds of the standard emulation frame.
• latency is the audio latency passed to the create_carousel.

Examples found in repository

src/host/cpal.rs (lines 141-146)

    pub fn create_with_device(
            device: &cpal::Device,
            frame_duration_nanos: u32,
            latency: usize
        ) -> Result<Self, AudioHandleError>
    {
        let config = device.default_output_config()?.config();
        Self::create_with_device_and_config(
            device,
            &config,
            frame_duration_nanos,
            latency,
        )
    }