|
Wwise SDK 2022.1.17
|
Go to the source code of this file.
Classes | |
| struct | AkAudioSettings |
| Configured audio settings. More... | |
| struct | AkDeviceDescription |
| struct | AkExternalSourceInfo |
| struct | AkVector64 |
| 3D 64-bit vector. Intended as storage for world positions of sounds and objects, benefiting from 64-bit precision range More... | |
| struct | AkVector |
| 3D vector for some operations in 3D space. Typically intended only for localized calculations due to 32-bit precision More... | |
| class | AkWorldTransform |
| Position and orientation of game objects in the world (i.e. supports 64-bit-precision position) More... | |
| class | AkTransform |
| Position and orientation of objects in a "local" space. More... | |
| struct | AkObstructionOcclusionValues |
| Obstruction/occlusion pair for a position. More... | |
| struct | AkChannelEmitter |
| Positioning information for a sound, with specified subset of its channels. More... | |
| struct | AkPolarCoord |
| Polar coordinates. More... | |
| struct | AkSphericalCoord |
| Spherical coordinates. More... | |
| class | AkEmitterListenerPair |
| Emitter-listener pair: Positioning data pertaining to a single pair of emitter and listener. More... | |
| struct | AkListener |
| Listener information. More... | |
| struct | AkAuxSendValue |
| Auxiliary bus sends information per game object per given auxiliary bus. More... | |
| struct | AkRamp |
| Volume ramp specified by end points "previous" and "next". More... | |
| struct | AkGraphPointBase< VALUE_TYPE > |
| Type for a point in an RTPC or Attenuation curve. More... | |
| struct | AkCodecDescriptor |
| struct | WwiseObjectIDext |
| struct | WwiseObjectID |
| struct | AkFileParser::EnvelopePoint |
| Analyzed envelope point. More... | |
Namespaces | |
| namespace | AK |
| Audiokinetic namespace. | |
| AK::SoundEngine | |
| AkFileParser | |
| Public data structures for converted file format. | |
Macros | |
| #define | NULL 0 |
| #define | AK_ALIGN(_declaration_, _alignment_) _declaration_ __attribute__( ( aligned( _alignment_ ) ) ) |
| #define | AK_ENDIANNESS_LITTLE |
| AK_UNALIGNED refers to the __unaligned compilation flag available on some platforms. Note that so far, on the tested platform this should always be placed before the pointer symbol *. More... | |
| #define | AK_UNALIGNED |
| #define | AK_FINAL |
| #define | AK_NODISCARD |
| #define | AK_POINTER_64 |
| #define | AK_UNUSEDVAR(x) ((void)(x)) |
| #define | AK_THREAD_LOCAL |
| #define | AKCURVEINTERPOLATION_NUM_STORAGE_BIT 5 |
| Internal storage restriction, for internal use only. More... | |
| #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_PCMEX (7) |
| Standard PCM WAV file parser for Wwise Authoring. 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_METER (129) |
| Meter Plugin. More... | |
| #define | AKPLUGINID_RECORDER (132) |
| Recorder Plugin. More... | |
| #define | AKPLUGINID_IMPACTER (184) |
| #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 | WAVE_FORMAT_XMA2 0x166 |
| #define | AK_PANNER_NUM_STORAGE_BITS 3 |
| #define | AK_POSSOURCE_NUM_STORAGE_BITS 3 |
| #define | AK_SPAT_NUM_STORAGE_BITS 3 |
| #define | AK_MAX_BITS_METERING_FLAGS (5) |
| #define | AK_ASYNC_OPEN_DEFAULT (false) |
| Refers to asynchronous file opening in default low-level IO. More... | |
| #define | AK_COMM_DEFAULT_DISCOVERY_PORT 24024 |
| Default discovery port for most platforms using IP sockets for communication. More... | |
| #define | AkRegister |
Typedefs | |
| typedef AkUInt32 | AkUniqueID |
| Unique 32-bit ID. More... | |
| typedef AkUInt32 | AkStateID |
| State ID. More... | |
| typedef AkUInt32 | AkStateGroupID |
| State group ID. More... | |
| typedef AkUInt32 | AkPlayingID |
| Playing ID. More... | |
| typedef AkInt32 | AkTimeMs |
| Time in ms. More... | |
| typedef AkUInt16 | AkPortNumber |
| Port number. More... | |
| typedef AkReal32 | AkPitchValue |
| Pitch value. More... | |
| typedef AkReal32 | AkVolumeValue |
| Volume value( also apply to LFE ) More... | |
| typedef AkUInt64 | AkGameObjectID |
| Game object ID. More... | |
| typedef AkReal32 | AkLPFType |
| Low-pass filter type. More... | |
| typedef AkInt32 | AkMemPoolId |
| Memory pool ID. More... | |
| typedef AkUInt32 | AkPluginID |
| Source or effect plug-in ID. More... | |
| typedef AkUInt32 | AkCodecID |
| Codec plug-in ID. More... | |
| typedef AkUInt32 | AkAuxBusID |
| Auxilliary bus ID. More... | |
| typedef AkInt16 | AkPluginParamID |
| Source or effect plug-in parameter ID. More... | |
| typedef AkInt8 | AkPriority |
| Priority. More... | |
| typedef AkUInt16 | AkDataCompID |
| Data compression format ID. More... | |
| typedef AkUInt16 | AkDataTypeID |
| Data sample type ID. More... | |
| typedef AkUInt8 | AkDataInterleaveID |
| Data interleaved state ID. More... | |
| typedef AkUInt32 | AkSwitchGroupID |
| Switch group ID. More... | |
| typedef AkUInt32 | AkSwitchStateID |
| Switch ID. More... | |
| typedef AkUInt32 | AkRtpcID |
| Real time parameter control ID. More... | |
| typedef AkReal32 | AkRtpcValue |
| Real time parameter control value. More... | |
| typedef AkUInt32 | AkBankID |
| Run time bank ID. More... | |
| typedef AkUInt32 | AkBankType |
| Run time bank type. More... | |
| typedef AkUInt32 | AkFileID |
| Integer-type file identifier. More... | |
| typedef AkUInt32 | AkDeviceID |
| I/O device ID. More... | |
| typedef AkUInt32 | AkTriggerID |
| Trigger ID. More... | |
| typedef AkUInt32 | AkArgumentValueID |
| Argument value ID. More... | |
| typedef AkUInt32 | AkChannelMask |
| Channel mask (similar to WAVE_FORMAT_EXTENSIBLE). Bit values are defined in AkSpeakerConfig.h. More... | |
| typedef AkUInt32 | AkModulatorID |
| Modulator ID. More... | |
| typedef AkUInt32 | AkAcousticTextureID |
| Acoustic Texture ID. More... | |
| typedef AkUInt32 | AkImageSourceID |
| Image Source ID. More... | |
| typedef AkUInt64 | AkOutputDeviceID |
| Audio Output device ID. More... | |
| typedef AkUInt32 | AkPipelineID |
| Unique node (bus, voice) identifier for profiling. More... | |
| typedef AkUInt32 | AkRayID |
| Unique (per emitter) identifier for an emitter-listener ray. More... | |
| typedef AkUInt64 | AkAudioObjectID |
| Audio Object ID. More... | |
| typedef AkUInt32 | AkJobType |
| Job type identifier. More... | |
| typedef AkWorldTransform | AkSoundPosition |
| Positioning information for a sound. More... | |
| typedef AkWorldTransform | AkListenerPosition |
| Positioning information for a listener. More... | |
| typedef AkGraphPointBase< AkReal32 > | AkRTPCGraphPoint |
| typedef IAkSoftwareCodec *(* | AkCreateFileSourceCallback) (void *in_pCtx) |
| Registered file source creation function prototype. More... | |
| typedef IAkSoftwareCodec *(* | AkCreateBankSourceCallback) (void *in_pCtx) |
| Registered bank source node creation function prototype. More... | |
| typedef IAkFileCodec *(* | AkCreateFileCodecCallback) () |
| Registered FileCodec creation function prototype. More... | |
| typedef IAkGrainCodec *(* | AkCreateGrainCodecCallback) () |
| Registered IAkGrainCodec creation function prototype. More... | |
| typedef AkInt16 | AkCaptureType |
| Default value: capture type is short. More... | |
Functions | |
| AkVector | AK::ConvertAkVector64ToAkVector (AkVector64 in) |
| AkTransform | AK::ConvertAkWorldTransformToAkTransform (AkWorldTransform in) |
| AkVector64 | AK::ConvertAkVectorToAkVector64 (AkVector in) |
| AkWorldTransform | AK::ConvertAkTransformToAkWorldTransform (AkTransform in) |
| AkRamp | operator* (const AkRamp &in_rLhs, const AkRamp &in_rRhs) |
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 = AK_INVALID_UNIQUE_ID |
| Invalid RTPC ID. More... | |
| static const AkPlayingID | AK_INVALID_PLAYING_ID = AK_INVALID_UNIQUE_ID |
| 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 = AK_INVALID_UNIQUE_ID |
| 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 AkDeviceID | AK_INVALID_DEVICE_ID = (AkDeviceID)-1 |
| Invalid streaming device ID. More... | |
| static const AkBankID | AK_INVALID_BANK_ID = AK_INVALID_UNIQUE_ID |
| 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 = AK_INVALID_UNIQUE_ID |
| Invalid Device ID. More... | |
| static const AkPipelineID | AK_INVALID_PIPELINE_ID = AK_INVALID_UNIQUE_ID |
| Invalid pipeline ID (for profiling) More... | |
| static const AkAudioObjectID | AK_INVALID_AUDIO_OBJECT_ID = (AkAudioObjectID)-1 |
| Invalid audio object ID. 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 = AK_DEFAULT_PRIORITY |
| 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 = 145 |
| Version of the soundbank reader. 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... | |
Data type definitions.
Definition in file AkTypes.h.
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise