BASS.NET API for the Un4seen BASS Audio Library

BassBASS_ChannelRemoveFX Method

BASS.NET API for the Un4seen BASS Audio Library
Removes an effect on a stream, MOD music, or recording channel.

Namespace:  Un4seen.Bass
Assembly:  Bass.Net (in Bass.Net.dll) Version: 2.4.17.5
Syntax
Copy
[DllImportAttribute("bass")]
public static bool BASS_ChannelRemoveFX(
	int handle,
	int fx
)

Parameters

handle
Type: SystemInt32
The channel handle... a HSTREAM, HMUSIC, or HRECORD.
fx
Type: SystemInt32
Handle of the effect to remove from the channel (return value of a previous BASS_ChannelSetFX(Int32, BASSFXType, Int32) call).

Return Value

Type: Boolean
If succesful, is returned, else is returned. Use BASS_ErrorGetCode to get the error code.
Remarks
Depending on the DX8 effect implementation being used by the channel, the channel may have to be stopped before removing a DX8 effect on it. If necessary, that is done automatically and the channel is resumed afterwards.

BASS_ChannelRemoveDSP(Int32, Int32) can also be used to remove effects.

ERROR CODEDescription
BASS_ERROR_HANDLEAt least one of handle and fx is not valid.

See Also

Reference

Bass Class
Un4seen.Bass Namespace