FDecodingSoundSource

Choose your operating system:

Windows

macOS

Linux

References

Module

AudioMixer

Header

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

Include

#include "SoundWaveDecoder.h"

Syntax

class FDecodingSoundSource

Constructors

Name Description

Public function

FDecodingSoundSource

(
    FAudioDevice* AudioDevice,
    const FSourceDecodeInit& InitData
)

Destructors

Name Description

Public function

~FDecodingSoundSource()

Functions

Name Description

Public function

bool

 

GetAudioBuffer

(
    const int32 InNumFrames,
    const int32 InNumChannels,
    FAlignedFloatBuffer& OutAudioBuffe...
)

Get audio buffer.

Public function

USoundWave &...

 

GetSoundWave()

Return the underlying sound wave.

Public function

void

 

Init()

Initializes the decoding source.

Public function Const

bool

 

IsFinished()

If the sound source finished playing all its source. Will only return true for non-looping sources.

Public function Const

bool

 

IsInitialized()

Returns if we've been initialized.

Public function

bool

 

IsReadyToInit()

Queries if we're ready to initialize.

Public function

bool

 

PreInit

(
    int32 OutputSampleRate
)

Called before we initialize.

Public function

void

 

SetForceSyncDecode

(
    bool bShouldForceSyncDecode
)

Sets the ForceSyncDecode flag. (Decodes for this soundwave will not happen in an async task if true)

Public function

void

 

SetPitchScale

(
    float InPitchScale,
    uint32 NumFrames
)

Sets the pitch scale.

Public function

void

 

SetVolumeScale

(
    float InVolumeScale,
    uint32 NumFrames
)

Sets the volume scale.