Version
menu

Wwise SDK 2025.1.0
AkConstants.h File Reference

Go to the source code of this file.

Macros

#define AK_MAX_LANGUAGE_NAME_SIZE   (32)
 
#define AKCOMPANYID_PLUGINDEV_MIN   (64)
 
#define AKCOMPANYID_PLUGINDEV_MAX   (255)
 
#define AKCOMPANYID_AUDIOKINETIC   (0)
 Audiokinetic inc. More...
 
#define AKCOMPANYID_AUDIOKINETIC_EXTERNAL   (1)
 Audiokinetic inc. More...
 
#define AKCOMPANYID_MCDSP   (256)
 McDSP. More...
 
#define AKCOMPANYID_WAVEARTS   (257)
 WaveArts. More...
 
#define AKCOMPANYID_PHONETICARTS   (258)
 Phonetic Arts. More...
 
#define AKCOMPANYID_IZOTOPE   (259)
 iZotope More...
 
#define AKCOMPANYID_CRANKCASEAUDIO   (261)
 Crankcase Audio. More...
 
#define AKCOMPANYID_IOSONO   (262)
 IOSONO. More...
 
#define AKCOMPANYID_AUROTECHNOLOGIES   (263)
 Auro Technologies. More...
 
#define AKCOMPANYID_DOLBY   (264)
 Dolby. More...
 
#define AKCOMPANYID_TWOBIGEARS   (265)
 Two Big Ears. More...
 
#define AKCOMPANYID_OCULUS   (266)
 Oculus. More...
 
#define AKCOMPANYID_BLUERIPPLESOUND   (267)
 Blue Ripple Sound. More...
 
#define AKCOMPANYID_ENZIEN   (268)
 Enzien Audio. More...
 
#define AKCOMPANYID_KROTOS   (269)
 Krotos (Dehumanizer) More...
 
#define AKCOMPANYID_NURULIZE   (270)
 Nurulize. More...
 
#define AKCOMPANYID_SUPERPOWERED   (271)
 Super Powered. More...
 
#define AKCOMPANYID_GOOGLE   (272)
 Google. More...
 
#define AKCOMPANYID_VISISONICS   (277)
 Visisonics. More...
 
#define AKCODECID_BANK   (0)
 Bank encoding. More...
 
#define AKCODECID_PCM   (1)
 PCM encoding. More...
 
#define AKCODECID_ADPCM   (2)
 ADPCM encoding. More...
 
#define AKCODECID_XMA   (3)
 XMA encoding. More...
 
#define AKCODECID_VORBIS   (4)
 Vorbis encoding. More...
 
#define AKCODECID_WIIADPCM   (5)
 ADPCM encoding on the Wii. More...
 
#define AKCODECID_PCM_WAV   (7)
 Standard PCM WAV file parser. More...
 
#define AKCODECID_EXTERNAL_SOURCE   (8)
 External Source (unknown encoding) More...
 
#define AKCODECID_XWMA   (9)
 xWMA encoding More...
 
#define AKCODECID_FILE_PACKAGE   (11)
 File package files generated by the File Packager utility. More...
 
#define AKCODECID_ATRAC9   (12)
 ATRAC-9 encoding. More...
 
#define AKCODECID_VAG   (13)
 VAG/HE-VAG encoding. More...
 
#define AKCODECID_PROFILERCAPTURE   (14)
 Profiler capture file (.prof) as written through AK::SoundEngine::StartProfilerCapture. More...
 
#define AKCODECID_ANALYSISFILE   (15)
 Analysis file. More...
 
#define AKCODECID_MIDI   (16)
 MIDI file. More...
 
#define AKCODECID_OPUSNX   (17)
 OpusNX encoding. More...
 
#define AKCODECID_CAF   (18)
 CAF file. More...
 
#define AKCODECID_AKOPUS   (19)
 Opus encoding, 2018.1 to 2019.2. More...
 
#define AKCODECID_AKOPUS_WEM   (20)
 Opus encoding, wrapped in WEM. More...
 
#define AKCODECID_MEMORYMGR_DUMP   (21)
 Memory stats file as written through AK::MemoryMgr::DumpToFile();. More...
 
#define AKCODECID_SONY360   (22)
 Sony 360 encoding. More...
 
#define AKCODECID_BANK_EVENT   (30)
 Bank encoding for event banks. These banks are contained in the /event sub-folder. More...
 
#define AKCODECID_BANK_BUS   (31)
 Bank encoding for bus banks. These banks are contained in the /bus sub-folder. More...
 
#define AKPLUGINID_RECORDER   (132)
 Recorder Plugin. More...
 
#define AKPLUGINID_IMPACTER   (184)
 Impacter Plugin. More...
 
#define AKPLUGINID_SYSTEM_OUTPUT_META   (900)
 System output metadata. More...
 
#define AKPLUGINID_AUDIO_OBJECT_ATTENUATION_META   (901)
 Attenuation curve metadata. More...
 
#define AKPLUGINID_AUDIO_OBJECT_PRIORITY_META   (902)
 Audio object priority metadata. More...
 
#define AKEXTENSIONID_SPATIALAUDIO   (800)
 Spatial Audio. More...
 
#define AKEXTENSIONID_INTERACTIVEMUSIC   (801)
 Interactive Music. More...
 
#define AKEXTENSIONID_MIDIDEVICEMGR   (802)
 MIDI Device Manager (Authoring) More...
 
#define AK_WAVE_FORMAT_VAG   0xFFFB
 
#define AK_WAVE_FORMAT_AT9   0xFFFC
 
#define AK_WAVE_FORMAT_VORBIS   0xFFFF
 
#define AK_WAVE_FORMAT_OPUSNX   0x3039
 
#define AK_WAVE_FORMAT_OPUS   0x3040
 
#define AK_WAVE_FORMAT_OPUS_WEM   0x3041
 
#define AK_WAVE_FORMAT_XMA2   0x166
 
#define AK_INVALID_SAMPLE_POS   0xFFFFFFFF
 

Variables

static const AkPluginID AK_INVALID_PLUGINID = (AkPluginID)-1
 Invalid FX ID. More...
 
static const AkPluginID AK_INVALID_SHARE_SET_ID = (AkPluginID)-1
 Invalid Share Set ID. More...
 
static const AkGameObjectID AK_INVALID_GAME_OBJECT = (AkGameObjectID)-1
 Invalid game object (may also mean all game objects) More...
 
static const AkUniqueID AK_INVALID_UNIQUE_ID = 0
 Invalid unique 32-bit ID. More...
 
static const AkRtpcID AK_INVALID_RTPC_ID = 0
 Invalid RTPC ID. More...
 
static const AkPlayingID AK_INVALID_PLAYING_ID = 0
 Invalid playing ID. More...
 
static const AkUInt32 AK_DEFAULT_SWITCH_STATE = 0
 Switch selected if no switch has been set yet. More...
 
static const AkMemPoolId AK_INVALID_POOL_ID = -1
 Invalid pool ID. More...
 
static const AkMemPoolId AK_DEFAULT_POOL_ID = -1
 Default pool ID, same as AK_INVALID_POOL_ID. More...
 
static const AkAuxBusID AK_INVALID_AUX_ID = 0
 Invalid auxiliary bus ID (or no Aux bus ID) More...
 
static const AkFileID AK_INVALID_FILE_ID = (AkFileID)-1
 Invalid file ID. More...
 
static const AkCacheID AK_INVALID_CACHE_ID = (AkCacheID)-1
 Invalid cache ID. More...
 
static const AkDeviceID AK_INVALID_DEVICE_ID = (AkDeviceID)-1
 Invalid streaming device ID. More...
 
static const AkBankID AK_INVALID_BANK_ID = 0
 Invalid bank ID. More...
 
static const AkArgumentValueID AK_FALLBACK_ARGUMENTVALUE_ID = 0
 Fallback argument value ID. More...
 
static const AkChannelMask AK_INVALID_CHANNELMASK = 0
 Invalid channel mask. More...
 
static const AkUInt32 AK_INVALID_OUTPUT_DEVICE_ID = 0
 Invalid Device ID. More...
 
static const AkPipelineID AK_INVALID_PIPELINE_ID = 0
 Invalid pipeline ID (for profiling) More...
 
static const AkAudioObjectID AK_INVALID_AUDIO_OBJECT_ID = (AkAudioObjectID)-1
 Invalid audio object ID. More...
 
static const AkGameObjectID AK_TRANSPORT_GAME_OBJECT = (AkGameObjectID)(-2)
 Game object ID used by Wwise Authoring when playing back sounds using the Transport view. More...
 
static const AkGameObjectID AK_DIRECT_GAME_OBJECT = (AkGameObjectID)(-3)
 Game object ID used by Wwise Authoring when playing back sounds directly using the transport or media pool. More...
 
static const AkPriority AK_DEFAULT_PRIORITY = 50
 Default sound / I/O priority. More...
 
static const AkPriority AK_MIN_PRIORITY = 0
 Minimal priority value [0,100]. More...
 
static const AkPriority AK_MAX_PRIORITY = 100
 Maximal priority value [0,100]. More...
 
static const AkPriority AK_DEFAULT_BANK_IO_PRIORITY = 50
 Default bank load I/O priority. More...
 
static const AkReal32 AK_DEFAULT_BANK_THROUGHPUT = 1 * 1024 * 1024 / 1000.f
 Default bank load throughput (1 Mb/ms) More...
 
static const AkUInt32 AK_SOUNDBANK_VERSION = 168
 Version of the soundbank reader (update AkBanks.h as well) More...
 
static const AkJobType AkJobType_Generic = 0
 Job type for general-purpose work. More...
 
static const AkJobType AkJobType_AudioProcessing = 1
 Job type for DSP work. More...
 
static const AkJobType AkJobType_SpatialAudio = 2
 Job type for Spatial Audio computations. More...
 
static const AkUInt32 AK_NUM_JOB_TYPES = 3
 Number of possible job types recognized by the Sound Engine. More...
 

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise