Version:

Audio Environment Component

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

NameDescriptionDefault
Default EnvironmentEnter the name of the audio environment to use by default when setting amounts.<Empty>

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.

NameDescriptionParametersReturnScriptable
SetAmountSets the amount of environmental ‘send’ to apply to the default environment, if set.amount - Float value of the amount to setNoneYes
SetEnvironmentAmountSets the amount of environmental ‘send’ to apply to the specified environment.environmentName - Name of ATL Environment to set an amount on; amount - Float value of the amount to setNoneYes