Audio::FMixerSourceBuffer Class Reference

#include <AudioMixerSourceBuffer.h>

Inheritance diagram for Audio::FMixerSourceBuffer:

Classes
struct	FDiagnosticState

Public Member Functions
	~FMixerSourceBuffer ()
bool	Init ()
void	SetDecoder (ICompressedAudioInfo *InCompressedAudioInfo)
void	SetPCMData (const FRawPCMDataBuffer &InPCMDataBuffer)
void	SetCachedRealtimeFirstBuffers (TArray< uint8 > &&InPrecachedBuffer)
void	OnBufferEnd ()
int32	GetNumBuffersQueued () const
TSharedPtr< FAlignedFloatBuffer, ESPMode::ThreadSafe >	GetNextBuffer ()
bool	DidBufferLoop () const
bool	DidBufferFinish () const
bool	IsEndOfAudio () const
bool	ReadMoreRealtimeData (ICompressedAudioInfo *InDecoder, int32 BufferIndex, EBufferReadMode BufferReadMode)
bool	IsAsyncTaskInProgress () const
bool	IsAsyncTaskDone () const
uint64	GetInstanceID () const
void	GetDiagnosticState (FDiagnosticState &OutState)
void	EnsureAsyncTaskFinishes ()
void	OnBeginGenerate ()
void	OnEndGenerate ()
void	ClearWave ()
float	GetRelativeRenderCost () const
void	DoProceduralRendering (const FProceduralAudioTaskData &ProceduralTaskData, FProceduralAudioTaskResults &ProceduralResult)
void	FinishProceduralRendering (const FProceduralAudioTaskResults &TaskResult)
Public Member Functions inherited from ISoundWaveClient
	ISoundWaveClient ()
virtual	~ISoundWaveClient ()

Static Public Member Functions
static FMixerSourceBufferPtr	Create (FMixerSourceBufferInitArgs &InArgs, TArray< FAudioParameter > &&InDefaultParams=TArray< FAudioParameter >())

Detailed Description

Class which handles decoding audio for a particular source buffer.

Constructor & Destructor Documentation

~FMixerSourceBuffer()

Audio::FMixerSourceBuffer::~FMixerSourceBuffer

(

)

Member Function Documentation

ClearWave()

void Audio::FMixerSourceBuffer::ClearWave ( )

inline

Create()

TSharedPtr< FMixerSourceBuffer, ESPMode::ThreadSafe > Audio::FMixerSourceBuffer::Create ( FMixerSourceBufferInitArgs &  InArgs, TArray< FAudioParameter > &&  InDefaultParams = TArray<FAudioParameter>()  )

static

DidBufferFinish()

bool Audio::FMixerSourceBuffer::DidBufferFinish ( ) const

inline

DidBufferLoop()

bool Audio::FMixerSourceBuffer::DidBufferLoop ( ) const

inline

DoProceduralRendering()

void Audio::FMixerSourceBuffer::DoProceduralRendering	(	const FProceduralAudioTaskData &	ProceduralTaskData,
		FProceduralAudioTaskResults &	ProceduralResult
	)

EnsureAsyncTaskFinishes()

void Audio::FMixerSourceBuffer::EnsureAsyncTaskFinishes

(

)

FinishProceduralRendering()

void Audio::FMixerSourceBuffer::FinishProceduralRendering

(

const FProceduralAudioTaskResults &

TaskResult

)

GetDiagnosticState()

void Audio::FMixerSourceBuffer::GetDiagnosticState

(

FDiagnosticState &

OutState

)

GetInstanceID()

uint64 Audio::FMixerSourceBuffer::GetInstanceID

(

)

const

GetNextBuffer()

TSharedPtr< FAlignedFloatBuffer, ESPMode::ThreadSafe > Audio::FMixerSourceBuffer::GetNextBuffer

(

)

GetNumBuffersQueued()

int32 Audio::FMixerSourceBuffer::GetNumBuffersQueued

(

)

const

GetRelativeRenderCost()

float Audio::FMixerSourceBuffer::GetRelativeRenderCost

(

)

const

Init()

bool Audio::FMixerSourceBuffer::Init

(

)

IsAsyncTaskDone()

bool Audio::FMixerSourceBuffer::IsAsyncTaskDone

(

)

const

IsAsyncTaskInProgress()

bool Audio::FMixerSourceBuffer::IsAsyncTaskInProgress

(

)

const

IsEndOfAudio()

bool Audio::FMixerSourceBuffer::IsEndOfAudio

(

)

const

OnBeginGenerate()

void Audio::FMixerSourceBuffer::OnBeginGenerate

(

)

OnBufferEnd()

void Audio::FMixerSourceBuffer::OnBufferEnd

(

)

OnEndGenerate()

void Audio::FMixerSourceBuffer::OnEndGenerate

(

)

ReadMoreRealtimeData()

bool Audio::FMixerSourceBuffer::ReadMoreRealtimeData	(	ICompressedAudioInfo *	InDecoder,
		int32	BufferIndex,
		EBufferReadMode	BufferReadMode
	)

SetCachedRealtimeFirstBuffers()

void Audio::FMixerSourceBuffer::SetCachedRealtimeFirstBuffers

(

TArray< uint8 > &&

InPrecachedBuffer

)

SetDecoder()

void Audio::FMixerSourceBuffer::SetDecoder

(

ICompressedAudioInfo *

InCompressedAudioInfo

)

SetPCMData()

void Audio::FMixerSourceBuffer::SetPCMData

(

const FRawPCMDataBuffer &

InPCMDataBuffer

)

---

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

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