Struct AudioStream

pub struct AudioStream { /* private fields */ }

AudioStream, custom audio stream

Implementations

impl AudioStream

pub fn sample_rate(&self) -> u32

Frequency (samples per second)

pub fn sample_size(&self) -> u32

Bit depth (bits per sample): 8, 16, 32 (24 not supported)

pub fn channels(&self) -> u32

Number of channels (1-mono, 2-stereo, …)

pub fn new(sample_rate: u32, sample_size: u32, channels: u32) -> Option<Self>

Load audio stream (to stream raw audio pcm data)

pub fn update(&mut self, data: &[u8], frame_count: u32)

Update audio stream buffers with data

pub fn is_processed(&self) -> bool

Check if any audio stream buffers requires refill

pub fn play(&self, _device: &mut AudioDevice)

Play audio stream

pub fn pause(&self, _device: &mut AudioDevice)

Pause audio stream

pub fn resume(&self, _device: &mut AudioDevice)

Resume audio stream

pub fn is_playing(&self, _device: &mut AudioDevice) -> bool

Check if audio stream is playing

pub fn stop(&self, _device: &mut AudioDevice)

Stop audio stream

pub fn set_volume(&self, volume: f32, _device: &mut AudioDevice)

Set volume for audio stream (1.0 is max level)

pub fn set_pitch(&self, pitch: f32, _device: &mut AudioDevice)

Set pitch for audio stream (1.0 is base level)

pub fn set_pan(&self, pan: f32, _device: &mut AudioDevice)

Set pan for audio stream (0.5 is centered)

pub fn set_default_buffer_size(size: usize)

Default size for new audio streams

pub fn as_raw(&self) -> &AudioStream

Get the ‘raw’ ffi type Take caution when cloning so it doesn’t outlive the original

pub fn as_raw_mut(&mut self) -> &mut AudioStream

Get the ‘raw’ ffi type Take caution when cloning so it doesn’t outlive the original

pub unsafe fn from_raw(raw: AudioStream) -> Self

Convert a ‘raw’ ffi object to a safe wrapper

Safety

• The raw object must be correctly initialized
• The raw object should be unique. Otherwise, make sure its clones don’t outlive the newly created object.

Trait Implementations

impl Debug for AudioStream

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

Formats the value using the given formatter.

impl Drop for AudioStream

fn drop(&mut self)

Executes the destructor for this type.