Lumberyard
User Guide (Version 1.16)

Audio Environment

Component entity system is in preview release and is subject to change.

The Audio Environment component provides access to features of the Audio Translation Layer (ATL) environments. Environments are used to apply environmental effects such as reverb or echo.

Audio Environment Properties

The Audio Environment component has the following property:

Default Environment

Enter the name of the audio environment to use by default when setting amounts.

EBus Request Bus Interface

Use the following request functions with the EBus interface to communicate with other components of your game.

For more information about using the Event Bus (EBus) interface, see Working with the Event Bus (EBus) System.

SetAmount

Sets the amount of environmental 'send' to apply to the default environment, if set.

Parameters

amount – Float value of the amount to set

Return

None

Scriptable

Yes

SetEnvironmentAmount

Sets the amount of environmental 'send' to apply to the specified environment.

Parameters

environmentName – Name of ATL Environment to set an amount on

amount – Float value of the amount to set

Return

None

Scriptable

Yes