This documentation is for a prerelease version of O3DE. Click here to switch to the latest release, or select a version from the dropdown.

Version:

Audio Preload Component

Using the Audio Preload component, you can load and unload ATL preloads, which contain references to soundbanks. You can specify the loading type as automatic or manual. The automatic loading type means that preloads load when the component activates and unloads when it deactivates. The manual loading type means the component does not take any action until the user makes a request.

Audio Preload Properties

The Audio Preload component has the following properties:

Preload Name Name of the default ATL Preload that this component loads or unloads. Modify this property to define a custom default ATL preload. Default: Blank

Load Type Set to Auto or Manual. If set to Auto, preloads load when component activates and unload when component deactivates. If set to Manual, preloads load and unload only when the user makes the request to the interface. Default: Auto

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.

Load

NameLoad
DescriptionLoads the default ATL preload (if it is set)
ParametersNone
ReturnNone
ScriptableYes

Load

NameUnload
DescriptionUnloads the default ATL preload (if it is set)
ParametersNone
ReturnNone
ScriptableYes

Load

NameLoadPreload
DescriptionLoads an ATL preload by name
ParameterspreloadName Name of an ATL Preload to load
ReturnNone
ScriptableYes

Load

NameUnloadPreload
DescriptionUnloads an ATL preload by name
ParameterspreloadName Name of an ATL Preload to unload
ReturnNone
ScriptableYes

Load

NameIsLoaded
DescriptionReturns whether this component has loaded an ATL preload
ParameterspreloadName Name of an ATL Preload to check
Returnbool True if this component has already loaded the specified preload, false otherwise
ScriptableYes