X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=pages%2FSDL-Mixer-Channels.html-inc;h=f254f2d2254d2c348c1c9178e897c1b977ce4e16;hb=05971ac01a9556f7e769cda59ef5b419a60a0aa7;hp=e6c97014fc8b7b61dc16db75f8c8343edb716b9a;hpb=3bc8c797322373e5107d166c9c3228eedf807af0;p=sdlgit%2FSDL-Site.git diff --git a/pages/SDL-Mixer-Channels.html-inc b/pages/SDL-Mixer-Channels.html-inc index e6c9701..f254f2d 100644 --- a/pages/SDL-Mixer-Channels.html-inc +++ b/pages/SDL-Mixer-Channels.html-inc @@ -48,66 +48,168 @@

allocate_channels

+
 my $ret = SDL::Mixer::Channels::allocate_channels( $number_of_channels );
+
+
+

Dynamically change the number of channels managed by the mixer. If decreasing the number of channels, the upper channels arestopped. +This function returns the new number of allocated channels.

+

Example

+
 use SDL::Mixer::Channels;
+
+ printf("We got %d channels!\n", SDL::Mixer::Channels::allocate_channels( 8 ) );
+
+

volume

+
 my $prev_volume = SDL::Mixer::Channels::volume( $channel_number, $volume );
+
+
+

volume changes the volume of the channel specified in channel by the amount set in volume. The range of volume is from 0 to MIX_MAX_VOLUME +which is 128. Passing -1 to channel will change the volume of all channels. If the specified volume is -1, it will just return the +current volume.

+

Returns the previously set volume of the channel.

play_channel

+
 my $channel_number = SDL::Mixer::Channels::play_channel( $channel, $chunk, $loops );
+
+
+

play_channel will play the specified chunk over the specified channel. SDL_mixer will choose a channel for you if you pass -1 for +channel.

+

The chunk will be looped loops times, the total number of times played will be loops+1. Passing -1 will loop the chunk infinitely.

+

Returns the channel the chunk will be played on, or -1 on error.

+

Example:

+
 use SDL::Mixer;
+ use SDL::Mixer::Channels;
+ use SDL::Mixer::Samples;
+
+ SDL::init(SDL_INIT_AUDIO);
+ SDL::Mixer::open_audio( 44100, SDL::Constants::AUDIO_S16, 2, 4096 );
+
+ my $chunk = SDL::Mixer::Samples::load_WAV('sample.wav');
+
+ SDL::Mixer::Channels::play_channel( -1, $chunk, -1 );
+
+ SDL::delay(1000);
+ SDL::Mixer::close_audio();
+
+

play_channel_timed

+
 my $channel = SDL::Mixer::Channels::play_channel_timed( $channel, $chunk, $loops, $ticks );
+
+
+

Same as play_channel but you can specify the time it will play by $ticks.

fade_in_channel

+
 my $channel = SDL::Mixer::Channels::fade_in_channel( $channel, $chunk, $loops, $ms );
+
+
+

Same as play_channel but you can specify the fade-in time by $ms.

fade_in_channel_timed

+
 my $channel = SDL::Mixer::Channels::fade_in_channel_timed( $channel, $chunk, $loops, $ms, $ticks );
+
+
+

Same as fade_in_channel but you can specify the time how long the chunk will be played by $ticks.

pause

+
 SDL::Mixer::Channels::pause( $channel );
+
+
+

Pauses the given channel or all by passing -1.

resume

+
 SDL::Mixer::Channels::resume( $channel );
+
+
+

Resumes the given channel or all by passing -1.

halt_channel

+
 SDL::Mixer::Channels::halt_channel( $channel );
+
+
+

Stops the given channel or all by passing -1.

expire_channel

+
 my $channels = SDL::Mixer::Channels::expire_channel( $channel, $ticks );
+
+
+

Stops the given channel (or -1 for all) after the time specified by $ticks (in milliseconds).

+

Returns the number of affected channels.

fade_out_channel

+
 my $fading_channels = SDL::Mixer::Channels::fade_out_channel( $which, $ms );
+
+
+

fade_out_channel fades out a channel specified in which with a duration specified in ms in milliseconds.

+

Returns the the number of channels that will be faded out.

channel_finished

+

TODO

playing

+
 my $playing = SDL::Mixer::Channels::playing( $channel );
+
+
+

Returns 1 if the given channel is playing sound, otherwise 0. It does'nt check if the channel is paused.

+

Note: If you pass -1 you will get the number of playing channels.

paused

+
 my $paused = SDL::Mixer::Channels::paused( $channel );
+
+
+

Returns 1 if the given channel is paused, otherwise 0.

+

Note: If you pass -1 you will get the number of paused channels.

fading_channel

+
 my $fading_channel = SDL::Mixer::Channels::fading_channel( $channel );
+
+
+

Returns one of the following for the given channel:

+ + +

Note: Never pass -1 to this function!

get_chunk

+
 my $chunk = SDL::Mixer::Channels::get_chunk( $channel );
+
+
+

get_chunk gets the most recent sample chunk played on channel. This chunk may be currently playing, or just the last used.

+

Note: Never pass -1 to this function!

\ No newline at end of file