Version
menu_open

AkAudioBuffer Class Reference

List of all members.

Public Member Functions

  AkAudioBuffer ()
  Constructor.
AkForceInline void  ClearData ()
  Clear data pointer.
AkForceInline void  Clear ()
  Clear members.
void  RelocateMedia (AkUInt8 *in_pNewMedia, AkUInt8 *in_pOldMedia)
AkForceInline AkUInt16  MaxFrames ()
Channel queries.

AkForceInline AkUInt32  NumChannels ()
  Get the number of channels.
AkForceInline bool  HasLFE ()
  Returns true if there is an LFE channel present.
AkForceInline AkChannelConfig  GetChannelConfig () const
Interleaved interface

AkForceInline void *  GetInterleavedData ()
void  AttachInterleavedData (void *in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames, AkChannelConfig in_channelConfig)
  Attach interleaved data. Allocation is performed outside.

Public Attributes

AKRESULT  eState
  Execution status.
AkUInt16  uValidFrames
  Number of valid sample frames in the audio buffer.

Protected Attributes

void *  pData
  Start of the audio buffer.
AkChannelConfig  channelConfig
  Channel config.
AkUInt16  uMaxFrames
  Number of sample frames the buffer can hold. Access through AkAudioBuffer::MaxFrames().

Deinterleaved interface



AkForceInline bool  HasData ()
  Check if buffer has samples attached to it.
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.
AkForceInline void *  DetachContiguousDeinterleavedData ()
  Detach deinterleaved data where channels are contiguous in memory. The address of the buffer is returned and fields are cleared.
AkForceInline void *  GetDataStartDMA ()
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 245 of file AkCommonDefs.h.

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

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