Struct beryllium::AudioQueue

pub struct AudioQueue<'sdl> { /* fields omitted */ }

Handle to an audio device in "queue" mode, and info about its settings.

Methods

impl<'sdl> AudioQueue<'sdl>

pub fn frequency(&self) -> i32

Samples per second

pub fn format(&self) -> AudioFormat

Sample data format

pub fn channels(&self) -> u8

Channel count

pub fn silence(&self) -> u8

Silence value

pub fn sample_count(&self) -> usize

Samples in the buffer

pub fn buffer_size(&self) -> usize

Size (in bytes) of the buffer

pub fn set_paused(&self, pause_on: bool)

Sets the device into paused state or not.

pub fn queued_audio_size(&self) -> usize

Gets the current number of bytes of queued audio.

NOTE: this seems to be a somewhat unreliable metric. When the queue runs low SDL2 seems to automatically re-queue some silence for you, but that silence time counts into the queue size. In other words, if you just leave the queue playing without pushing any new audio the queued byte size never hits 0. The queue size will go to 0 as expected if you clear it while playback it paused.

pub fn clear(&self)

Clears any queued data that has not yet been sent to the sound card.

pub fn queue_audio(&self, data: &[u8]) -> Result<(), String>

Pushes audio data into the queue.

The size of the queue has no particular limit, but you can't queue more than u32::MAX bytes at once.

Trait Implementations

impl<'sdl> Drop for AudioQueue<'sdl>

fn drop(&mut self)

Executes the destructor for this type.

impl<'sdl> Debug for AudioQueue<'sdl>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.