BASS.NET API for the Un4seen BASS Audio Library

BassWaDspBASS_WADSP_GetModuleName Method

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

Namespace:  Un4seen.Bass.AddOn.WaDsp
Assembly:  Bass.Net (in Bass.Net.dll) Version: 2.4.17.5
Syntax

public static string BASS_WADSP_GetModuleName(
	int plugin,
	int module
)

Parameters

plugin
Type: SystemInt32
The plugin handle (returned by BASS_WADSP_Load(String, Int32, Int32, Int32, Int32, WINAMPWINPROC)).
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). Use BASS_ErrorGetCode to get the error code.
Remarks

Winamp DSPs might provide multiple independent modules. You might get the number of available modules with BASS_WADSP_GetModuleCount(Int32). However, you can only start one module at a time for a certain Winamp DSP.

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

ERROR CODEDescription
BASS_ERROR_HANDLEThe plugin is not a valid plugin handle.
BASS_ERROR_ILLPARAMThe module number is invalid.

Examples

string name;
for (int n=0; (name = BassWaDsp.BASS_WADSP_GetModuleName(plugin, n)) != null; n++)
{
  Console.WriteLine(name);
}
See Also

Reference