Struct Music

pub struct Music { /* private fields */ }

Music, audio stream, anything longer than ~10 seconds should be streamed

Implementations

impl Music

pub fn frame_count(&self) -> u32

Total number of frames (considering channels)

pub fn looping(&self) -> bool

Is music looping enabled

pub fn set_looping(&mut self, looping: bool)

Enable/disable looping

pub fn from_file(file_name: &str) -> Option<Self>

Load music stream from file

pub fn from_memory(data: &[u8], format: AudioFormat) -> Option<Self>

Load music stream from data

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

Start music playing

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

Check if music is playing

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

Updates buffers for music streaming

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

Stop music playing

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

Pause music playing

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

Resume playing paused music

pub fn seek(&self, position: Duration, _device: &mut AudioDevice)

Seek music to a position

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

Set volume for music (1.0 is max level)

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

Set pitch for a music (1.0 is base level)

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

Set pan for a music (0.5 is center)

pub fn get_time_length(&self, _device: &mut AudioDevice) -> Duration

Get music time length

pub fn get_time_played(&self, _device: &mut AudioDevice) -> Duration

Get current music time played

pub fn as_raw(&self) -> &Music

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

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

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

pub unsafe fn from_raw(raw: Music) -> 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 Music

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

Formats the value using the given formatter.

impl Drop for Music

fn drop(&mut self)

Executes the destructor for this type.