|
Wwise SDK 2023.1.9
|
#include <AkCommonDefs.h>
Classes | |
| class | ArrayCustomMetadata |
| Array type for carrying custom metadata. More... | |
| struct | CustomMetadata |
| Custom object metadata. More... | |
Public Types | |
| typedef AkString< AkPluginArrayAllocator, char > | String |
| String type for use in 3D audio objects. More... | |
Public Member Functions | |
| AkAudioObject () | |
| Constructor. More... | |
| ~AkAudioObject () | |
| Destructor. More... | |
| void | CopyContents (const AkAudioObject &in_src) |
| Copies object metadata (everything but the key) from another object. More... | |
| void | TransferContents (AkAudioObject &in_src) |
| Moves object metadata (everything but the key) from another object. More... | |
| void | SetCustomMetadata (CustomMetadata *in_aCustomMetadata, AkUInt32 in_uLength) |
| void | Transfer (AkAudioObject &in_from) |
| Transfer function for transfer move policies. More... | |
| AKRESULT | SetName (AK::IAkPluginMemAlloc *in_pAllocator, const char *in_szName) |
| void | ResetState () |
| Reset object state in preparation for next frame. More... | |
Public Attributes | |
| AkAudioObjectID | key |
| Unique ID, local to a given bus. Only the lower 56 of 64 bits are used for the object itself. The highest 8 bits are available for channel indexing. More... | |
| AkPositioningData | positioning |
| Positioning data for deferred 3D rendering. More... | |
| AkRamp | cumulativeGain |
| Cumulative ramping gain to apply when mixing down to speaker bed or final endpoint. More... | |
| AkPipelineID | instigatorID |
| Profiling ID of the node from which the object stems (typically the voice, instance of an actor-mixer). More... | |
| AkPriority | priority |
| Audio object playback priority. Object with a higher priority will be rendered using the hardware's object functionality on platforms that supports it, whereas objects with a lower priority will be downmixed to a lower resolution 3D bed. Audio object priorities should be retrieved, or set through IAkPluginServiceAudioObjectPriority to retain compatibility with future Wwise releases. More... | |
| ArrayCustomMetadata | arCustomMetadata |
| Array of custom metadata, gathered from visited objects. Note: any custom metadata is expected to exist for only the current sound engine render tick, and persistent references to it should not be stored. More... | |
| String | objectName |
| Name string of the object, to appear in the object profiler. This is normally used by out-of-place object processors for naming their output objects. Built-in sound engine structures don't use it. More... | |
Static Public Attributes | |
| static const AkUInt64 | kObjectKeyNumBits = 56 |
| static const AkUInt64 | kObjectKeyMask = (((AkUInt64)1 << kObjectKeyNumBits) - 1) |
An audio object refers to an audio signal with some attached metadata going through the sound engine pipeline. The AkAudioObject struct encapsulates the metadata part. The signal itself is contained in a separate AkAudioBuffer instance.
Definition at line 303 of file AkCommonDefs.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