Struct rich_sdl2_rust::mixer::music::MixMusic

pub struct MixMusic<'device> { /* private fields */ }

A music buffer of the audio data.

Implementations

impl<'device> MixMusic<'device>

pub fn new( _device: &'device MixDevice<'device>, file_name: &str ) -> Result<Self>

Constructs a music from the file, or Err on failure.

Panics

Panics if file_name is empty.

pub fn music_type(&self) -> MusicType

Returns the type of the music.

pub fn with_cmd( device: &'device MixDevice<'device>, file_name: &str, command: &str ) -> Result<Self>

Constructs a music from the file with the custom player command, or Err on failure.

The command must handle the signals emitted by the SDL2_mixer:

• On stop: SIGTERM signal
• On pause: SIGSTOP signal
• On unpause: SIGCONT signal

Panics

Panics if file_name or command is empty.

pub fn play(&self, loops: Option<u32>) -> Result<()>

Plays the music. If a music is already playing, it synchronously waits until the music ends. If loops is None, the play continues infinitely.

pub fn fade_in( &self, fade_in: u32, loops: Option<u32>, begin: Option<f64> ) -> Result<()>

Plays the music with fade-in times in milliseconds and begin times in seconds. If a music is already playing, it synchronously waits until the music ends. If loops is None, the play continues infinitely. If begin is None, the play begins from the start.

pub fn set_pos(&self, pos: f64) -> Result<()>

Sets the music position in seconds, or Err on failure.

pub fn volume(&self) -> u32

Returns the volume of the music.

pub fn set_volume(&self, volume: u32)

Sets the volume of the music. The volume is clamped in 0..=128.

pub fn rewind(&self)

Rewinds the music to the beginning. Rewinding is valid only mod, ogg vorbis, mpeg-1 layer-3, and midi format.

pub fn pause(&'device mut self) -> Pauser<'device>

Pauses the music until dropping the Pauser.

pub fn halt(&self)

Halts the music.

pub fn fade_out(&self, fade_out: u32) -> Result<()>

Halts the music with fade-out in milliseconds.

pub fn is_playing(&self) -> bool

Returns whether the music is playing.

pub fn fading_state(&self) -> FadingState

Returns the fading state of the music.

Trait Implementations

impl Drop for MixMusic<'_>

fn drop(&mut self)

Executes the destructor for this type.