BASS.NET API for the Un4seen BASS Audio Library

BassWaDspBASS_WADSP_Start Method

BASS.NET API for the Un4seen BASS Audio Library
Starts a Winamp DSP.

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

[DllImportAttribute("bass_wadsp")]
public static bool BASS_WADSP_Start(
	int plugin,
	int module,
	int handle
)

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 start (the first module is 0).
handle
Type: SystemInt32
The BASS channel handle (HSTREAM, HMUSIC, or HRECORD) for which to start the Winamp DSP. Or 0 if not applicable.

Return Value

Type: Boolean
on success, else . 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) or the name of a certain module with BASS_WADSP_GetModule(Int32). However, you can only start one module at a time for a certain Winamp DSP. The stream channel is only needed here because some Winamp DSPs might already request some information, which can be provided in this case. However, if you don't have created a stream so far, just leave the value to 0 and all is fine.

ERROR CODEDescription
BASS_ERROR_HANDLEThe plugin or the handle is not a valid handle.
BASS_ERROR_ILLPARAMThe module is not a valid module.
BASS_ERROR_ALREADYThe plugin/module was already started (you need to call BASS_WADSP_Stop(Int32) before starting it again).
BASS_ERROR_UNKNOWNSome other plugin problem (the plugin could not be initialized).

See Also

Reference