BASS.NET API for the Un4seen BASS Audio Library

BassSfxBASS_SFX_PluginModuleSetActive Method

BASS.NET API for the Un4seen BASS Audio Library
Sets the active module for a visual plugin.

Namespace:  Un4seen.Bass.AddOn.Sfx
Assembly:  Bass.Net (in Bass.Net.dll) Version: 2.4.17.5
Syntax
Copy
[DllImportAttribute("bass_sfx")]
public static bool BASS_SFX_PluginModuleSetActive(
	int handle,
	int module
)

Parameters

handle
Type: SystemInt32
The SFX plugin handle (as obtained by BASS_SFX_PluginCreate(String, IntPtr, Int32, Int32, BASSSFXFlag)).
module
Type: SystemInt32
The module number to set active (the first module is 0).

Return Value

Type: Boolean
If successful, then is returned, else is returned.
Remarks
Visual plugins might provide multiple independent modules. You might get the number of available modules with BASS_SFX_PluginModuleGetCount(Int32). However, you can only start/activate one module at a time for a certain visual plugin.

Note: Sonique plugins only ever have 1 module. Winamp plugins can have multiple modules. So this call is really only useful for Winamp.

ERROR CODEDescription
BASS_SFX_ERROR_INITBASS_SFX_Init(IntPtr, IntPtr) has not been successfully called.
BASS_SFX_ERROR_HANDLEInvalid SFX handle or invalid module index.
BASS_SFX_ERROR_MEMMemory error.
BASS_SFX_ERROR_UNKNOWNSome other mystery problem!

See Also

Reference

BassSfx Class
Un4seen.Bass.AddOn.Sfx Namespace