Version

menu_open
Wwise SDK 2023.1.8

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

#include <AkCommonDefs.h>

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 operator== (const AkAudioFormat &in_other) const
 
AkForceInline bool operator!= (const AkAudioFormat &in_other) const
 

Public Attributes

AkUInt32 uSampleRate
 Number of samples per second. More...
 
AkChannelConfig channelConfig
 Channel configuration. More...
 
AkUInt32 uBitsPerSample:6
 Number of bits per sample. More...
 
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. More...
 
AkUInt32 uTypeID:2
 Data type ID (AkDataTypeID). More...
 
AkUInt32 uInterleaveID:1
 Interleave ID (AkDataInterleaveID). More...
 

Detailed Description

Defines the parameters of an audio buffer format.

Definition at line 62 of 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