FOutputBuffer

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

Windows
MacOS
Linux

References

Module

AudioMixerCore

Header

/Engine/Source/Runtime/AudioMixerCore/Public/AudioMixer.h

Include

#include "AudioMixer.h"

Syntax

class FOutputBuffer

Remarks

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

Variables

Name Description

Public variable

FEvent *

 

IsReadyEvent

Event to signal that the buffer is ready

Constructors

Name Description

Public function

FOutputBuffer()

Destructors

Name Description

Public function

~FOutputBuffer()

Functions

Name Description

Public function

AlignedFloat...

 

GetBuffer()

Returns the float buffer.

Public function Const

const uint8 ...

 

GetBufferData()

Gets the buffer data ptrs.

Public function

uint8 *

 

GetBufferData()

Gets the buffer data ptrs.

Public function Const

EAudioMixerS...

 

GetFormat()

Returns the format of the buffer.

Public function Const

int32

 

GetNumFrames()

Gets the number of frames of the buffer.

Public function

void

 

Init

(
    IAudioMixer* InAudioMixer,
    const int32 InNumSamples,
    const EAudioMixerStreamDataFormat::...
)

Initialize the buffer with the given samples and output format.

Public function Const

bool

 

IsReady()

Returns if ready.

Public function

void

 

MixNextBuffer()

Gets the next mixed buffer from the audio mixer.

Public function

void

 

Reset

(
    const int32 InNewNumSamples
)

Resets the internal buffers to the new sample count. Used when device is changed.

Public function

void

 

ResetReadyState()

Resets the buffer ready state.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss