Audio::FMixerBuffer Class Reference

#include <AudioMixerBuffer.h>

Inheritance diagram for Audio::FMixerBuffer:

Public Member Functions
	FMixerBuffer (FAudioDevice *InAudioDevice, USoundWave *InWave, EBufferType::Type InBufferType)
	~FMixerBuffer ()
int32	GetSize () override
int32	GetCurrentChunkIndex () const override
int32	GetCurrentChunkOffset () const override
bool	IsRealTimeSourceReady () override
bool	ReadCompressedInfo (USoundWave *SoundWave) override
void	Seek (const float SeekTime) override
EBufferType::Type	GetType () const
bool	IsRealTimeBuffer () const
ICompressedAudioInfo *	GetDecompressionState (bool bTakesOwnership=false)
void	GetPCMData (uint8 **OutData, uint32 *OutDataSize)
void	EnsureHeaderParseTaskFinished ()
float	GetSampleRate () const
int32	GetNumChannels () const
uint32	GetNumFrames () const
void	InitSampleRate (const float InSampleRate)
void	InitNumFrames (const uint32 InNumFrames)
Public Member Functions inherited from FSoundBuffer
	FSoundBuffer (class FAudioDevice *InAudioDevice)
virtual ENGINE_API	~FSoundBuffer ()
virtual ENGINE_API FString	Describe (bool bUseLongName)
FName	GetSoundClassName ()
FString	GetChannelsDesc ()
virtual bool	ReadCompressedData (uint8 *Destination, int32 NumFramesToDecode, bool bLooping)
virtual void	EnsureRealtimeTaskCompletion ()

Static Public Member Functions
static FMixerBuffer *	Init (FAudioDevice *AudioDevice, USoundWave *InWave, bool bForceRealtime)
static FMixerBuffer *	CreatePreviewBuffer (FAudioDevice *AudioDevice, USoundWave *InWave)
static FMixerBuffer *	CreateProceduralBuffer (FAudioDevice *AudioDevice, USoundWave *InWave)
static FMixerBuffer *	CreateNativeBuffer (FAudioDevice *AudioDevice, USoundWave *InWave)
static FMixerBuffer *	CreateStreamingBuffer (FAudioDevice *AudioDevice, USoundWave *InWave)
static FMixerBuffer *	CreateRealTimeBuffer (FAudioDevice *AudioDevice, USoundWave *InWave)

Additional Inherited Members
Public Attributes inherited from FSoundBuffer
virtual int32	GetSize () PURE_VIRTUAL(FSoundBuffer
int32	ResourceID
int32	NumChannels
FString	ResourceName
bool	bAllocationInPermanentPool
class FAudioDevice *	AudioDevice

Constructor & Destructor Documentation

FMixerBuffer()

Audio::FMixerBuffer::FMixerBuffer	(	FAudioDevice *	InAudioDevice,
		USoundWave *	InWave,
		EBufferType::Type	InBufferType
	)

~FMixerBuffer()

Audio::FMixerBuffer::~FMixerBuffer

(

)

Member Function Documentation

CreateNativeBuffer()

FMixerBuffer * Audio::FMixerBuffer::CreateNativeBuffer ( FAudioDevice *  AudioDevice, USoundWave *  InWave  )

static

CreatePreviewBuffer()

FMixerBuffer * Audio::FMixerBuffer::CreatePreviewBuffer ( FAudioDevice *  AudioDevice, USoundWave *  InWave  )

static

CreateProceduralBuffer()

FMixerBuffer * Audio::FMixerBuffer::CreateProceduralBuffer ( FAudioDevice *  AudioDevice, USoundWave *  InWave  )

static

CreateRealTimeBuffer()

FMixerBuffer * Audio::FMixerBuffer::CreateRealTimeBuffer ( FAudioDevice *  AudioDevice, USoundWave *  InWave  )

static

CreateStreamingBuffer()

FMixerBuffer * Audio::FMixerBuffer::CreateStreamingBuffer ( FAudioDevice *  AudioDevice, USoundWave *  InWave  )

static

EnsureHeaderParseTaskFinished()

void Audio::FMixerBuffer::EnsureHeaderParseTaskFinished

(

)

GetCurrentChunkIndex()

int32 Audio::FMixerBuffer::GetCurrentChunkIndex ( ) const

overridevirtual

Gets the chunk index that was last read from (for Streaming Manager requests)

Reimplemented from FSoundBuffer.

GetCurrentChunkOffset()

int32 Audio::FMixerBuffer::GetCurrentChunkOffset ( ) const

overridevirtual

Gets the offset into the chunk that was last read to (for Streaming Manager priority)

Reimplemented from FSoundBuffer.

GetDecompressionState()

ICompressedAudioInfo * Audio::FMixerBuffer::GetDecompressionState

(

bool

bTakesOwnership = false

)

Retrieve the compressed audio info pointer. This transfers ownership of the decompression state.

GetNumChannels()

int32 Audio::FMixerBuffer::GetNumChannels ( ) const

inline

GetNumFrames()

uint32 Audio::FMixerBuffer::GetNumFrames ( ) const

inline

GetPCMData()

void Audio::FMixerBuffer::GetPCMData	(	uint8 **	OutData,
		uint32 *	OutDataSize
	)

Returns the contained raw PCM data and data size

GetSampleRate()

float Audio::FMixerBuffer::GetSampleRate ( ) const

inline

GetSize()

int32 Audio::FMixerBuffer::GetSize ( void  )

override

GetType()

EBufferType::Type Audio::FMixerBuffer::GetType

(

)

const

Returns the buffer's format

Init()

FMixerBuffer * Audio::FMixerBuffer::Init ( FAudioDevice *  AudioDevice, USoundWave *  InWave, bool  bForceRealtime  )

static

InitNumFrames()

void Audio::FMixerBuffer::InitNumFrames ( const uint32  InNumFrames )

inline

InitSampleRate()

void Audio::FMixerBuffer::InitSampleRate ( const float  InSampleRate )

inline

IsRealTimeBuffer()

bool Audio::FMixerBuffer::IsRealTimeBuffer

(

)

const

IsRealTimeSourceReady()

bool Audio::FMixerBuffer::IsRealTimeSourceReady ( )

overridevirtual

Returns whether or not a real-time decoding buffer is ready for playback

Reimplemented from FSoundBuffer.

ReadCompressedInfo()

bool Audio::FMixerBuffer::ReadCompressedInfo ( USoundWave *  SoundWave )

overridevirtual

Reads the compressed info of the given sound wave. Not implemented on all platforms.

Reimplemented from FSoundBuffer.

Seek()

void Audio::FMixerBuffer::Seek ( const float  SeekTime )

overridevirtual

Seeks the buffer to the given seek time

Reimplemented from FSoundBuffer.

---

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

• Engine/Source/Runtime/AudioMixer/Private/AudioMixerBuffer.h
• Engine/Source/Runtime/AudioMixer/Private/AudioMixerBuffer.cpp