Tao.Sdl SDK Documentation

SdlMixer.Mix_FadeInChannel Method 

Play loop with fade in

[Visual Basic]
Public Shared Function Mix_FadeInChannel( _
   ByVal channel As Integer, _
   ByVal chunk As IntPtr, _
   ByVal loops As Integer, _
   ByVal ms As Integer _
) As Integer
[C#]
public static int Mix_FadeInChannel(
   int channel,
   IntPtr chunk,
   int loops,
   int ms
);

Parameters

channel
Channel to play on, or -1 for the first free unreserved channel.
chunk
Sample to play.
loops
Number of loops, -1 is infinite loops. Passing one here plays the sample twice (1 loop).
ms
Milliseconds of time that the fade-in effect should take to go from silence to full volume.

Return Value

the channel the sample is played on. On any errors, -1 is returned.

Remarks

Play chunk on channel, or if channel is -1, pick the first free unreserved channel. The channel volume starts at 0 and fades up to full volume over ms milliseconds of time. The sample may end before the fade-in is complete if it is too short or doesn't have enough loops. The sample will play for loops+1 number of times, unless stopped by halt, or fade out, or setting a new expiration time of less time than it would have originally taken to play the loops, or closing the mixer. Note: this just calls Mix_FadeInChannelTimed with ticks set to -1.

Binds to C-function in SDL_mixer.h

int Mix_FadeInChannel(int channel, Mix_Chunk *chunk, int loops, int ms)
            

Example

            // play sample on first free unreserved channel
                    // play it exactly 3 times through
                    // fade in over one second
                    // Mix_Chunk *sample; //previously loaded
                    if(Mix_FadeInChannel(-1, sample, 3, 1000)==-1)
                {
                    printf("Mix_FadeInChannel: %s\n",Mix_GetError());
                    // may be critical error, or maybe just no channels were free.
                    // you could allocated another channel in that case...
                }
            

See Also

SdlMixer Class | Tao.Sdl Namespace | Mix_PlayChannel | Mix_FadeInChannelTimed | Mix_FadingChannel | Mix_FadeOutChannel | Mix_ReserveChannels