Struct Music

pub struct Music<'a> {
    pub raw: *mut _Mix_Music,
    pub owned: bool,
    /* private fields */
}

Available on crate feature dep_sdl2 only.

This is an opaque data type used for Music data.

Fields

raw: *mut _Mix_Music

owned: bool

Implementations

impl<'a> Music<'a>

pub fn from_file<P>(path: P) -> Result<Music<'static>, String>

where P: AsRef<Path>,

Load music file to use.

pub fn from_static_bytes(buf: &'static [u8]) -> Result<Music<'static>, String>

Load music from a static byte buffer.

pub fn get_type(&self) -> MusicType

The file format encoding of the music.

pub fn play(&self, loops: i32) -> Result<(), String>

Play the loaded music loop times through from start to finish. Pass -1 to loop forever.

pub fn fade_in(&self, loops: i32, ms: i32) -> Result<(), String>

Fade in over ms milliseconds of time, the loaded music, playing it loop times through from start to finish.

pub fn fade_in_from_pos( &self, loops: i32, ms: i32, position: f64, ) -> Result<(), String>

Fade in over ms milliseconds of time, from position.

pub fn get_volume() -> i32

Returns current volume

pub fn set_volume(volume: i32)

Set the volume on a scale of 0 to 128. Values greater than 128 will use 128.

pub fn pause()

Pause the music playback.

pub fn resume()

Unpause the music.

pub fn rewind()

Rewind the music to the start.

pub fn set_pos(position: f64) -> Result<(), String>

Set the position of the currently playing music.

pub fn set_command(command: &str) -> Result<(), String>

Setup a command line music player to use to play music.

pub fn halt()

Halt playback of music.

pub fn fade_out(ms: i32) -> Result<(), String>

Gradually fade out the music over ms milliseconds starting from now.

pub fn hook_finished(f: fn())

Sets up a function to be called when music playback is halted.

Examples

fn after_music() {
    println!("Music has ended");
}

sdl2::mixer::Music::hook_finished(after_music);

pub fn unhook_finished()

A previously set up function would no longer be called when music playback is halted.

pub fn is_playing() -> bool

If music is actively playing, or not.

pub fn is_paused() -> bool

If music is paused, or not.

pub fn get_fading() -> Fading

If music is fading, or not.

Trait Implementations

impl<'a> Debug for Music<'a>

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

Shows the original regular expression.

impl<'a> Drop for Music<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> PartialEq for Music<'a>

fn eq(&self, other: &Music<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> StructuralPartialEq for Music<'a>