Bass.BASS_GetEAXParameters Method (Object, Object, Object, Object)

BassBASS_GetEAXParameters Method (Object, Object, Object, Object)

BASS.NET API for the Un4seen BASS Audio Library

Retrieves the current type of EAX environment and it's parameters. Note: This is a generic overload using object references, so that you can pass values as in the C++ interface. So make sure to pass object references of the currect type into this method and cast the return value back to the correct data types!

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

Syntax

Copy

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

<DllImportAttribute("bass">]
Public Shared Function BASS_GetEAXParameters ( 
	<OutAttribute> env As Object,
	<OutAttribute> vol As Object,
	<OutAttribute> decay As Object,
	<OutAttribute> damp As Object
) As Boolean

Parameters

env: Type: SystemObject
The EAX environment (int)... = don't retrieve it. See BASS_SetEAXParameters(EAXEnvironment, Single, Single, Single) for a list of the possible environments (or use one of these EAXEnvironment values, which need to be casted into an (object) here).
vol: Type: SystemObject
The volume of the reverb (float)... = don't retrieve it.
decay: Type: SystemObject
The decay duration (float)... = don't retrieve it.
damp: Type: SystemObject
The damping (float)... = don't retrieve it.

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.

Examples

Get the current environment setting and volume:

Copy

Dim env As Object = EAXEnvironment.EAX_ENVIRONMENT_LEAVECURRENT
Dim vol As Object = 0F
If Bass.BASS_GetEAXParameters(env, vol, Nothing, Nothing) Then
  ' env needs to be casted back to an EAXEnvironment
  ' vol needs to be casted back to float
  Console.WriteLine("Env={0}, Vol={1}", CType(env, EAXEnvironment), CSng(vol))
Else
  Console.WriteLine("Bass_Init error OR Device does not support EAX!")
End If

Copy

object env = EAXEnvironment.EAX_ENVIRONMENT_LEAVECURRENT;
object vol = 0f;
if ( Bass.BASS_GetEAXParameters( env, vol, null, null ) )
{
  // env needs to be casted back to an EAXEnvironment
  // vol needs to be casted back to float
  Console.WriteLine( "Env={0}, Vol={1}", (EAXEnvironment)env, (float)vol );
}
else
    Console.WriteLine( "Bass_Init error OR Device does not support EAX!" );

Reference

Bass Class

BASS_GetEAXParameters Overload

Un4seen.Bass Namespace