Struct sdl2::mixer::Music

source · [−]

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

Expand description

This is an opaque data type used for Music data.

Fields

raw: *mut Mix_Musicowned: bool

Implementations

source

impl<'a> Music<'a>

source

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

Load music file to use.

source

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

Load music from a static byte buffer.

source

pub fn get_type(&self) -> MusicType

The file format encoding of the music.

source

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

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

source

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.

source

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

Fade in over ms milliseconds of time, from position.

source

pub fn get_volume() -> i32

Returns current volume

source

pub fn set_volume(volume: i32)

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

source

pub fn pause()

Pause the music playback.

source

pub fn resume()

Unpause the music.

source

pub fn rewind()

Rewind the music to the start.

source

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

Set the position of the currently playing music.

source

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

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

source

pub fn halt()

Halt playback of music.

source

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

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

source

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);

source

pub fn unhook_finished()

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

source

pub fn is_playing() -> bool

If music is actively playing, or not.

source

pub fn is_paused() -> bool

If music is paused, or not.

source

pub fn get_fading() -> Fading

If music is fading, or not.

Trait Implementations

source

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

source

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

Shows the original regular expression.

source

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

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

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

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

source

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

This method tests for !=.

source

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

Auto Trait Implementations

impl<'a> RefUnwindSafe for Music<'a>

impl<'a> !Send for Music<'a>

impl<'a> !Sync for Music<'a>

impl<'a> Unpin for Music<'a>

impl<'a> UnwindSafe for Music<'a>

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct sdl2::mixer::Music

Fields

Implementations

impl<'a> Music<'a>

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

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

pub fn get_type(&self) -> MusicType

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

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

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

pub fn get_volume() -> i32

pub fn set_volume(volume: i32)

pub fn pause()

pub fn resume()

pub fn rewind()

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

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

pub fn halt()

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

pub fn hook_finished(f: fn())

pub fn unhook_finished()

pub fn is_playing() -> bool

pub fn is_paused() -> bool

pub fn get_fading() -> Fading

Trait Implementations

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

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

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

fn drop(&mut self)

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

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

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

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

Auto Trait Implementations

impl<'a> RefUnwindSafe for Music<'a>

impl<'a> !Send for Music<'a>

impl<'a> !Sync for Music<'a>

impl<'a> Unpin for Music<'a>

impl<'a> UnwindSafe for Music<'a>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

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

type Error = Infallible

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

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

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

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

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

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

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

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

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

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

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

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