IAudioModulation

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IAudioModulation

FAudioModulation

References

Module

AudioExtensions

Header

/Engine/Source/Runtime/AudioExtensions/Public/IAudioModulation.h

Include

#include "IAudioModulation.h"

Syntax

class IAudioModulation

Destructors

Name Description

Public function Virtual

~IAudioModulation()

Virtual destructor

Functions

Name Description

Protected function Virtual Const

bool

 

GetModulatorValue

(
    const Audio::FModulatorHandle& Mod...,
    float& OutValue
)

Public function Virtual

Audio::FModu...

 

GetParameter

(
    FName InParamName
)

Returns parameter info for the given parameter name

Public function Virtual

void

 

Initialize

(
    const FAudioPluginInitializationPar...
)

Initialize the modulation plugin with the same rate and number of sources

Public function Virtual

void

 

OnAuditionEnd()

Public function Virtual

bool

 

OnPostHelp

(
    FCommonViewportClient* Viewpor...,
    const TCHAR* Stream
)

Request to post help from active plugin (non-shipping builds only)

Public function Virtual

int32

 

OnRenderStat

(
    FViewport* Viewport,
    FCanvas* Canvas,
    int32 X,
    int32 Y,
    const UFont& Font,
    const FVector* ViewLocation,
    const FRotator* ViewRotation
)

Render stats pertaining to modulation (non-shipping builds only)

Public function Virtual

bool

 

OnToggleStat

(
    FCommonViewportClient* Viewpor...,
    const TCHAR* Stream
)

Toggle showing render stats pertaining to modulation (non-shipping builds only)

Public function Virtual

void

 

ProcessAudio

(
    const FAudioPluginSourceInputData&...,
    FAudioPluginSourceOutputData& Outp...
)

UE_BUILD_SHIPPING.

Public function Virtual

void

 

ProcessModulators

(
    const double InElapsed
)

Processes all modulators Run on the audio render thread prior to processing audio

Protected function Virtual

void

 

RegisterModulator

(
    uint32 InHandleId,
    Audio::FModulatorId InModulatorId
)

Protected function Virtual

Audio::FModu...

 

RegisterModulator

(
    uint32 InHandleId,
    const USoundModulatorBase* InM...,
    Audio::FModulationParameter& OutPa...
)

Protected function Virtual

void

 

UnregisterModulator

(
    const Audio::FModulatorHandle& InH...
)

Public function Virtual

void

 

UpdateModulator

(
    const USoundModulatorBase& InModul...
)