Bass.BASS_GetEAXParameters Method (EAXEnvironment, Single, Single, Single)

BassBASS_GetEAXParameters Method (EAXEnvironment, Single, Single, Single)

BASS.NET API for the Un4seen BASS Audio Library

Retrieves the current type of EAX environment and it's parameters.

Namespace: Un4seen.Bass
Assembly: Bass.Net (in Bass.Net.dll) Version: 2.4.13.3

Syntax

[DllImportAttribute("bass")]
public static bool BASS_GetEAXParameters(
	ref EAXEnvironment env,
	ref float vol,
	ref float decay,
	ref float damp
)

<DllImportAttribute("bass">]
Public Shared Function BASS_GetEAXParameters ( 
	ByRef env As EAXEnvironment,
	ByRef vol As Single,
	ByRef decay As Single,
	ByRef damp As Single
) As Boolean

Parameters

env: Type: Un4seen.BassEAXEnvironment
The EAX environment to get (one of the EAXEnvironment values).
vol: Type: SystemSingle
The volume of the reverb.
decay: Type: SystemSingle
The decay duration.
damp: Type: SystemSingle
The damping.

Return Value

Type: Boolean
If succesful, then is returned, else is returned. Use BASS_ErrorGetCode to get the error code.

Remarks

When using multiple devices, the current thread's device setting (as set with BASS_SetDevice(Int32)) determines which device this function call applies to.

ERROR CODE	Description
BASS_ERROR_INIT	BASS_Init(Int32, Int32, BASSInit, IntPtr, IntPtr) has not been successfully called.
BASS_ERROR_NOEAX	The current device does not support EAX.

Platform-specific

EAX and this function are only available on Windows

Examples

Get the current EAX environment and all it's settings:

Copy

Dim env As EAXEnvironment = EAXEnvironment.EAX_ENVIRONMENT_LEAVECURRENT
Dim vol As Single = 0F
Dim decay As Single = 0F
Dim damp As Single = 0F
If Bass.BASS_GetEAXParameters(env, vol, decay, damp) Then
  Console.WriteLine("Env={0}, Vol={1}, Decay={2}, Damp={3}", env, vol, decay, damp)
End If

Copy

EAXEnvironment env = EAXEnvironment.EAX_ENVIRONMENT_LEAVECURRENT;
float vol = 0f;
float decay = 0f;
float damp = 0f;
if (Bass.BASS_GetEAXParameters(ref env, ref vol, ref decay, ref damp))
  Console.WriteLine("Env={0}, Vol={1}, Decay={2}, Damp={3}", env, vol, decay, damp);

Reference

Bass Class

BASS_GetEAXParameters Overload

Un4seen.Bass Namespace