Tao.Sdl SDK Documentation

SdlMixer.Mix_FadeOutGroup Method 

Fade out a group over time

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

Parameters

tag
Group to fade out. NOTE: -1 will NOT fade all channels out. Use Mix_FadeOutChannel(-1) for that instead.
ms
Milliseconds of time that the fade-out effect should take to go to silence, starting now.

Return Value

The number of channels set to fade out.

Remarks

Gradually fade out channels in group tag over ms milliseconds starting from now. The channels will be halted after the fade out is completed. Only channels that are playing are set to fade out, including paused channels. Any callback set by Mix_ChannelFinished will be called when each channel finishes fading out.

Binds to C-function in SDL_mixer.h

int Mix_FadeOutGroup(int tag, int ms)
            

Example

            // fade out all channels in group 1 to finish 3 seconds from now
            printf("starting fade out of %d channels\n", Mix_FadeOutGroup(1, 3000));
            

See Also

SdlMixer Class | Tao.Sdl Namespace | Mix_HaltGroup | Mix_FadeOutChannel | Mix_FadingChannel | Mix_ChannelFinished