Navigation
API > API/Runtime > API/Runtime/AudioMixerCore
Class which wraps an output float buffer and handles conversion to device stream formats.
| Name | FOutputBuffer |
| Type | class |
| Header File | /Engine/Source/Runtime/AudioMixerCore/Public/AudioMixer.h |
| Include Path | #include "AudioMixer.h" |
Syntax
class FOutputBuffer
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FOutputBuffer() |
AudioMixer.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FOutputBuffer() |
AudioMixer.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AudioMixer | IAudioMixer * | AudioMixer.h | ||
| CallCounterMixNextBuffer | int32 | AudioMixer.h | ||
| CircularBuffer | Audio::TCircularAudioBuffer< uint8 > | Circular buffer used to buffer audio between the audio render thread and the platform interface thread. | AudioMixer.h | |
| DataFormat | EAudioMixerStreamDataFormat::Type | AudioMixer.h | ||
| FormattedBuffer | FAlignedByteBuffer | For non-float situations, this buffer is used to convert RenderBuffer before pushing it to CircularBuffer. | AudioMixer.h | |
| PopBuffer | Audio::FAlignedByteBuffer | Buffer read by the platform interface thread. | AudioMixer.h | |
| RenderBuffer | Audio::FAlignedFloatBuffer | Buffer that we render audio to from the IAudioMixer instance associated with this output buffer. | AudioMixer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
EAudioMixerStreamDataFormat::Type GetFormat() |
Returns the format of the buffer. | AudioMixer.h | |
int32 GetNumSamples() |
Gets the number of frames of the buffer. | AudioMixer.h | |
void Init
(
IAudioMixer* InAudioMixer, |
Initialize the buffer with the given samples and output format. | AudioMixer.h | |
bool MixNextBuffer() |
Gets the next mixed buffer from the audio mixer. Returns false if our buffer is already full. | AudioMixer.h | |
TArrayView< const uint8 > PopBufferData
(
int32& OutBytesPopped |
Gets the buffer data ptrs. | AudioMixer.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static size_t GetSizeForDataFormat
(
EAudioMixerStreamDataFormat::Type InDataFormat |
AudioMixer.h |