BASS.NET API for the Un4seen BASS Audio Library

BassSfxBASS_SFX_PluginClicked Method

BASS.NET API for the Un4seen BASS Audio Library
Calls the 'clicked' function of a Sonique visual plugin.

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

[DllImportAttribute("bass_sfx")]
public static bool BASS_SFX_PluginClicked(
	int handle,
	int x,
	int y
)

Parameters

handle
Type: SystemInt32
The SFX plugin handle (as obtained by BASS_SFX_PluginCreate(String, IntPtr, Int32, Int32, BASSSFXFlag)).
x
Type: SystemInt32
The x coordinate of the click relative to the top left of your visual window.
y
Type: SystemInt32
The y coordinate of the click relative to the top left of your visual window.

Return Value

Type: Boolean
If successful, then is returned, else is returned.
Remarks

This function is only valid for Sonique Visualization plugins. You must have created a plugin object using BASS_SFX_PluginCreate(String, IntPtr, Int32, Int32, BASSSFXFlag) before you can use this function.

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

See Also

Reference