pub struct AudioStream { /* private fields */ }
Expand description

AudioStream, custom audio stream

Implementations§

source§

impl AudioStream

source

pub fn sample_rate(&self) -> u32

Frequency (samples per second)

source

pub fn sample_size(&self) -> u32

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

source

pub fn channels(&self) -> u32

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

source

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

Load audio stream (to stream raw audio pcm data)

source

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

Update audio stream buffers with data

source

pub fn is_processed(&self) -> bool

Check if any audio stream buffers requires refill

source

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

Play audio stream

source

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

Pause audio stream

source

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

Resume audio stream

source

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

Check if audio stream is playing

source

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

Stop audio stream

source

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

Set volume for audio stream (1.0 is max level)

source

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

Set pitch for audio stream (1.0 is base level)

source

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

Set pan for audio stream (0.5 is centered)

source

pub fn set_default_buffer_size(size: usize)

Default size for new audio streams

source

pub fn as_raw(&self) -> &AudioStream

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

source

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

source

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§

source§

impl Debug for AudioStream

source§

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

Formats the value using the given formatter. Read more
source§

impl Drop for AudioStream

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.