Table of Contents

AkAudioFormat Struct Reference

Defines the parameters of an audio buffer format. More...

List of all members.

Public Member Functions

AkForceInline AkUInt32  GetNumChannels () const
AkForceInline bool  HasLFE () const
AkForceInline bool  HasCenter () const
AkForceInline AkUInt32  GetBitsPerSample () const
AkForceInline AkUInt32  GetBlockAlign () const
AkForceInline AkUInt32  GetTypeID () const
AkForceInline AkUInt32  GetInterleaveID () const
void  SetAll (AkUInt32 in_uSampleRate, AkChannelConfig in_channelConfig, AkUInt32 in_uBitsPerSample, AkUInt32 in_uBlockAlign, AkUInt32 in_uTypeID, AkUInt32 in_uInterleaveID)
AkForceInline bool  IsChannelConfigSupported () const
AkForceInline bool  operator== (const AkAudioFormat &in_other) const
AkForceInline bool  operator!= (const AkAudioFormat &in_other) const

Public Attributes

AkUInt32  uSampleRate
  Number of samples per second.
AkChannelConfig  channelConfig
  Channel configuration.
AkUInt32  uBitsPerSample:6
  Number of bits per sample.
AkUInt32  uBlockAlign:10
  Number of bytes per sample frame. (For example a 5.1 PCM 16bit should have a uBlockAlign equal to 6(5.1 channels)*2(16 bits per sample) = 12.
AkUInt32  uTypeID:2
  Data type ID (AkDataTypeID).
AkUInt32  uInterleaveID:1
  Interleave ID (AkDataInterleaveID).

Detailed Description

Defines the parameters of an audio buffer format.

Definition at line 59 of file AkCommonDefs.h.

The documentation for this struct was generated from the following file: