Tao.Sdl SDK Documentation

SdlMixer.Mix_HaltChannel Method 

Stop playing on a channel

[Visual Basic]
Public Shared Function Mix_HaltChannel( _
   ByVal channel As Integer _
) As Integer
[C#]
public static int Mix_HaltChannel(
   int channel
);

Parameters

channel
Channel to stop playing, or -1 for all channels.

Return Value

always returns zero. (kinda silly)

Remarks

Halt channel playback, or all channels if -1 is passed in. Any callback set by Mix_ChannelFinished will be called.

Binds to C-function in SDL_mixer.h

int Mix_HaltChannel(int channel)
            

Example

            // halt playback on all channels
            Mix_HaltChannel(-1);
            

See Also

SdlMixer Class | Tao.Sdl Namespace | Mix_ExpireChannel | Mix_FadeOutChannel | Mix_ChannelFinished