BASS.NET API for the Un4seen BASS Audio Library

BassSfxBASS_SFX_PluginFlags Method

BASS.NET API for the Un4seen BASS Audio Library
Modifies and/or retrieves a plugin's flags.

Namespace:  Un4seen.Bass.AddOn.Sfx
Assembly:  Bass.Net (in Bass.Net.dll) Version: 2.4.17.5
Syntax
Copy
[DllImportAttribute("bass_sfx")]
public static BASSSFXFlag BASS_SFX_PluginFlags(
	int handle,
	BASSSFXFlag flags,
	BASSSFXFlag mask
)

Parameters

handle
Type: SystemInt32
The SFX plugin handle (as obtained by BASS_SFX_PluginCreate(String, IntPtr, Int32, Int32, BASSSFXFlag)).
flags
Type: Un4seen.Bass.AddOn.SfxBASSSFXFlag
Any combination of these flags (see BASSSFXFlag):
BASS_SFX_SONIQUE_OPENGLRender sonique plugins using OpenGL.
BASS_SFX_SONIQUE_OPENGL_DOUBLEBUFFERUse OpenGL double buffering with sonique plugins.
mask
Type: Un4seen.Bass.AddOn.SfxBASSSFXFlag
The flags (as above) to modify. Flags that are not included in this are left as they are, so it can be set to 0 (BASS_SFX_DEFAULT) in order to just retrieve the current flags.

Return Value

Type: BASSSFXFlag
If successful, the plugin's updated flags are returned, else -1 is returned. Use BASS_SFX_ErrorGetCode to get the error code.
Remarks

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!

Examples
Copy
// set OpenGL flag:
BassSfx.BASS_SFX_PluginFlags(hsfx, BASSSFXFlag.BASS_SFX_SONIQUE_OPENGL, BASSSFXFlag.BASS_SFX_SONIQUE_OPENGL);

// remove OpenGL flag:
BassSfx.BASS_SFX_PluginFlags(hsfx, BASSSFXFlag.BASS_SFX_DEFAULT, BASSSFXFlag.BASS_SFX_SONIQUE_OPENGL);
See Also

Reference

BassSfx Class
Un4seen.Bass.AddOn.Sfx Namespace