Wwise Version
arrow_right Table of Contents
Wwise SDK 2021.1.5
AkCommonDefs.h File Reference

Go to the source code of this file.

Classes

struct   AkAudioFormat
  Defines the parameters of an audio buffer format. More...
 
class   AK::IAkMetering
  Interface to retrieve metering information about a buffer. More...
 
struct   Ak3dData
 
struct   AkBehavioralPositioningData
  Positioning data inherited from sound structures and mix busses. More...
 
struct   AkPositioningData
  Positioning data of 3D audio objects. More...
 
struct   AkAudioObject
 
struct   AkAudioObject::CustomMetadata
  Custom object metadata. More...
 
struct   Ak3DAudioSinkCapabilities
 
class   AkAudioBuffer
 
struct   AkAudioObjects
  A collection of audio objects. Encapsulates the audio data and metadata of each audio object in separate arrays. More...
 

Namespaces

namespace   AK
  Audiokinetic namespace.
 

Macros

#define  AK_MAKE_CHANNELCONFIGOVERRIDE(_config, _order)   ((AkInt64)_config.Serialize()|((AkInt64)_order<<32))
 
#define  AK_GET_CHANNELCONFIGOVERRIDE_CONFIG(_over)   (_over&UINT_MAX)
 
#define  AK_GET_CHANNELCONFIGOVERRIDE_ORDERING(_over)   ((AkSourceChannelOrdering)(_over>>32))
 
#define  AKMAKECLASSID(in_pluginType, in_companyID, in_pluginID)    ( (in_pluginType) + ( (in_companyID) << 4 ) + ( (in_pluginID) << ( 4 + 12 ) ) )
 
#define  AKGETPLUGINTYPEFROMCLASSID(in_classID)   ( (in_classID) & AkPluginTypeMask )
 
#define  AKGETCOMPANYIDFROMCLASSID(in_classID)   ( ( (in_classID) & 0x0000FFF0 ) >> 4 )
 
#define  AKGETPLUGINIDFROMCLASSID(in_classID)   ( ( (in_classID) & 0xFFFF0000 ) >> ( 4 + 12 ) )
 
#define  CODECID_FROM_PLUGINID   AKGETPLUGINIDFROMCLASSID
 
#define  AK_DEFAULT_LISTENER_POSITION_X   (0.0f)
  Default listener transform. More...
 
#define  AK_DEFAULT_LISTENER_POSITION_Y   (0.0f)
 
#define  AK_DEFAULT_LISTENER_POSITION_Z   (0.0f)
 
#define  AK_DEFAULT_LISTENER_FRONT_X   (0.0f)
 
#define  AK_DEFAULT_LISTENER_FRONT_Y   (0.0f)
 
#define  AK_DEFAULT_LISTENER_FRONT_Z   (1.0f)
 
#define  AK_DEFAULT_TOP_X   (0.0f)
 
#define  AK_DEFAULT_TOP_Y   (1.0f)
 
#define  AK_DEFAULT_TOP_Z   (0.0f)
 

Typedefs

typedef AkUInt8(*  AkChannelMappingFunc) (const AkChannelConfig &config, AkUInt8 idx)
 
typedef AkReal32  AkSampleType
  Audio sample data type (32 bit floating point) More...
 

Enumerations

enum   AkSourceChannelOrdering { SourceChannelOrdering_Standard = 0, SourceChannelOrdering_Film, SourceChannelOrdering_FuMa }
 
enum   AkAudioObjectDestination { AkAudioObjectDestination::eDefault = 0, AkAudioObjectDestination::eMainMix = 1, AkAudioObjectDestination::ePassthrough = 2, AkAudioObjectDestination::eSystemAudioObject = 3 }
  Enum of the possible object destinations when reaching a 3D audio-capable sink. More...
 

Variables

const AkDataTypeID  AK_INT = 0
  Integer data type (uchar, short, and so on) More...
 
const AkDataTypeID  AK_FLOAT = 1
  Float data type. More...
 
const AkDataInterleaveID  AK_INTERLEAVED = 0
  Interleaved data. More...
 
const AkDataInterleaveID  AK_NONINTERLEAVED = 1
  Non-interleaved data. More...
 
const AkUInt32  AK_LE_NATIVE_BITSPERSAMPLE = 32
  Native number of bits per sample. More...
 
const AkUInt32  AK_LE_NATIVE_SAMPLETYPE = AK_FLOAT
  Native data type. More...
 
const AkUInt32  AK_LE_NATIVE_INTERLEAVE = AK_NONINTERLEAVED
  Native interleaved setting. More...
 

Detailed Description

AudioLib common defines, enums, and structs.

Definition in file AkCommonDefs.h.