FSourceInfo

Object used for source generation from decoded buffers.

Windows
MacOS
Linux

References

Module

AudioMixer

Header

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

Include

#include "SoundWaveDecoder.h"

Syntax

struct FSourceInfo

Remarks

Object used for source generation from decoded buffers.

Variables

Name Description

Public variable

float

 

BasePitchScale

The pitch scale to use to account for sample rate differences of source to output sample rate.

Public variable

bool

 

bHasStarted

If this sound hasn't yet started rendering audio.

Public variable

bool

 

bIsDone

If this sound is done (has decoded all data)

Public variable

bool

 

bIsLastBuffer

If this is the last decoded buffer.

Public variable

int32

 

CurrentAudioChunkNumFrames

Number of frames of current decoded chunk.

Public variable

float

 

CurrentFrameAlpha

The current frame alpha (how far we are between current and next frame)

Public variable

int32

 

CurrentFrameIndex

The current frame index.

Public variable

TArray< float >

 

CurrentFrameValues

Buffer to store current decoded audio frame.

Public variable

TSharedPtr< FMi...

 

CurrentPCMBuffer

The current decoded PCM buffer we are reading from.

Public variable

TArray< float >

 

NextFrameValues

Buffer to store next decoded audio frame.

Public variable

uint32

 

NumFramesGenerated

Total number of frames generated (could be larger or smaller than number of frames read)

Public variable

uint32

 

NumFramesRead

Total number of frames played (or read from decoded buffers) so far. Will always be less than TotalNumFrames.

Public variable

int32

 

NumSourceChannels

Number of channels of source file.

Public variable

FParam

 

PitchParam

The pitch param object, allows easy pitch interpolation.

Public variable

uint32

 

PitchResetFrame

The frame count (from frames generated) to reset the pitch param.

Public variable

float

 

PitchScale

Public variable

uint32

 

TotalNumFrames

Total number of frames of source file.

Public variable

FParam

 

VolumeParam

The volume param object, allows easy volume interpolation.

Public variable

uint32

 

VolumeResetFrame

The frame count (from frames generated) to reset the volume param.

Constructors

Name Description

Public function

FSourceInfo()

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