Tao.Sdl SDK Documentation

SdlMixer.Mix_HaltGroup Method 

Stop a group

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

Parameters

tag
Group to fade out. NOTE: -1 will NOT halt all channels. Use Mix_HaltChannel(-1) for that instead.

Return Value

always returns zero. (more silly than Mix_HaltChannel)

Remarks

Halt playback on all channels in group tag. Any callback set by Mix_ChannelFinished will be called once for each channel that stops.

Binds to C-function in SDL_mixer.h

int Mix_HaltGroup(int tag)
            

Example

            // halt playback on all channels in group 1
            Mix_HaltGroup(1);
            

See Also

SdlMixer Class | Tao.Sdl Namespace | Mix_FadeOutGroup | Mix_HaltChannel | Mix_ChannelFinished