BASS.NET API for the Un4seen BASS Audio Library

BassSfxBASS_SFX_PluginModuleGetName Method

BASS.NET API for the Un4seen BASS Audio Library
Returns the name of a certain module of a loaded visual plugin.

Namespace:  Un4seen.Bass.AddOn.Sfx
Assembly:  Bass.Net (in Bass.Net.dll) Version: 2.4.17.5
Syntax
Copy
public static string BASS_SFX_PluginModuleGetName(
	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 get the name from (the first module is 0).

Return Value

Type: String
The name of the module on success or on error (or if no module with that number exists).
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.

You can use this method in a setup dialog to list all the available modules of a visual plugin.

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

Examples
Copy
string name;
for (int n=0; (name = BassSfx.BASS_SFX_PluginModuleGetName(sfx, n)) != null; n++)
{
  Console.WriteLine(name);
}
See Also

Reference

BassSfx Class
Un4seen.Bass.AddOn.Sfx Namespace