Struct AudioStream 

pub struct AudioStream<'a>(/* private fields */);

Low-level raw PCM streaming primitive.

AudioStream lets you push arbitrary audio data to the audio device one buffer at a time, giving full control over sample rate, bit depth, and channel count. This is the replacement for the audio-callback API that was removed in raylib 6.0 — instead of registering a callback you periodically check IsAudioStreamProcessed and push the next buffer of samples.

Create via RaylibAudio::new_audio_stream. Freed via UnloadAudioStream on drop. Lifetime is bound to the owning RaylibAudio.

Examples

Create a stereo 44.1 kHz stream and push silence each frame:

use raylib::prelude::*;
let audio = RaylibAudio::init_audio_device().unwrap();
let stream = audio.new_audio_stream(44100, 16, 2);
// Push PCM data when the device is ready for more samples.
let silence: Vec<i16> = vec![0; 4096];
unsafe { raylib::ffi::UpdateAudioStream(*stream, silence.as_ptr() as *const _, silence.len() as i32) };

Implementations

impl<'a> AudioStream<'a>

pub unsafe fn unwrap(self) -> AudioStream

Take the raw ffi type. Must manually free memory by calling the proper unload function

Safety

The caller is responsible for freeing the returned value by calling the appropriate raylib unload function. Failure to do so will leak resources.

impl AudioStream<'_>

pub fn is_audio_stream_valid(&self) -> bool

Checks if an audio stream is valid (buffers initialized)

pub const fn sample_rate(&self) -> u32

Frequency (samples per second)

pub const fn sample_size(&self) -> u32

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

pub const fn channels(&self) -> u32

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

pub unsafe fn inner(self) -> AudioStream

Safety

Caller takes ownership of the raw audio stream and must free it via UnloadAudioStream.

pub fn update<T: AudioSample>( &mut self, data: &[T], ) -> Result<(), UpdateAudioStreamError>

Updates audio stream buffers with data.

pub fn play(&self)

Plays audio stream.

pub fn pause(&self)

Pauses audio stream.

pub fn resume(&self)

Resumes audio stream.

pub fn is_playing(&self) -> bool

Checks if audio stream is currently playing.

pub fn stop(&self)

Stops audio stream.

pub fn set_volume(&self, volume: f32)

Sets volume for audio stream (1.0 is max level).

pub fn set_pitch(&self, pitch: f32)

Sets pitch for audio stream (1.0 is base level).

pub fn is_processed(&self) -> bool

Sets pitch for audio stream (1.0 is base level).

pub fn set_pan(&self, pan: f32)

Set pan for audio stream (0.5 is centered)

Trait Implementations

impl<'a> AsRawMut<AudioStream> for AudioStream<'a>

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

Mutable access to the wrapped raw FFI value.

impl<'a> AsRef<AudioStream> for AudioStream<'a>

fn as_ref(&self) -> &AudioStream

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Debug for AudioStream<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for AudioStream<'a>

type Target = AudioStream

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> Drop for AudioStream<'a>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.