Table of Contents

Wwise SDK 2019.2.3
AkAudioBuffer Class Reference

Public Member Functions

  AkAudioBuffer ()
  Constructor. More...
 
AkForceInline void  ClearData ()
  Clear data pointer. More...
 
AkForceInline void  Clear ()
  Clear members. More...
 
Channel queries.
AkForceInline AkUInt32  NumChannels () const
  Get the number of channels. More...
 
AkForceInline bool  HasLFE () const
  Returns true if there is an LFE channel present. More...
 
AkForceInline AkChannelConfig  GetChannelConfig () const
 
Interleaved interface
AkForceInline void *  GetInterleavedData ()
 
void  AttachInterleavedData (void *in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames)
  Attach interleaved data. Allocation is performed outside. More...
 
void  AttachInterleavedData (void *in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames, AkChannelConfig in_channelConfig)
  Attach interleaved data with a new channel config. Allocation is performed outside. More...
 

Deinterleaved interface

void *  pData
  Start of the audio buffer. More...
 
AkChannelConfig  channelConfig
  Channel config. More...
 
AkUInt16  uMaxFrames
  Number of sample frames the buffer can hold. Access through AkAudioBuffer::MaxFrames(). More...
 
AKRESULT  eState
  Execution status
More...
 
AkUInt16  uValidFrames
  Number of valid sample frames in the audio buffer. More...
 
AkForceInline bool  HasData () const
  Check if buffer has samples attached to it. More...
 
AkSampleType *  GetChannel (AkUInt32 in_uIndex)
 
AkSampleType *  GetLFE ()
 
void  ZeroPadToMaxFrames ()
 
AkForceInline void  AttachContiguousDeinterleavedData (void *in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames, AkChannelConfig in_channelConfig)
  Attach deinterleaved data where channels are contiguous in memory. Allocation is performed outside. More...
 
AkForceInline void *  DetachContiguousDeinterleavedData ()
  Detach deinterleaved data where channels are contiguous in memory. The address of the buffer is returned and fields are cleared. More...
 
bool  CheckValidSamples ()
 
void  RelocateMedia (AkUInt8 *in_pNewMedia, AkUInt8 *in_pOldMedia)
 
AkForceInline AkUInt16  MaxFrames () const
 
static AkUInt32  StandardToPipelineIndex (AkChannelConfig in_channelConfig, AkUInt32 in_uChannelIdx)
 

Detailed Description

Audio buffer structure including the address of an audio buffer, the number of valid frames inside, and the maximum number of frames the audio buffer can hold.

See also

Definition at line 256 of file AkCommonDefs.h.


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