FSubmixEffectDynamicsProcessor

Windows
MacOS
Linux

Inheritance Hierarchy

FSoundEffectSubmix

ISubmixBufferListener

FSubmixEffectDynamicsProcessor

References

Module

AudioMixer

Header

/Engine/Source/Runtime/AudioMixer/Classes/SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h

Include

#include "SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h"

Syntax

class FSubmixEffectDynamicsProcessor :
    public FSoundEffectSubmix,
    public ISubmixBufferListener

Variables

Name Description

Protected variable

Audio::AlignedF...

 

AudioExternal

Protected variable

TArray< float >

 

AudioInputFrame

Protected variable

TArray< float >

 

AudioKeyFrame

Protected variable

TArray< float >

 

AudioOutputFrame

Protected variable

FThreadSafeBool

 

bUseExternalSubmix

Protected variable

FDelegateHandle

 

DeviceCreatedHandle

Protected variable

Audio::FDeviceI...

 

DeviceId

Protected variable

Audio::FDynamic...

 

DynamicsProcessor

Protected variable

TWeakObjectPtr<...

 

ExternalSubmix

Constructors

Destructors

Functions

Name Description

Public function Const

Audio::FDevi...

 

GetDeviceId()

Gets the effect's deviceId that owns it.

Protected function

void

 

OnNewDeviceCreated

(
    Audio::FDeviceId InDeviceId
)

Public function

void

 

SetExternalSubmix

(
    USoundSubmix* InSoundSubmix
)

Overridden from FSoundEffectSubmix

Name Description

Public function Virtual

void

 

Init

(
    const FSoundEffectSubmixInitData& ...
)

Called on an audio effect at initialization on audio thread before audio processing begins.

Public function Virtual

void

 

OnProcessAudio

(
    const FSoundEffectSubmixInputData&...,
    FSoundEffectSubmixOutputData& OutD...
)

Process the input block of audio. Called on audio render thread.

Overridden from FSoundEffectBase

Name Description

Public function Virtual

void

 

OnPresetChanged()

Called when an audio effect preset is changed.

Overridden from ISubmixBufferListener

Name Description

Protected function Virtual

void

 

OnNewSubmixBuffer

(
    const USoundSubmix* OwningSubm...,
    float* AudioData,
    int32 NumSamples,
    int32 NumChannels,
    const int32 SampleRate,
    double AudioClock
)

Called when a new buffer has been rendered for a given submix

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