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 component

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


Copyright © 2022 Open 3D Engine Contributors

Documentation Distributed under CC BY 4.0.
For our trademark, privacy and antitrust policies, code of conduct, and terms of use, please click the applicable link below or see https://www.lfprojects.org.


The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Policy page.