Version

menu_open

include/AK/SoundEngine/Common/AkCommonDefs.h File Reference

Go to the source code of this file.

Classes

struct   AkChannelConfig
  Defines a channel configuration. More...
struct   AkAudioFormat
  Defines the parameters of an audio buffer format. More...
class   AK::IAkMetering
  Interface to retrieve metering information about a buffer. More...
class   AkAudioBuffer

Namespaces

namespace   AK
 

Audiokinetic namespace.


Defines

#define  AK_SPEAKER_SETUP_DEFAULT_PLANE   (AK_SPEAKER_SETUP_5POINT1)
  All speakers on the plane, supported on this platform.
#define  AK_SUPPORTED_STANDARD_CHANNEL_MASK   (AK_SPEAKER_SETUP_DEFAULT_PLANE)
  Platform supports 5.1.
#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

Typedefs

typedef AkInt16  AkSampleType
  Audio sample data type (Wii-specific: 16 bit signed integer).

Enumerations

enum   AkChannelConfigType { AK_ChannelConfigType_Anonymous = 0x0, AK_ChannelConfigType_Standard = 0x1, AK_ChannelConfigType_Ambisonic = 0x2 }
 

Channel configuration type.

More...

Functions

AkForceInline bool  AK::HasLFE (AkChannelMask in_uChannelMask)
AkForceInline bool  AK::HasCenter (AkChannelMask in_uChannelMask)
AkForceInline AkUInt32  AK::GetNumberOfAnglesForConfig (AkChannelMask in_uChannelMask)

Variables

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

Detailed Description

AudioLib common defines, enums, and structs.

Definition in file AkCommonDefs.h.


Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise