Tao.Sdl SDK Documentation

SdlMixer.Mix_UnregisterAllEffects Method 

Unhook all processors from a channel

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

Parameters

channel
Channel to remove all effects from. Use MIX_CHANNEL_POST for the postmix stream.

Return Value

Zero on errors, such as channel not existing.

Remarks

This removes all effects registered to channel. If the channel is active all the registered effects will have their Mix_EffectDone_t functions called, if they were specified in Mix_RegisterEffect.

int Mix_UnregisterAllEffects(int channel)
            

Example

            // remove all effects from channel 0
                    if(!Mix_UnregisterAllEffects(0))
                {
                    printf("Mix_UnregisterAllEffects: %s\n", Mix_GetError());
                }
            

See Also

SdlMixer Class | Tao.Sdl Namespace | Mix_UnregisterEffect | Mix_RegisterEffect