Struct sdl2::mixer::Music[−][src]

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

Expand description

This is an opaque data type used for Music data.

Fields

raw: *mut Mix_Musicowned: bool

Implementations

[src]

impl<'a> Music<'a>

[src]

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

Load music file to use.

[src]

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

Load music from a static byte buffer.

[src]

pub fn get_type(&self) -> MusicType

The file format encoding of the music.

[src]

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

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

[src]

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.

[src]

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

Fade in over ms milliseconds of time, from position.

[src]

pub fn get_volume() -> i32

Returns current volume

[src]

pub fn set_volume(volume: i32)

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

[src]

pub fn pause()

Pause the music playback.

[src]

pub fn resume()

Unpause the music.

[src]

pub fn rewind()

Rewind the music to the start.

[src]

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

Set the position of the currently playing music.

[src]

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

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

[src]

pub fn halt()

Halt playback of music.

[src]

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

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

[src]

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

[src]

pub fn unhook_finished()

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

[src]

pub fn is_playing() -> bool

If music is actively playing, or not.

[src]

pub fn is_paused() -> bool

If music is paused, or not.

[src]

pub fn get_fading() -> Fading

If music is fading, or not.

Trait Implementations

[src]

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

[src]

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

Shows the original regular expression.

[src]

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

[src]

fn drop(&mut self)

Executes the destructor for this type. Read more

[src]

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

[src]

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

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

[src]

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

This method tests for !=.

[src]

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

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

Struct sdl2::mixer::Music[−][src]

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

Examples

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>,