Struct spectrusty_audio::host::sdl2::AudioHandle

pub struct AudioHandle<T: AudioFormatNum + AudioSample> {
    pub sample_rate: u32,
    pub channels: u8,
    pub samples: u16,
    pub producer: AudioFrameProducer<T>,
    /* private fields */
}

The struct for producing and controlling the audio playback.

It embeds the interconnected pair of carousel’s AudioFrameProducer with the AudioFrameConsumer directly exposing the producer to the user. The consumer lives in the SDL2 audio thread and is responsible for filling up the audio output buffer with sample data sent from the producer.

The T parameter should be one of the sample primitives.

Fields

sample_rate: u32

The audio sample frequency of the output stream.

channels: u8

The number of audio channels in the output stream.

samples: u16

The number of samples in the output audio buffer.

producer: AudioFrameProducer<T>

The audio sample producer, interconnected with an audio consumer living in the audio thread.

Implementations

impl<T: AudioFormatNum + AudioSample> AudioHandle<T>

pub fn status(&self) -> AudioStatus

Returns the status of the audio device playback.

pub fn play(&self)

Starts playback of the audio device.

pub fn pause(&self)

Pauses playback of the audio device.

pub fn close(self) -> AudioFrameConsumer<T>

Closes audio playback and frees underlying resources. Returns the unwrapped frame consumer.

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

Creates an instance of the AudioHandle from the provided SDL2 context.

The audio parameters used by default are the sample rate of 44100, 2 channels, and the output buffer size adjusted to the requested latency.

• frame_duration_nanos is the duration in nanoseconds of the standard emulation frame.
• latency is the requested audio latency; the actual latency argument passed to the create_carousel may be larger but never smaller than the provided one.

pub fn create_with_specs(
    sdl_context: &Sdl,
    desired_spec: AudioSpecDesired,
    frame_duration_nanos: u32,
    latency: usize
) -> Result<Self, AudioHandleError>

Creates an instance of the AudioHandle from the provided SDL2 context with the desired audio parameters.

The audio parameters used by default are the sample rate of 44100, 2 channels, and the output buffer size adjusted to the requested latency.

• frame_duration_nanos is the duration in nanoseconds of the standard emulation frame.
• latency is the requested audio latency; the actual latency argument passed to the create_carousel may be larger but never smaller than the provided one.
• desired_spec can be populated with the desired audio parameters.

Examples found in repository

src/host/sdl2.rs (lines 107-112)

    pub fn create(
                sdl_context: &Sdl,
                frame_duration_nanos: u32,
                latency: usize
            ) -> Result<Self, AudioHandleError>
    {
        Self::create_with_specs(
                sdl_context,
                AudioSpecDesired { freq: None, channels: None, samples: None },
                frame_duration_nanos,
                latency
        )
    }