Struct RaylibAudio

pub struct RaylibAudio(/* private fields */);

This token is used to indicate audio is initialized. It’s also used to create Wave, Sound, Music, AudioStream, and SoundAlias. All of those have a lifetime that is bound to RaylibAudio. The compiler will disallow you from using them without ensuring that the RaylibAudio is present while doing so.

Implementations

impl RaylibAudio

pub fn init_audio_device() -> Result<RaylibAudio, RaylibAudioInitError>

Initializes audio device and context.

pub fn is_audio_device_ready(&self) -> bool

Checks if audio device is ready.

pub fn get_master_volume(&self) -> f32

Get master volume (listener)

pub fn set_master_volume(&self, volume: f32)

Sets master volume (listener).

pub fn set_audio_stream_buffer_size_default(&self, size: i32)

Sets default audio buffer size for new audio streams.

pub fn new_sound<'aud>(&'aud self, filename: &str) -> Result<Sound<'aud>, Error>

Loads a new sound from file.

pub fn new_sound_from_wave<'aud>( &'aud self, wave: &Wave<'_>, ) -> Result<Sound<'aud>, Error>

Loads sound from wave data.

pub fn new_wave<'aud>(&'aud self, filename: &str) -> Result<Wave<'aud>, Error>

Loads wave data from file into RAM.

pub fn new_wave_from_memory<'aud>( &'aud self, filetype: &str, bytes: &[u8], ) -> Result<Wave<'aud>, Error>

Load wave from memory buffer, fileType refers to extension: i.e. ‘.wav’

pub fn new_music<'aud>(&'aud self, filename: &str) -> Result<Music<'aud>, Error>

Loads music stream from file.

pub fn new_music_from_memory<'aud>( &'aud self, filetype: &str, bytes: &Vec<u8>, ) -> Result<Music<'aud>, Error>

Load music stream from data

pub fn new_audio_stream<'aud>( &'aud self, sample_rate: u32, sample_size: u32, channels: u32, ) -> AudioStream<'aud>

Initializes audio stream (to stream raw PCM data).

Trait Implementations

impl Clone for RaylibAudio

fn clone(&self) -> RaylibAudio

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RaylibAudio

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

Formats the value using the given formatter.

impl<'aud> Drop for RaylibAudio

fn drop(&mut self)

Executes the destructor for this type.