Struct sdl2::audio::AudioDevice

pub struct AudioDevice<CB: AudioCallback> { /* fields omitted */ }

Wraps SDL_AudioDeviceID and owns the callback data used by the audio device.

Methods

impl<CB: AudioCallback> AudioDevice<CB>

fn open_playback<'a, F, D>(
    a: &AudioSubsystem,
    device: D,
    spec: &AudioSpecDesired,
    get_callback: F
) -> Result<AudioDevice<CB>, String> where
    F: FnOnce(AudioSpec) -> CB,
    D: Into<Option<&'a str>>, 

Opens a new audio device for playback (given the desired parameters and callback).

fn open_capture<'a, F, D>(
    a: &AudioSubsystem,
    device: D,
    spec: &AudioSpecDesired,
    get_callback: F
) -> Result<AudioDevice<CB>, String> where
    F: FnOnce(AudioSpec) -> CB,
    D: Into<Option<&'a str>>, 

Opens a new audio device for capture (given the desired parameters and callback). Supported since SDL 2.0.5

fn subsystem(&self) -> &AudioSubsystem

fn spec(&self) -> &AudioSpec

fn status(&self) -> AudioStatus

fn pause(&self)

Pauses playback of the audio device.

fn resume(&self)

Starts playback of the audio device.

fn lock(&mut self) -> AudioDeviceLockGuard<CB>

Locks the audio device using SDL_LockAudioDevice.

When the returned lock guard is dropped, SDL_UnlockAudioDevice is called. Use this method to read and mutate callback data.

fn close_and_get_callback(self) -> CB

Closes the audio device and saves the callback data from being dropped.

Note that simply dropping AudioDevice will close the audio device, but the callback data will be dropped.