ATL Console Commands

Overview

Overview of the CVar's available through the Audio Translation Layer (ATL).

CVar's

s_ATLPoolSize

Specifies the size (in KiB) of the memory pool to be used by the ATL.
Usage: s_ATLPoolSize [0/...]
Default: 8192 (8 MiB)

s_AudioEventPoolSize

Sets the number of preallocated audio events.
Usage: s_AudioEventPoolSize [0/...]
Default PC: 256, XboxOne: 256, PS4: 256, MAC: 256, Linux: 256, WiiU: 128 IOS: 64 Android: 64

s_AudioLoggingOptions

Toggles the logging of audio related messages.
Usage: s_AudioLoggingOptions [0ab...] (flags can be combined)
Default: 0 (logging disabled)
a: Errors
b: Warnings
c: Comments

s_AudioObjectsDebugFilter

Allows for filtered display of audio objects by a search string.
Usage: s_AudioObjectsDebugFilter spaceship.
Default: "" (all)

s_AudioObjectPoolSize

Sets the number of preallocated audio objects and corresponding audio proxies.
Usage: s_AudioObjectPoolSize [0/...]
Default PC: 512, XboxOne: 512, PS4: 512, MAC: 512, Linux: 512, WiiU: 256 IOS: 128 Android: 128

s_AudioProxiesInitType

Can override AudioProxies' init type on a global scale.
If set it determines whether AudioProxies initialize synchronously or asynchronously.
This is a performance type cvar as asynchronously initializing AudioProxies
will have a greatly reduced impact on the calling thread.
Be aware though that when set to initialize asynchronously that audio will play back delayed.
By how much will greatly depend on the audio thread's work load.
0: AudioProxy specific initialization.
1: All AudioProxies initialize synchronously.
2: All AudioProxies initialize asynchronously.
Usage: s_AudioProxiesInitType [0/1/2]
Default PC: 0, XboxOne: 0, PS4: 0, MAC: 0, Linux: 0, WiiU: 0 iOS: 0 Android: 0

s_AudioStandaloneFilePoolSize

Sets the number of preallocated audio standalone files.
Usage: s_AudioStandaloneFilePoolSize [0/...]
Default PC: 0, XboxOne: 0, PS4: 0, Mac: 0, Linux: 0, iOS: 0, Android: 0

s_AudioSystemImplementationName

Holds the name of the AudioSystemImplementation library to be used without extension.
Usage: s_AudioSystemImplementationName <Name of the audio system implementation library>
Default: CryAudioImplWwise

s_AudioTriggersDebugFilter

Allows for filtered display of audio triggers by a search string.
Usage: s_AudioTriggersDebugFilter laser
Default: "" (all)

s_DrawAudioDebug

Draws AudioTranslationLayer related debug data to the screen.
Usage: s_DrawAudioDebug [0ab...] (flags can be combined)
0: No audio debug info on the screen.
a: Draw spheres around active audio objects.
b: Show text labels for active audio objects.
c: Show trigger names for active audio objects.
d: Show current states for active audio objects.
e: Show RTPC values for active audio objects.
f: Show Environment amounts for active audio objects.
g: Draw occlusion rays.
h: Show occlusion ray labels.
v: List active Events.
w: List active Audio Objects.
x: Show FileCache Manager debug info.

FileCache Manger debug Color Coding
  • Cyan = Globals.
  • Yellow = Level Specifics.
  • Blue = The file failed loading due to OOM (out of memory).
  • Red = The file is currently in the process of caching.
  • Redish = The file was not found.
  • White = This file is not referenced and will be automatically removed once its memory is needed (non-auto-load entries only).

s_ExecuteTrigger

Executes an Audio Trigger.
The first argument is the name of the ATL Audio Trigger to be executed, the second argument is an optional Audio Object ID.
If the second argument is provided, the Audio Trigger is executed on the Audio Object with the given ID, otherwise, the Audio Trigger is executed on the Global Audio Object.
Usage: s_ExecuteTrigger <Audio Trigger Name> [<Optional Audio Object ID>]

s_FileCacheManagerDebugFilter

Allows for filtered display of the different AFCM entries such as Globals, Level Specifics and Volatiles.
Usage: s_FileCacheManagerDebugFilter [0ab...] (flags can be combined)
Default: 0 (all)
a: Globals
b: Level Specifics
c: Volatiles

s_FileCacheManagerSize

Sets the size in KiB the AFCM will allocate on the heap.
Usage: s_FileCacheManagerSize [0/...]
Default PC: 393216 (384 MiB), XboxOne: 393216 (384 MiB), PS4: 393216 (384 MiB), MAC: 393216 (384 MiB), Linux: 393216 (384 MiB), WiiU: 131072 (128 MiB)

s_FullObstructionMaxDistance

For the sounds, whose distance to the listener is greater than this value, the obstruction value gets attenuated with distance.
Usage: s_FullObstructionMaxDistance [0..]
Default: 5 m

s_IgnoreWindowFocus

If set to 1, the sound system will continue playing when the Editor or Game window loses focus.
Usage: s_IgnoreWindowFocus [0/1]
Default: 0 (off)

s_OcclusionMaxDistance

Obstruction/Occlusion is not calculated for the sounds, whose distance to the listener is greater than this value. Setting this value to 0 disables obstruction/occlusion calculations.
Usage: s_OcclusionMaxDistance [0..]
Default: 500 m

s_OcclusionMaxSyncDistance

Physics rays are processed synchronously for the sounds that are closer to the listener than this value, and asynchronously for the rest (possible performance optimization).
Usage: s_OcclusionMaxSyncDistance [0..]
Default: 10 m

s_PositionUpdateThreshold

An audio object has to move by at least this amount to issue a position update request to the audio system.
This kind of optimization should ideally be done by the parent system so this is here for convenience.
Usage: s_PositionUpdateThreshold [0/...]
Default: 0.1 (10 cm)

s_SetRtpc

Sets an Audio Rtpc value.
The first argument is the name of the ATL Audio Rtpc, the second argument is the float value to be set, the third argument is an optional Audio Object ID.
If the third argument is provided, the Audio Rtpc is set on the Audio Object with the given ID, otherwise, the Audio Rtpc is set on the Global Audio Object.
Usage: s_SetRtpc <Audio Rtpc Name> <Float Value> [<Optional Audio Object ID>]

s_SetSwitchState

Sets an Audio Switch to a provided State.
The first argument is the name of the ATL Audio Switch, the second argument is the name of the Switch State to be set, the third argument is an optional Audio Object ID.
If the third argument is provided, the Audio Switch is set on the Audio Object with the given ID, otherwise, the Audio Switch is set on the Global Audio Object.
Usage: s_SetSwitchState <Audio Switch Name> <Switch State Name> [<Optional Audio Object ID>]

s_ShowActiveAudioObjectsOnly

When drawing audio object names on the screen this cvar can be used to choose between all registered audio objects or only those that reference active audiotriggers.
Usage: s_ShowActiveAudioObjectsOnly [0/1]\n" "Default: 1 (active only)

s_StopTrigger

Stops an Audio Trigger.
The first argument is the name of the ATL Audio Trigger to be stopped, the second argument is an optional Audio Object ID.
If the second argument is provided, the Audio Trigger is stopped on the Audio Object with the given ID, otherwise, the Audio Trigger is stopped on the Global Audio Object.
Usage: s_StopTrigger <Audio Trigger Name> [<Optional Audio Object ID>]

s_VelocityTrackingThreshold

An audio object has to change its velocity by at least this amount to issue an "object_speed" RTPC update request to the audio system.
Usage: s_VelocityTrackingThreshold [0/...]
Default: 0.1 (10 cm/s)