Audio::FOutputBuffer Class Reference

#include <AudioMixer.h>

Public Member Functions
	FOutputBuffer ()
	~FOutputBuffer ()=default
AUDIOMIXERCORE_API void	Init (IAudioMixer *InAudioMixer, const int32 InNumSamples, const int32 InNumBuffers, const EAudioMixerStreamDataFormat::Type InDataFormat)
AUDIOMIXERCORE_API bool	MixNextBuffer ()
AUDIOMIXERCORE_API TArrayView< const uint8 >	PopBufferData (int32 &OutBytesPopped) const
AUDIOMIXERCORE_API int32	GetNumSamples () const
EAudioMixerStreamDataFormat::Type	GetFormat () const

Detailed Description

Class which wraps an output float buffer and handles conversion to device stream formats.

Constructor & Destructor Documentation

FOutputBuffer()

Audio::FOutputBuffer::FOutputBuffer ( )

inline

~FOutputBuffer()

Audio::FOutputBuffer::~FOutputBuffer ( )

default

Member Function Documentation

GetFormat()

EAudioMixerStreamDataFormat::Type Audio::FOutputBuffer::GetFormat ( ) const

inline

Returns the format of the buffer.

GetNumSamples()

int32 Audio::FOutputBuffer::GetNumSamples

(

)

const

Gets the number of frames of the buffer.

Init()

void Audio::FOutputBuffer::Init	(	IAudioMixer *	InAudioMixer,
		const int32	InNumSamples,
		const int32	InNumBuffers,
		const EAudioMixerStreamDataFormat::Type	InDataFormat
	)

Initialize the buffer with the given samples and output format.

MixNextBuffer()

bool Audio::FOutputBuffer::MixNextBuffer

(

)

Gets the next mixed buffer from the audio mixer. Returns false if our buffer is already full.

PopBufferData()

TArrayView< const uint8 > Audio::FOutputBuffer::PopBufferData

(

int32 &

OutBytesPopped

)

const

Gets the buffer data ptrs. Returns a TArrayView for the full buffer size requested, but in the case of an underrun, OutBytesPopped will be less that the size of the returned TArrayView.

---

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

• Engine/Source/Runtime/AudioMixerCore/Public/AudioMixer.h
• Engine/Source/Runtime/AudioMixerCore/Private/AudioMixer.cpp