Struct AudioStream

pub struct AudioStream { /* private fields */ }

Available on crate feature dep_sdl3 only.

Implementations

impl AudioStream

pub fn stream(&mut self) -> *mut SDL_AudioStream

Get the SDL_AudioStream pointer.

pub fn device_id(&self) -> Option<AudioDeviceID>

Get the device ID bound to the stream. If the stream is not bound to a device, this will return None.

pub fn device_name(&self) -> Option<String>

pub fn new( src_spec: Option<&AudioSpec>, dst_spec: Option<&AudioSpec>, audio_subsystem: &AudioSubsystem, ) -> Result<AudioStream, Error>

👎Deprecated: use subsystem.new_stream(...) (where subsystem is an AudioSubsystem) instead

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( app_spec: &AudioSpec, device_spec: Option<&AudioSpec>, audio_subsystem: &AudioSubsystem, ) -> Result<AudioStream, Error>

👎Deprecated: use subsystem.new_playback_stream(...) (where subsystem is an AudioSubsystem) instead

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( device_spec: Option<&AudioSpec>, app_spec: &AudioSpec, audio_subsystem: &AudioSubsystem, ) -> Result<AudioStream, Error>

👎Deprecated: use subsystem.new_recording_stream(...) (where subsystem is an AudioSubsystem) instead

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.

pub fn open_device_stream( device_id: AudioDeviceID, spec: Option<&AudioSpec>, audio_subsystem: &AudioSubsystem, ) -> Result<AudioStream, Error>

👎Deprecated: use device.open_device_stream(spec) (where device is an AudioDevice) instead

Create an AudioStream for this device with the specified spec. This device will be closed when the stream is dropped. The device begins paused, so you must call stream.resume() to start playback.

pub fn get_format( &self, ) -> Result<(Option<AudioSpec>, Option<AudioSpec>), Error>

Retrieves the source and destination formats of the audio stream.

Returns a tuple (src_spec, dst_spec) where each is an Option<AudioSpec>.

pub fn get_gain(&self) -> Result<f32, Error>

Retrieves the gain of the audio stream.

Returns the gain as a f32 on success, or an error message on failure.

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

Pauses playback of the audio stream.

pub fn resume(&self) -> Result<(), Error>

Resumes playback of the audio stream.

pub fn available_bytes(&self) -> Result<i32, Error>

Gets the number of converted/resampled bytes available.

pub fn read_f32_samples(&mut self, buf: &mut [f32]) -> Result<usize, Error>

Reads samples as f32 into the provided buffer. Returns the number of samples read.

pub fn read_i16_samples(&mut self, buf: &mut [i16]) -> Result<usize, Error>

Reads samples as i16 into the provided buffer. Returns the number of samples read.

pub fn put_data(&self, buf: &[u8]) -> Result<(), Error>

Adds data to the stream.

Trait Implementations

impl Debug for AudioStream

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

Formats the value using the given formatter.

impl Display for AudioStream

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

Formats the value using the given formatter.

impl Drop for AudioStream

fn drop(&mut self)

Destroys the audio stream, unbinding it automatically from the device. If this stream was created with SDL_OpenAudioDeviceStream, the audio device that was opened alongside this stream’s creation will be closed, too.

impl Read for AudioStream

fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Reads audio data from the stream. Note that this reads bytes from the stream, not samples. You must convert the bytes to samples based on the format of the stream. read_f32_samples and read_i16_samples are provided for convenience.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.