Class | Rubygame::Mixer::Music
In: | lib/rubygame/deprecated_mixer.rb
Parent: | Object

**NOTE:** This class is DEPRECATED and will be removed in Rubygame 3.0. Please use the Rubygame::Music class instead.

The Music class is used for playing music from a file. It supports WAVE, MOD, MIDI, OGG, and MP3 files. There are two important differences between Music and Sample:

1. Music streams the music from disk, which means it can start faster and uses less memory than Sample, which loads the entire file into memory. This is especially important for music files, which are often several minutes long.
2. There can only be one Music instance playing at once, while there can be many Samples playing at once. If you play a second Music while one is already playing, the first one will be stopped. See play.

### Methods

fade_in fade_out fading? jump load_audio new pause paused? play playing? resume rewind stop volume volume=

### Public Class methods

load_audio()

**NOTE:** Rubygame::Mixer::Music is DEPRECATED and will be removed in Rubygame 3.0. Please use the Rubygame::Music class instead.

Load music from a file. Supports WAV, MOD, MIDI, OGG, and MP3 formats.

Raises SDLError if the music could not be loaded.

new( struct=nil )

call-seq: new

### Public Instance methods

fade_in( fade_time, repeats=0, start=0 )

Play the music, fading in and repeating a certain number of times. See also play.

Raises SDLError if something goes wrong.

fade_time: | Time in seconds for the fade-in effect to complete.
repeats: | Number of extra times to play through the music. -1 plays the music forever until it is stopped. Defaults to 0, play only once (no repeats).
start: | Time to start from, in seconds since the beginning. Defaults to 0, the beginning of the song. Non-zero values only work for OGG and MP3; other music types will raise SDLError.

fade_out( fade_time )

Gradually fade the music to silence over `fade_length` seconds. After the fade is complete, the music will be automatically stopped.

Raises SDLError if something goes wrong.

fade_time: | Time until the music is totally silent, in seconds.

fading?( direction=nil )

True if the music is fading in or out (or either). You can specify `direction` as :in/:out to check only fading in/out; otherwise, it will return true if it‘s fading either way.

direction: | :in, :out, or nil if you don‘t care which.
Returns: | true if the music is fading in the given direction.

jump( time )

Jump to a certain time in the music. Only works when music is playing or paused (but not stopped). Only works for OGG and MP3 files.

Raises SDLError if something goes wrong, or if the music type does not support setting the position.

time: | Time to jump to, in seconds from the beginning.

pause()

Pause playback of the playing music. You can later resume playback from the point where you paused. Safe to use on already-paused music. See also play_music.

paused?()

Returns true if the music is currently paused.

play( repeats=0 )

Play music, repeating a certain number of extra times. If any music was already playing, that music will be stopped first, and this music will start.

Raises SDLError if something goes wrong.

This method takes these arguments:

repeats: | how many extra times to play the music. Can be -1 to repeat forever until it is stopped.

playing?()

Returns true if the music is currently playing.

resume()

Resume playback of paused music from the point it was paused. Safe to use on already-playing music. See also play.

rewind()

Rewind the music to the start. This is safe to use on stopped, paused, and playing music. Only works for MOD, OGG, MP3, and MIDI (but not WAV).

stop()

Stop playback of music. See also play

volume()

Returns the current volume level of the music. 0.0 is total silence, 1.0 is maximum volume.

volume=( new_volume )

Sets the volume level of the music. 0.0 is total silence, 1.0 is maximum volume.

[Validate]