X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=sdlgit%2FSDL-Site.git;a=blobdiff_plain;f=pages%2FSDL-Mixer-Music.html-inc;h=0b6c7c4a02ce354d125e02d306d4070f5c0f1b25;hp=a7a9ec8e4e90268fe38bbb7ab93505947eadd1bc;hb=0b221bb4fce84647a6cb9d7343de7330fb561c71;hpb=a43a516b1f3521ac3984af2bcbf57e767bca01fc diff --git a/pages/SDL-Mixer-Music.html-inc b/pages/SDL-Mixer-Music.html-inc index a7a9ec8..0b6c7c4 100644 --- a/pages/SDL-Mixer-Music.html-inc +++ b/pages/SDL-Mixer-Music.html-inc @@ -23,7 +23,7 @@
my $music = SDL::Mixer::Music::load_MUS( $file );-
load_MUS
loads a music file into a SDL::Mixer::MixMusic
structure. This can be passed to SDL::Mixer::Music::play_music.
load_MUS
loads a music file into a SDL::Mixer::MixMusic
structure. This can be passed to play_music (play_music in SDL::Mixer::Music).
To stop the custom music player call hook_music()
without arguments.
Note: NEVER call SDL::Mixer
functions, nor SDL::Audio::lock, from a callback function.
Note: NEVER call SDL::Mixer
functions, nor SDL::Audio::lock (lock in SDL::Audio), from a callback function.
Note: At program termination also call SDL::Mixer::Music::hook_music()
to stop this callback.
Example:
sub callback @@ -91,9 +91,9 @@ Using a custom music player and the internal music player is not possible, the cSDL::Mixer::Music::hook_music_finished( 'main::callback' );-This callback is called when music called by e.g. SDL::Mixer::Music::play_music or SDL::Mixer::Music::fade_in_music stops naturally. +
This callback is called when music called by e.g. SDL::Mixer::Music::play_music or SDL::Mixer::Music::fade_in_music stops naturally. This happens when the music is over or is fading out.
-Note: If you play music via SDL::Mixer::Music::hook_music, this callback will never be called.
+Note: If you play music via SDL::Mixer::Music::hook_music, this callback will never be called.
Example:
my $music_is_playing = 0; my @music = qw(first.mp3 next.mp3 other.mp3 last.mp3); @@ -122,7 +122,7 @@ This happens when the music is over or is fading out.my $position = SDL::Mixer::Music::get_music_hook_data();-Returns the
+position
(first) parameter that will be passed to SDL::Mixer::Music::hook_music's callback.Returns the
position
(first) parameter that will be passed to SDL::Mixer::Music::hook_music's callback.play_music
@@ -148,7 +148,7 @@ Passing -1 to$loops
will loop the music infinitely.my $music = SDL::Mixer::Music::fade_in_music( $mix_music, $loops, $ms );-Same as SDL::Mixer::Music::play_music but you can specify the fade-in time by
+$ms
.Same as SDL::Mixer::Music::play_music but you can specify the fade-in time by
$ms
.fade_out_music
@@ -242,9 +242,11 @@ Passing zero is similar to rewinding the song.
Jumps to position seconds from the current position in the stream. -So you may want to call SDL::Mixer::Music::rewind_music before this. +So you may want to call SDL::Mixer::Music::rewind_music before this. Does not go in reverse... negative values do nothing.
-Returns: 0
on success, or -1
if the codec doesn't support this function.
Returns: 0
on success, or -1
if the codec doesn't support this function.
my $paused = SDL::Mixer::Music::paused_music();-
Returns 1
if the music is paused, otherwise 0
.
Returns 1
if the music is paused, otherwise 0
.
my $playing_music = SDL::Mixer::Music::playing_music();-
Returns 1
if the music is playing sound, otherwise 0
. It does'nt check if the music is paused.
Returns 1
if the music is playing sound, otherwise 0
. It does'nt check if the music is paused.