Skip to end of metadata
Go to start of metadata

Overview

Overview of the CVars available through the Audio Translation Layer (ATL).

CVar's

s_AudioEventPoolSize

Sets the number of pre-allocated Audio Events.

  • Usage: s_AudioEventPoolSize [0/...]
  • Default values
    • 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_AudioPrimaryPoolSize

Specifies the size (in KiB) of the memory pool to be used by the ATL.

  • Usage: s_AudioPrimaryPoolSize[0/...]
  • Default: 8192 (8 MiB)

s_AudioObjectsDebugFilter

Allows for filtered display of Audio Objects by a search string.

  • Usage: s_AudioObjectsDebugFilter spaceship
  • Default: "" (all)
Icon

This CVar was removed in release version 5.5.

s_AudioObjectPoolSize

Sets the number of pre-allocated Audio Objects and corresponding audio proxies.

  • Usage: s_AudioObjectPoolSize [0/...]
  • Default values
    • PC: 512
    • XboxOne: 512
    • PS4: 512
    • MAC: 512
    • Linux: 512
    • WiiU: 256
    • iOS: 128
    • Android: 128

s_AudioObjectsRayType

Can override AudioObjects' obstruction/occlusion ray type on a global scale.
If set it determines whether AudioObjects use no, single or multi rays.
This is a performance type CVar and can be used to turn audio ray casting globally off or force it on every Audio Object to a given mode.

  • Usage: s_AudioObjectsRayType [0/1/2/3]
    0: Audio Object specific ray casting.
    1: All AudioObjects ignore ray casting.
    2: All AudioObjects use single ray casting.
    3: All AudioObjects use multi ray casting.
  • Default values
    • PC: 0
    • XboxOne: 0
    • PS4: 0
    • Mac: 0
    • Linux: 0
    • iOS: 0
    • Android: 0

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 AudioProxy will have a greatly reduced impact on the calling thread.
Be aware though that when set to initialize asynchronously, audio will play back delayed. By how much will greatly depend on the audio thread's workload.

  • Usage: s_AudioProxiesInitType [0/1/2]
    0: AudioProxy specific initialization.
    1: All AudioProxies initialize synchronously.
    2: All AudioProxies initialize asynchronously.
  • Default values
    • PC: 0
    • XboxOne: 0
    • PS4: 0
    • MAC: 0
    • Linux: 0
    • WiiU: 0
    • iOS: 0
    • Android: 0

s_AudioStandaloneFilePoolSize 

Sets the number of pre-allocated audio standalone files.

  • Usage: s_AudioStandaloneFilePoolSize [0/...]
  • Default values
    • PC: 0
    • XboxOne: 0
    • PS4: 0
    • Mac: 0
    • Linux: 0
    • iOS: 0
    • Android: 0

s_AudioImplName

Holds the name of the audio implementation library to be used.

  • Usage: s_AudioImplName <name of the library without extension>
  • Default: CryAudioImplSDLMixer

s_AudioTriggersDebugFilter

Allows for filtered display of audio triggers by a search string.

  • Usage: s_AudioTriggersDebugFilter laser ("laser" being an example here)
  • Default: "" (all)

    Icon

    This CVar was removed in release version 5.5.

s_DebugDistance

Limits drawing of audio object debug info to the specified distance around the active listeners. Setting this cvar to 0 disables the limiting.

  •  Usage: s_DebugDistance [0/...]
  •  Default: 0 m (infinite)

 

Icon

This CVar was added in release version 5.5.

s_DebugFilter

Allows for filtered display of audio debug info by a search string.

  •  Usage: s_DebugFilter spaceship
  • Default: " " (all)

 

Icon

This CVar was added in release version 5.5.

s_DefaultStandaloneFilesAudioTrigger

The name of the ATL AudioTrigger which is used for playing back standalone files, when you call 'PlayFile' without specifying an override audioTriggerId that should be used instead.

  • Usage: s_DefaultStandaloneFilesAudioTrigger audio_trigger_name.
    If you change this CVar to be empty, the control will not be created automatically.
  • Default: "do_nothing"

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

Icon
  • 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.
  • Reddish = 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).
Icon

In release 5.5, some of the flags have changed. See below for the most up to date overview:

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 Parameter values for active audio objects.

f: Show Environment amounts for active audio objects.

g: shows the object distance.

i: Draw occlusion rays.

j: Show object standalone files.

m: Hide audio system memory info.

n: apply filter also to inactive object debug info.

u: List standalone files.

v: List active Events.

w: List active Audio Objects.

x: Show FileCache Manager debug info.

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 value: 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 values
    • 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_OcclusionHighDistance

Within this distance occlusion calculation uses the most sample points for highest granularity.

  • Usage: s_OcclusionHighDistance [0/...]
  • Default: 10 m 

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_OcclusionMediumDistance

Between end of high and this distance occlusion calculation uses a medium amount of sample points for medium granularity.

  • Usage: s_OcclusionMediumDistance [0/...]
  • Default: 80 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_OcclusionRayLengthOffset

A physics ray cast between audio listener and audio object stops at this distance before it hits the audio object.
Effectively forming a bubble of this radius around the audio object where occlusion is ignored.

  • Usage: s_OcclusionRayLengthOffset [0/...]
  • Default: 0.1 (10 cm) 

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_SetParameter

Sets an Audio Parameter value.

The first argument is the name of the AudioParameter to be set, the second argument is the float value to be set, the third argument is an optional AudioObject ID.

If the third argument is provided, the Parameter is set on the AudioObject with the given ID, otherwise, the AudioParameter is set on the GlobalAudioObject

  • Usage: s_SetParameter character_speed  0.0  601 or s_SetParameter volume_music 1.0
Icon

The name of this CVar was changed in 5.5 from s_SetRTPC to s_SetParameter.

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_HideInactiveAudioObjects

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 audio triggers.

  • Usage: s_HideInactiveAudioObjects [0/1]
  • Default: 1
Icon

The name of this CVar was changed in 5.5 from s_ShowActiveAudioObjectsOnly to s_HideInactiveAudioObjects.


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_TickWithMainThread

Sets whether work on the audio thread is done in sync with the main thread or on its own pace.

  • Usage: s_TickWithMainThread [0/1]
  • Default value PC: 0 

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)
  • No labels