バージョン
menu
Wwise SDK 2025.1.0
AkConstants.h
[詳解]
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Copyright (c) 2025 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 #pragma once
28 
29 #include <AK/SoundEngine/Common/AkTypedefs.h>
30 
31 static const AkPluginID AK_INVALID_PLUGINID = (AkPluginID)-1; ///< Invalid FX ID
32 static const AkPluginID AK_INVALID_SHARE_SET_ID = (AkPluginID)-1; ///< Invalid Share Set ID
33 static const AkGameObjectID AK_INVALID_GAME_OBJECT = (AkGameObjectID)-1; ///< Invalid game object (may also mean all game objects)
34 static const AkUniqueID AK_INVALID_UNIQUE_ID = 0; ///< Invalid unique 32-bit ID
35 static const AkRtpcID AK_INVALID_RTPC_ID = 0; ///< Invalid RTPC ID
36 static const AkPlayingID AK_INVALID_PLAYING_ID = 0; ///< Invalid playing ID
37 static const AkUInt32 AK_DEFAULT_SWITCH_STATE = 0; ///< Switch selected if no switch has been set yet
38 static const AkMemPoolId AK_INVALID_POOL_ID = -1; ///< Invalid pool ID
39 static const AkMemPoolId AK_DEFAULT_POOL_ID = -1; ///< Default pool ID, same as AK_INVALID_POOL_ID
40 static const AkAuxBusID AK_INVALID_AUX_ID = 0; ///< Invalid auxiliary bus ID (or no Aux bus ID)
41 static const AkFileID AK_INVALID_FILE_ID = (AkFileID)-1; ///< Invalid file ID
42 static const AkCacheID AK_INVALID_CACHE_ID = (AkCacheID)-1; ///< Invalid cache ID
43 static const AkDeviceID AK_INVALID_DEVICE_ID = (AkDeviceID)-1; ///< Invalid streaming device ID
44 static const AkBankID AK_INVALID_BANK_ID = 0; ///< Invalid bank ID
45 static const AkArgumentValueID AK_FALLBACK_ARGUMENTVALUE_ID = 0; ///< Fallback argument value ID
46 static const AkChannelMask AK_INVALID_CHANNELMASK = 0; ///< Invalid channel mask
47 static const AkUInt32 AK_INVALID_OUTPUT_DEVICE_ID = 0; ///< Invalid Device ID
48 static const AkPipelineID AK_INVALID_PIPELINE_ID = 0; ///< Invalid pipeline ID (for profiling)
49 static const AkAudioObjectID AK_INVALID_AUDIO_OBJECT_ID = (AkAudioObjectID)-1; ///< Invalid audio object ID
50 
51 static const AkGameObjectID AK_TRANSPORT_GAME_OBJECT = (AkGameObjectID)(-2); ///< Game object ID used by Wwise Authoring when playing back sounds using the Transport view.
52 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.
53 
54 // Priority.
55 static const AkPriority AK_DEFAULT_PRIORITY = 50; ///< Default sound / I/O priority
56 static const AkPriority AK_MIN_PRIORITY = 0; ///< Minimal priority value [0,100]
57 static const AkPriority AK_MAX_PRIORITY = 100; ///< Maximal priority value [0,100]
58 
59 // Default bank I/O settings.
60 static const AkPriority AK_DEFAULT_BANK_IO_PRIORITY = 50; ///< Default bank load I/O priority
61 static const AkReal32 AK_DEFAULT_BANK_THROUGHPUT = 1 * 1024 * 1024 / 1000.f; ///< Default bank load throughput (1 Mb/ms)
62 
63 // Bank version
64 static const AkUInt32 AK_SOUNDBANK_VERSION = 168; ///< Version of the soundbank reader (update AkBanks.h as well)
65 
66 // Job types
67 static const AkJobType AkJobType_Generic = 0; ///< Job type for general-purpose work
68 static const AkJobType AkJobType_AudioProcessing = 1; ///< Job type for DSP work
69 static const AkJobType AkJobType_SpatialAudio = 2; ///< Job type for Spatial Audio computations
70 static const AkUInt32 AK_NUM_JOB_TYPES = 3; ///< Number of possible job types recognized by the Sound Engine
71 
72 // ---------------------------------------------------------------
73 // Languages
74 // ---------------------------------------------------------------
75 #define AK_MAX_LANGUAGE_NAME_SIZE (32)
76 
77 // ---------------------------------------------------------------
78 // File Type ID Definitions
79 // ---------------------------------------------------------------
80 
81 // These correspond to IDs specified in the conversion plug-ins' XML
82 // files. Audio sources persist them to "remember" their format.
83 // DO NOT CHANGE THEM without talking to someone in charge of persistence!
84 
85 // Company ID for plugin development.
86 #define AKCOMPANYID_PLUGINDEV_MIN (64)
87 #define AKCOMPANYID_PLUGINDEV_MAX (255)
88 
89 // Vendor ID.
90 #define AKCOMPANYID_AUDIOKINETIC (0) ///< Audiokinetic inc.
91 #define AKCOMPANYID_AUDIOKINETIC_EXTERNAL (1) ///< Audiokinetic inc.
92 #define AKCOMPANYID_MCDSP (256) ///< McDSP
93 #define AKCOMPANYID_WAVEARTS (257) ///< WaveArts
94 #define AKCOMPANYID_PHONETICARTS (258) ///< Phonetic Arts
95 #define AKCOMPANYID_IZOTOPE (259) ///< iZotope
96 #define AKCOMPANYID_CRANKCASEAUDIO (261) ///< Crankcase Audio
97 #define AKCOMPANYID_IOSONO (262) ///< IOSONO
98 #define AKCOMPANYID_AUROTECHNOLOGIES (263) ///< Auro Technologies
99 #define AKCOMPANYID_DOLBY (264) ///< Dolby
100 #define AKCOMPANYID_TWOBIGEARS (265) ///< Two Big Ears
101 #define AKCOMPANYID_OCULUS (266) ///< Oculus
102 #define AKCOMPANYID_BLUERIPPLESOUND (267) ///< Blue Ripple Sound
103 #define AKCOMPANYID_ENZIEN (268) ///< Enzien Audio
104 #define AKCOMPANYID_KROTOS (269) ///< Krotos (Dehumanizer)
105 #define AKCOMPANYID_NURULIZE (270) ///< Nurulize
106 #define AKCOMPANYID_SUPERPOWERED (271) ///< Super Powered
107 #define AKCOMPANYID_GOOGLE (272) ///< Google
108 //#define AKCOMPANYID_NVIDIA (273) ///< NVIDIA // Commented out to avoid redefinition, provider is already defining it.
109 //#define AKCOMPANYID_RESERVED (274) ///< Reserved // Commented out to avoid redefinition, provider is already defining it.
110 //#define AKCOMPANYID_MICROSOFT (275) ///< Microsoft // Commented out to avoid redefinition, provider is already defining it.
111 //#define AKCOMPANYID_YAMAHA (276) ///< YAMAHA // Commented out to avoid redefinition, provider is already defining it.
112 #define AKCOMPANYID_VISISONICS (277) ///< Visisonics
113 
114 // File/encoding types of Audiokinetic.
115 #define AKCODECID_BANK (0) ///< Bank encoding
116 #define AKCODECID_PCM (1) ///< PCM encoding
117 #define AKCODECID_ADPCM (2) ///< ADPCM encoding
118 #define AKCODECID_XMA (3) ///< XMA encoding
119 #define AKCODECID_VORBIS (4) ///< Vorbis encoding
120 #define AKCODECID_WIIADPCM (5) ///< ADPCM encoding on the Wii
121 #define AKCODECID_PCM_WAV (7) ///< Standard PCM WAV file parser
122 #define AKCODECID_EXTERNAL_SOURCE (8) ///< External Source (unknown encoding)
123 #define AKCODECID_XWMA (9) ///< xWMA encoding
124 #define AKCODECID_FILE_PACKAGE (11) ///< File package files generated by the File Packager utility.
125 #define AKCODECID_ATRAC9 (12) ///< ATRAC-9 encoding
126 #define AKCODECID_VAG (13) ///< VAG/HE-VAG encoding
127 #define AKCODECID_PROFILERCAPTURE (14) ///< Profiler capture file (.prof) as written through AK::SoundEngine::StartProfilerCapture
128 #define AKCODECID_ANALYSISFILE (15) ///< Analysis file
129 #define AKCODECID_MIDI (16) ///< MIDI file
130 #define AKCODECID_OPUSNX (17) ///< OpusNX encoding
131 #define AKCODECID_CAF (18) ///< CAF file
132 #define AKCODECID_AKOPUS (19) ///< Opus encoding, 2018.1 to 2019.2
133 #define AKCODECID_AKOPUS_WEM (20) ///< Opus encoding, wrapped in WEM
134 #define AKCODECID_MEMORYMGR_DUMP (21) ///< Memory stats file as written through AK::MemoryMgr::DumpToFile();
135 #define AKCODECID_SONY360 (22) ///< Sony 360 encoding
136 
137 #define AKCODECID_BANK_EVENT (30) ///< Bank encoding for event banks. These banks are contained in the /event sub-folder.
138 #define AKCODECID_BANK_BUS (31) ///< Bank encoding for bus banks. These banks are contained in the /bus sub-folder.
139 
140 #define AKPLUGINID_RECORDER (132) ///< Recorder Plugin
141 #define AKPLUGINID_IMPACTER (184) ///< Impacter Plugin
142 #define AKPLUGINID_SYSTEM_OUTPUT_META (900) ///< System output metadata
143 #define AKPLUGINID_AUDIO_OBJECT_ATTENUATION_META (901) ///< Attenuation curve metadata
144 #define AKPLUGINID_AUDIO_OBJECT_PRIORITY_META (902) ///< Audio object priority metadata
145 
146 #define AKEXTENSIONID_SPATIALAUDIO (800) ///< Spatial Audio
147 #define AKEXTENSIONID_INTERACTIVEMUSIC (801) ///< Interactive Music
148 #define AKEXTENSIONID_MIDIDEVICEMGR (802) ///< MIDI Device Manager (Authoring)
149 
150 //The following are internally defined
151 #define AK_WAVE_FORMAT_VAG 0xFFFB
152 #define AK_WAVE_FORMAT_AT9 0xFFFC
153 #define AK_WAVE_FORMAT_VORBIS 0xFFFF
154 #define AK_WAVE_FORMAT_OPUSNX 0x3039
155 #define AK_WAVE_FORMAT_OPUS 0x3040
156 #define AK_WAVE_FORMAT_OPUS_WEM 0x3041
157 #define AK_WAVE_FORMAT_XMA2 0x166
158 
159 #define AK_INVALID_SAMPLE_POS 0xFFFFFFFF
AK_DIRECT_GAME_OBJECT
static const AkGameObjectID AK_DIRECT_GAME_OBJECT
Game object ID used by Wwise Authoring when playing back sounds directly using the transport or media...
Definition: AkConstants.h:52
AkBankID
AkUInt32 AkBankID
Run time bank ID
Definition: AkTypedefs.h:62
AK_INVALID_OUTPUT_DEVICE_ID
static const AkUInt32 AK_INVALID_OUTPUT_DEVICE_ID
Invalid Device ID
Definition: AkConstants.h:47
AkJobType_AudioProcessing
static const AkJobType AkJobType_AudioProcessing
Job type for DSP work
Definition: AkConstants.h:68
AkJobType
AkUInt32 AkJobType
Job type identifier
Definition: AkTypedefs.h:76
AK_DEFAULT_SWITCH_STATE
static const AkUInt32 AK_DEFAULT_SWITCH_STATE
Switch selected if no switch has been set yet
Definition: AkConstants.h:37
AkGameObjectID
AkUInt64 AkGameObjectID
Game object ID
Definition: AkTypedefs.h:47
AK_INVALID_PIPELINE_ID
static const AkPipelineID AK_INVALID_PIPELINE_ID
Invalid pipeline ID (for profiling)
Definition: AkConstants.h:48
AK_DEFAULT_BANK_THROUGHPUT
static const AkReal32 AK_DEFAULT_BANK_THROUGHPUT
Default bank load throughput (1 Mb/ms)
Definition: AkConstants.h:61
AK_INVALID_DEVICE_ID
static const AkDeviceID AK_INVALID_DEVICE_ID
Invalid streaming device ID
Definition: AkConstants.h:43
AK_INVALID_SHARE_SET_ID
static const AkPluginID AK_INVALID_SHARE_SET_ID
Invalid Share Set ID
Definition: AkConstants.h:32
AK_INVALID_GAME_OBJECT
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
Definition: AkConstants.h:33
AkUniqueID
AkUInt32 AkUniqueID
Unique 32-bit ID
Definition: AkTypedefs.h:39
AkAuxBusID
AkUInt32 AkAuxBusID
Auxilliary bus ID
Definition: AkTypedefs.h:52
AkMemPoolId
AkInt32 AkMemPoolId
Memory pool ID
Definition: AkTypedefs.h:49
AK_INVALID_PLUGINID
static const AkPluginID AK_INVALID_PLUGINID
Invalid FX ID
Definition: AkConstants.h:31
AkReal32
float AkReal32
32-bit floating point
Definition: AkNumeralTypes.h:43
AK_DEFAULT_BANK_IO_PRIORITY
static const AkPriority AK_DEFAULT_BANK_IO_PRIORITY
Default bank load I/O priority
Definition: AkConstants.h:60
AK_INVALID_FILE_ID
static const AkFileID AK_INVALID_FILE_ID
Invalid file ID
Definition: AkConstants.h:41
AK_DEFAULT_PRIORITY
static const AkPriority AK_DEFAULT_PRIORITY
Default sound / I/O priority
Definition: AkConstants.h:55
AK_INVALID_RTPC_ID
static const AkRtpcID AK_INVALID_RTPC_ID
Invalid RTPC ID
Definition: AkConstants.h:35
AkCacheID
AkUInt64 AkCacheID
Stream cache block ID.
Definition: AkTypedefs.h:77
AK_TRANSPORT_GAME_OBJECT
static const AkGameObjectID AK_TRANSPORT_GAME_OBJECT
Game object ID used by Wwise Authoring when playing back sounds using the Transport view.
Definition: AkConstants.h:51
AK_MIN_PRIORITY
static const AkPriority AK_MIN_PRIORITY
Minimal priority value [0,100]
Definition: AkConstants.h:56
AK_INVALID_PLAYING_ID
static const AkPlayingID AK_INVALID_PLAYING_ID
Invalid playing ID
Definition: AkConstants.h:36
AkPluginID
AkUInt32 AkPluginID
Source or effect plug-in ID
Definition: AkTypedefs.h:50
AkFileID
AkUInt32 AkFileID
Integer-type file identifier
Definition: AkTypedefs.h:64
AK_INVALID_CACHE_ID
static const AkCacheID AK_INVALID_CACHE_ID
Invalid cache ID
Definition: AkConstants.h:42
AkRtpcID
AkUInt32 AkRtpcID
Real time parameter control ID
Definition: AkTypedefs.h:60
AK_INVALID_AUX_ID
static const AkAuxBusID AK_INVALID_AUX_ID
Invalid auxiliary bus ID (or no Aux bus ID)
Definition: AkConstants.h:40
AkJobType_Generic
static const AkJobType AkJobType_Generic
Job type for general-purpose work
Definition: AkConstants.h:67
AkPipelineID
AkUInt32 AkPipelineID
Unique node (bus, voice) identifier for profiling.
Definition: AkTypedefs.h:73
AkAudioObjectID
AkUInt64 AkAudioObjectID
Audio Object ID
Definition: AkTypedefs.h:75
AK_INVALID_CHANNELMASK
static const AkChannelMask AK_INVALID_CHANNELMASK
Invalid channel mask
Definition: AkConstants.h:46
AK_NUM_JOB_TYPES
static const AkUInt32 AK_NUM_JOB_TYPES
Number of possible job types recognized by the Sound Engine
Definition: AkConstants.h:70
AK_DEFAULT_POOL_ID
static const AkMemPoolId AK_DEFAULT_POOL_ID
Default pool ID, same as AK_INVALID_POOL_ID
Definition: AkConstants.h:39
AK_MAX_PRIORITY
static const AkPriority AK_MAX_PRIORITY
Maximal priority value [0,100]
Definition: AkConstants.h:57
AK_INVALID_POOL_ID
static const AkMemPoolId AK_INVALID_POOL_ID
Invalid pool ID
Definition: AkConstants.h:38
AK_INVALID_UNIQUE_ID
static const AkUniqueID AK_INVALID_UNIQUE_ID
Invalid unique 32-bit ID
Definition: AkConstants.h:34
AkUInt32
uint32_t AkUInt32
Unsigned 32-bit integer
Definition: AkNumeralTypes.h:35
AK_SOUNDBANK_VERSION
static const AkUInt32 AK_SOUNDBANK_VERSION
Version of the soundbank reader (update AkBanks.h as well)
Definition: AkConstants.h:64
AkPriority
AkInt8 AkPriority
Priority
Definition: AkTypedefs.h:54
AkChannelMask
AkUInt32 AkChannelMask
Channel mask (similar to extensibleWavFormat). Bit values are defined in AkSpeakerConfig....
Definition: AkTypedefs.h:68
AK_INVALID_BANK_ID
static const AkBankID AK_INVALID_BANK_ID
Invalid bank ID
Definition: AkConstants.h:44
AkJobType_SpatialAudio
static const AkJobType AkJobType_SpatialAudio
Job type for Spatial Audio computations
Definition: AkConstants.h:69
AkPlayingID
AkUInt32 AkPlayingID
A unique identifier generated whenever a PostEvent is called (or when a Dynamic Sequence is created)....
Definition: AkTypedefs.h:42
AK_FALLBACK_ARGUMENTVALUE_ID
static const AkArgumentValueID AK_FALLBACK_ARGUMENTVALUE_ID
Fallback argument value ID
Definition: AkConstants.h:45
AkDeviceID
AkUInt32 AkDeviceID
I/O device ID
Definition: AkTypedefs.h:65
AK_INVALID_AUDIO_OBJECT_ID
static const AkAudioObjectID AK_INVALID_AUDIO_OBJECT_ID
Invalid audio object ID
Definition: AkConstants.h:49
AkArgumentValueID
AkUInt32 AkArgumentValueID
Argument value ID
Definition: AkTypedefs.h:67

このページはお役に立ちましたか？

サポートは必要ですか？

ご質問や問題、ご不明点はございますか？お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう