BASS_SetEAXParameters
Sets the type of EAX environment and its parameters.
BOOL BASS_SetEAXParameters( int env, float vol, float decay, float damp );
Parameters
env | The EAX environment... -1 = leave current, or one of the following. EAX_ENVIRONMENT_GENERIC, EAX_ENVIRONMENT_PADDEDCELL, EAX_ENVIRONMENT_ROOM, EAX_ENVIRONMENT_BATHROOM, EAX_ENVIRONMENT_LIVINGROOM, EAX_ENVIRONMENT_STONEROOM, EAX_ENVIRONMENT_AUDITORIUM, EAX_ENVIRONMENT_CONCERTHALL, EAX_ENVIRONMENT_CAVE, EAX_ENVIRONMENT_ARENA, EAX_ENVIRONMENT_HANGAR, EAX_ENVIRONMENT_CARPETEDHALLWAY, EAX_ENVIRONMENT_HALLWAY, EAX_ENVIRONMENT_STONECORRIDOR, EAX_ENVIRONMENT_ALLEY, EAX_ENVIRONMENT_FOREST, EAX_ENVIRONMENT_CITY, EAX_ENVIRONMENT_MOUNTAINS, EAX_ENVIRONMENT_QUARRY, EAX_ENVIRONMENT_PLAIN, EAX_ENVIRONMENT_PARKINGLOT, EAX_ENVIRONMENT_SEWERPIPE, EAX_ENVIRONMENT_UNDERWATER, EAX_ENVIRONMENT_DRUGGED, EAX_ENVIRONMENT_DIZZY, EAX_ENVIRONMENT_PSYCHOTIC. |
vol | The volume of the reverb... 0 (off) to 1 (max), less than 0 = leave current. |
decay | The time in seconds it takes the reverb to diminish by 60 dB... 0.1 (min) to 20 (max), less than 0 = leave current. |
damp | The damping, high or low frequencies decay faster... 0 = high decays quickest, 1 = low/high decay equally, 2 = low decays quickest, less than 0 = leave current. |
Return value
If successful, then TRUE is returned, else FALSE is returned. Use BASS_ErrorGetCode to get the error code.Error codes
BASS_ERROR_INIT | BASS_Init has not been successfully called. |
BASS_ERROR_NOEAX | The output device does not support EAX. |
Remarks
The use of EAX functions requires that the output device supports EAX. BASS_GetInfo can be used to check that. EAX only affects 3D channels, but EAX functions do not require BASS_Apply3D to apply the changes.Presets are provided for all the EAX environments. To use a preset, simply call BASS_SetEAXParameters(preset), where preset is one of the following.
EAX_PRESET_GENERIC,
EAX_PRESET_PADDEDCELL,
EAX_PRESET_ROOM,
EAX_PRESET_BATHROOM,
EAX_PRESET_LIVINGROOM,
EAX_PRESET_STONEROOM,
EAX_PRESET_AUDITORIUM,
EAX_PRESET_CONCERTHALL,
EAX_PRESET_CAVE,
EAX_PRESET_ARENA,
EAX_PRESET_HANGAR,
EAX_PRESET_CARPETEDHALLWAY,
EAX_PRESET_HALLWAY,
EAX_PRESET_STONECORRIDOR,
EAX_PRESET_ALLEY,
EAX_PRESET_FOREST,
EAX_PRESET_CITY,
EAX_PRESET_MOUNTAINS,
EAX_PRESET_QUARRY,
EAX_PRESET_PLAIN,
EAX_PRESET_PARKINGLOT,
EAX_PRESET_SEWERPIPE,
EAX_PRESET_UNDERWATER,
EAX_PRESET_DRUGGED,
EAX_PRESET_DIZZY,
EAX_PRESET_PSYCHOTIC.
When using multiple devices, the current thread's device setting (as set with BASS_SetDevice) determines which device this function call applies to.
Platform-specific
This function is only available on Windows.Example
Use the EAX_PRESET_ARENA preset.BASS_SetEAXParameters(EAX_PRESET_ARENA);