FSoundSourceDecoder

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FGCObject

FSoundSourceDecoder

References

Module

AudioMixer

Header

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

Include

#include "SoundWaveDecoder.h"

Syntax

class FSoundSourceDecoder : public FGCObject

Constructors

Name Description

Public function

FSoundSourceDecoder()

Destructors

Name Description

Public function Virtual

~FSoundSourceDecoder()

Functions

Name Description

Public function

FDecodingSou...

 

CreateSourceHandle

(
    USoundWave* InSoundWave
)

Creates a new decoding sound source handle.

Public function

bool

 

GetSourceBuffer

(
    const FDecodingSoundSourceHandle& ...,
    const int32 NumOutFrames,
    const int32 NumOutChannels,
    FAlignedFloatBuffer& OutAudioBuffe...
)

Get a decoded buffer for the given decoding sound wave handle. Call only from audio render thread or audio render thread task.

Public function

void

 

Init

(
    FAudioDevice* InAudioDevice,
    int32 SampleRate
)

Initialize the source decoder at the given output sample rate Sources will automatically sample rate convert to match this output

Public function

bool

 

InitDecodingSource

(
    const FSourceDecodeInit& InitData
)

Initialize a decoding instance of this sound wave object. Call only from game thread.

Public function Const

bool

 

IsFinished

(
    const FDecodingSoundSourceHandle& ...
)

Queries if the decoding source is finished.

Public function Const

bool

 

IsInitialized

(
    const FDecodingSoundSourceHandle& ...
)

Public function

void

 

RemoveDecodingSource

(
    const FDecodingSoundSourceHandle& ...
)

Removes the decoding source from the decoder.

Public function

void

 

Reset()

Resets internal state of decoder.

Public function

void

 

SetSourcePitchScale

(
    const FDecodingSoundSourceHandle& ...,
    float InPitchScale
)

Sets the source pitch scale.

Public function

void

 

SetSourceVolumeScale

(
    const FDecodingSoundSourceHandle& ...,
    float InVolumeScale
)

Sets the source volume scale.

Public function

void

 

Update()

Called from the audio thread.

Public function

void

 

UpdateRenderThread()

Called from the audio render thread.

Overridden from FGCObject

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

Pure virtual that must be overloaded by the inheriting class.

Public function Virtual Const

FString

 

GetReferencerName()

Use this method to report a name for your referencer.