Struct AudioSubsystem

pub struct AudioSubsystem { /* private fields */ }

Available on crate feature dep_sdl3 only.

Implementations

impl AudioSubsystem

pub fn audio_playback_device_ids(&self) -> Result<Vec<AudioDeviceID>, Error>

Enumerate audio playback devices.

pub fn audio_recording_device_ids(&self) -> Result<Vec<AudioDeviceID>, Error>

Enumerate audio recording devices.

pub fn open_playback_device( &self, spec: &AudioSpec, ) -> Result<AudioDevice, Error>

Open a default playback device with the specified audio spec.

pub fn open_recording_device( &self, spec: &AudioSpec, ) -> Result<AudioDevice, Error>

Open a default recording device with the specified audio spec.

pub fn default_playback_device(&self) -> AudioDevice

pub fn default_recording_device(&self) -> AudioDevice

pub fn open_playback_stream_with_callback<CB, Channel>( &self, device: &AudioDevice, spec: &AudioSpec, callback: CB, ) -> Result<AudioStreamWithCallback<CB>, Error>

where CB: AudioCallback<Channel>, Channel: AudioFormatNum + 'static,

pub fn open_playback_stream<CB, Channel>( &self, spec: &AudioSpec, callback: CB, ) -> Result<AudioStreamWithCallback<CB>, Error>

where CB: AudioCallback<Channel>, Channel: AudioFormatNum + 'static,

pub fn open_recording_stream<CB, Channel>( &self, spec: &AudioSpec, callback: CB, ) -> Result<AudioStreamWithCallback<CB>, Error>

where CB: AudioCallback<Channel>, Channel: AudioFormatNum + 'static,

pub fn current_audio_driver(&self) -> &'static str

pub fn audio_playback_device_name(&self, index: u32) -> Result<String, Error>

pub fn audio_recording_device_name(&self, index: u32) -> Result<String, Error>

pub fn new_stream( &self, src_spec: Option<&AudioSpec>, dst_spec: Option<&AudioSpec>, ) -> Result<AudioStream, Error>

Creates a new audio stream that converts audio data from the source format (src_spec) to the destination format (dst_spec).

Arguments

• src_spec - The format details of the input audio.
• dst_spec - The format details of the output audio.

Returns

Returns Ok(AudioStream) on success or an error message on failure.

Safety

This function is safe to call from any thread.

pub fn new_playback_stream( &self, app_spec: &AudioSpec, device_spec: Option<&AudioSpec>, ) -> Result<AudioStream, Error>

Creates a new audio stream for playback.

Arguments

• app_spec - The format of audio data the application will provide.
• device_spec - The format of audio data the audio device expects. If None, SDL will choose an appropriate format.

pub fn new_recording_stream( &self, device_spec: Option<&AudioSpec>, app_spec: &AudioSpec, ) -> Result<AudioStream, Error>

Creates a new audio stream for recording.

Arguments

• device_spec - The format of audio data the audio device provides. If None, SDL will choose an appropriate format.
• app_spec - The format of audio data the application wants to receive.

Trait Implementations

impl Clone for AudioSubsystem

fn clone(&self) -> AudioSubsystem

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AudioSubsystem

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Drop for AudioSubsystem

fn drop(&mut self)

Executes the destructor for this type.