<pre> my $music = SDL::Mixer::Music::load_MUS( $file );
</pre>
-<p><code>load_MUS</code> loads a music file into a <code>SDL::Music::MixMusic</code> structure. This can be passed to <a href="http://search.cpan.org/perldoc?play_music">play_music</a>.</p>
+<p><code>load_MUS</code> loads a music file into a <code>SDL::Mixer::MixMusic</code> structure. This can be passed to <a href="/SDL-Mixer-Music.html#play_music">SDL::Mixer::Music::play_music</a>.</p>
</div>
<h2 id="hook_music">hook_music</h2>
<div id="hook_music_CONTENT">
<pre> SDL::Mixer::Music::hook_music( $callback, $position );
- or
-
- SDL::Mixer::Music::hook_music( &callback, $position );
-
</pre>
<p>This sets up a custom music player function, so you can pass your own audio stream data into the SDL::Mixer.
The function will be called with <code>position</code> passed into the first parameter when the <code>callback</code> is called.
<p><strong>Note</strong>: NEVER call <code>SDL::Mixer</code> functions, nor <a href="/SDL-Audio.html#lock">SDL::Audio::lock</a>, from a callback function.</p>
<p><strong>Note</strong>: At program termination also call <code>SDL::Mixer::Music::hook_music()</code> to stop this callback.</p>
<p>Example:</p>
-<pre> my $callback = sub
+<pre> sub callback
{
my $position = shift; # position (first time its 0, on each call $length is added)
my $length = shift; # length of bytes we have to put in stream
}
return @stream;
- };
+ }
- SDL::Mixer::Music::hook_music( $callback, 0 );
+ SDL::Mixer::Music::hook_music( 'main::callback', 0 );
</pre>
</div>
<h2 id="hook_music_finished">hook_music_finished</h2>
<div id="hook_music_finished_CONTENT">
-<pre> SDL::Mixer::Music::hook_music_finished( $callback );
+<pre> SDL::Mixer::Music::hook_music_finished( 'main::callback' );
</pre>
-<p>This callback is called when music called by e.g. <a href="http://search.cpan.org/perldoc?play_music">play_music</a> or <a href="http://search.cpan.org/perldoc?fade_in_music">fade_in_music</a> stops naturally. This happens when the music is over or is
-fading out.</p>
-<p><strong>Note</strong>: If you play music via <a href="http://search.cpan.org/perldoc?hook_music">hook_music</a>, this callback will never be called.</p>
+<p>This callback is called when music called by e.g. <a href="/SDL-Mixer-Music.html#play_music">SDL::Mixer::Music::play_music</a> or <a href="/SDL-Mixer-Music.html#fade_in_music">SDL::Mixer::Music::fade_in_music</a> stops naturally.
+This happens when the music is over or is fading out.</p>
+<p><strong>Note</strong>: If you play music via <a href="/SDL-Mixer-Music.html#hook_music">SDL::Mixer::Music::hook_music</a>, this callback will never be called.</p>
<p>Example:</p>
<pre> my $music_is_playing = 0;
my @music = qw(first.mp3 next.mp3 other.mp3 last.mp3);
- my $callback = sub{ $music_is_playing = 0; };
- SDL::Mixer::Music::hook_music_finished( $callback );
+ sub callback
+ {
+ $music_is_playing = 0;
+ }
+
+ SDL::Mixer::Music::hook_music_finished( 'main::callback' );
foreach my $this_song ( @music )
{
<pre> my $position = SDL::Mixer::Music::get_music_hook_data();
</pre>
-<p>Returns the <code>position</code> (first) parameter that will be passed to <a href="http://search.cpan.org/perldoc?hook_music">hook_music</a>'s callback.</p>
+<p>Returns the <code>position</code> (first) parameter that will be passed to <a href="/SDL-Mixer-Music.html#hook_music">SDL::Mixer::Music::hook_music</a>'s callback.</p>
</div>
<h2 id="play_music">play_music</h2>
<pre> my $music = SDL::Mixer::Music::fade_in_music( $mix_music, $loops, $ms );
</pre>
-<p>Same as <a href="http://search.cpan.org/perldoc?play_music">play_music</a> but you can specify the fade-in time by <code>$ms</code>.</p>
+<p>Same as <a href="/SDL-Mixer-Music.html#play_music">SDL::Mixer::Music::play_music</a> but you can specify the fade-in time by <code>$ms</code>.</p>
</div>
<h2 id="fade_out_music">fade_out_music</h2>
<dt>MP3</dt>
<dd>
<p>Jumps to position seconds from the current position in the stream.
-So you may want to call <a href="http://search.cpan.org/perldoc?rewind_music">rewind_music</a> before this.
+So you may want to call <a href="/SDL-Mixer-Music.html#rewind_music">SDL::Mixer::Music::rewind_music</a> before this.
Does not go in reverse... negative values do nothing. </p>
- <p>Returns: <code>0</code> on success, or <code>-1</code> if the codec doesn't support this function. </p>
+ </dd>
+</dl>
+<p>Returns: <code>0</code> on success, or <code>-1</code> if the codec doesn't support this function. </p>
</div>
<h2 id="paused_music">paused_music</h2>
<pre> my $paused = SDL::Mixer::Music::paused_music();
</pre>
- <p>Returns <code>1</code> if the music is paused, otherwise <code>0</code>.</p>
+<p>Returns <code>1</code> if the music is paused, otherwise <code>0</code>.</p>
</div>
<h2 id="playing_music">playing_music</h2>
<pre> my $playing_music = SDL::Mixer::Music::playing_music();
</pre>
- <p>Returns <code>1</code> if the music is playing sound, otherwise <code>0</code>. It does'nt check if the music is paused.</p>
+<p>Returns <code>1</code> if the music is playing sound, otherwise <code>0</code>. It does'nt check if the music is paused.</p>
</div>
<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="AUTHOR_CONTENT">
- <p>Tobias Leich [FROGGS]</p>
+<p>Tobias Leich [FROGGS]</p>
</div>
</div>
\ No newline at end of file
projects / sdlgit/SDL-Site.git / blobdiff