Wwise Version
arrow_right Table of Contents
Wwise SDK 2021.1.3

#include <AkCommonDefs.h>

Classes

struct   CustomMetadata
  Custom object metadata. More...
 

Public Types

typedef AkArray< CustomMetadata, const CustomMetadata &, AkPluginArrayAllocator ArrayCustomMetadata
  Array type for carrying custom metadata. More...
 
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)
  Copy object metadata (everything but the key) from another object. More...
 
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. 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...
 
ArrayCustomMetadata  arCustomMetadata
  Array of custom metadata, gathered from visited objects. More...
 
AkPipelineID  instigatorID
  Profiling ID of the node from which the object stems (typically the voice, instance of an actor-mixer). 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...
 

Detailed Description

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 307 of file AkCommonDefs.h.