The following is a list of Console commands that apply to the Audio system in general.
For console commands related to Wwise and FMOD Studio, see Wwise Console Commands and FMOD Console Commands.
Activates a Context.
This CVar also loads the meta data and auto-loaded preload requests of that Context. The argument accepted by it is the name of the Context to activate.
Usage: s_ActivateContext intro
Allows for filtered display of Audio Objects by a search string.
This CVar was removed in release version 5.5.
Allows for filtered display of audio triggers by a search string.
Default: "" (all)
This CVar was removed in release version 5.5.
Deactivates a Context.
This CVar also unloads the meta data and auto-loaded preload requests of that Context. The argument accepted by it is the name of the Context to deactivate.
Usage: s_DeactivateContext intro
Limits drawing of audio object debug information to the specified distance around the active listeners. Setting this Cvar to 0 disables the limiting.
This CVar was added in release version 5.5.
Allows for filtered display of audio debug info by a search string.
This CVar was added in release version 5.5.
Draws audio system related debug data on the screen.
0: No audio debug info on the screen.
a: Draw spheres around active audio objects.
b: Draw text labels for active audio objects.
c: Draw trigger names for active audio objects.
d: Draw current states for active audio objects.
e: Draw Parameter values for active audio objects.
f: Draw Environment amounts for active audio objects.
g: Draw distance to listener for active audio objects.
h: Draw occlusion ray labels.
i: Draw occlusion rays.
j: Draw spheres with occlusion ray offset radius around active audio objects.
k: Draw listener occlusion plane.
l: Draw occlusion collision spheres.
m: Draw global object info.
n: Draw middleware specific info for active audio objects.
q: Hide audio system memory info.
r: Apply filter also to inactive object debug info.
s: Draw detailed memory pool debug info.
u: List Contexts.
v: List active Events.
w: List active Audio Objects.
x: Draw FileCache Manager debug info.
y: Draw Request debug info.
Color | Description |
|---|---|
Cyan | File is removable. |
Grey | File is not cached. |
Lime green | Global scope. |
Orange red | File is loading. |
Red | File not found. |
Violet red | File memory allocation failed. |
Yellow | Level specific scope. |
The list of s_DrawDebug's flags prior to CRYENGINE 5.5 were as follows:
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.
These flags were subsequently changed on release 5.5 to:
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.
Executes an Audio Trigger.
The argument is the name of the trigger to be executed on the Global Object.
Allows for filtered display of the different AFCM entries such as Globals, Level Specifics, Game Hints and so on.
Usage:s_FileCacheManagerDebugFilter [0ab...] (flags can be combined)
Default value: 0 (all)
a: Globals
b: Level Specifics
c: Game Hints
Sets the size in KiB the AFCM will allocate on the heap.
Usage: s_FileCacheManagerSize [0/...]
Default value for Xbox One: 393216 (384 MiB)
The s_FileCacheManagerSize Cvar is exclusive to Xbox One.
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.
In Engine release 5.5, the name of this CVar was changed from s_ShowActiveAudioObjectsOnly to s_HideInactiveAudioObjects.
Defines which audio middleware implementation (SDLMixer, FMOD Studio or Wwise) is loaded by CRYENGINE's audio system.
If set to 1, the audio system will not execute the lose_focus and get_focus default triggers when the application window focus changes.
Usage: s_IgnoreWindowFocus [0/1]
Default: 0 (off)
Loads a preload request. The preload request has to be non-autoloaded. The argument is the name of the preload request to load.
Loads a setting. The argument is the name of the setting to load.
Toggles the logging of audio related messages.
Sets the number of pre-allocated audio objects and corresponding audio proxies.
In Engine release 5.6, the name of this CVar was changed from s_AudioObjectPoolSize to s_ObjectPoolSize.
Sets whether occlusion values encountered by a ray cast will be accumulated or only the highest value will be used.
Can override audio objects' obstruction/occlusion ray type on a global scale. If set it determines whether audio objects use no, adaptive, low, medium or high granularity for rays.
This is a performance type CVar and can be used to turn off audio ray casting globally or force different modes of audio raycasting on all audio objects.
Within this distance occlusion calculation uses the most sample points for highest granularity.
Sets the ray cast mode of the initial occlusion check when a trigger gets executed.
Sets the size of the plane at listener position against which occlusion is calculated.
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.
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).
Sets the occlusion medium distance. Medium occlusion calculation is done between the occlusion medium distance and high distance, using a medium amount of sample points for medium granularity.
If set to 1, the occlusion value will be set to 1 (max) when a ray cast reaches its max hit limit.
Defines how pool sizes for audio controls are accumulated.
Pool sizes are determined by the amount of controls that exist in a Context.
Usage: s_PoolAllocationMode [0/...]
0: Accumulate pool sizes of all Contexts.
1: Accumulate pool sizes of the global Context, and the largest pool size for each control in any other Context.
The value 1 may be used if at most one other Context besides the global Context is active.
Refreshes the audio system.
Sets an Audio Parameter value.
The first argument is the name of the parameter to be set, and the second argument is the float value to be set. The parameter is set on the Global Object.
The name of this CVar was changed in 5.5 from s_SetRTPC to s_SetParameter.
Sets an Audio Parameter value.
The first argument is the name of the parameter to be set, and the second argument is the float value to be set. The parameter is set on all constructed objects.
Sets an Audio Switch to a provided State.
The first argument is the name of the switch, and the second argument is the name of the state to be set. The switch state is set on the Global Object.
Sets an Audio Switch to a provided State.
The first argument is the name of the switch, and the second argument is the name of the state to be set. The switch state is set on all constructed objects.
Stops an Audio Trigger.
The argument is the name of the trigger to be stopped on the Global Object. If no argument is provided, all playing triggers on the Global Object get stopped.
Sets the number of preallocated trigger instances.
Unloads a preload request. The preload request has to be non-autoloaded. The argument is the name of the preload request to load.
Unloads a setting.