FAudioModulation

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IAudioModulation

FAudioModulation

References

Module

AudioModulation

Header

/Engine/Plugins/Runtime/AudioModulation/Source/AudioModulation/Public/AudioModulation.h

Include

#include "AudioModulation.h"

Syntax

class FAudioModulation : public IAudioModulation

Constructors

Name Description

Public function

FAudioModulation()

Destructors

Name Description

Public function Virtual

~FAudioModulation()

Functions

Name Description

Public function

void

 

ActivateBus

(
    const USoundControlBus& InBus
)

Public function

void

 

ActivateBusMix

(
    const USoundControlBusMix& InBusMi...
)

Public function

void

 

ActivateGenerator

(
    const USoundModulationGenerator& I...
)

Public function

void

 

DeactivateAllBusMixes()

Public function

void

 

DeactivateBus

(
    const USoundControlBus& InBus
)

Public function

void

 

DeactivateBusMix

(
    const USoundControlBusMix& InBusMi...
)

Public function

void

 

DeactivateGenerator

(
    const USoundModulationGenerator& I...
)

Public function

TArray< FSou...

 

LoadMixFromProfile

(
    const int32 InProfileIndex,
    USoundControlBusMix& OutBusMix
)

Public function

void

 

SaveMixToProfile

(
    const USoundControlBusMix& InBusMi...,
    const int32 InProfileIndex
)

Public function Virtual

void

 

SetDebugBusFilter

(
    const FString* InFilter
)

Public function Virtual

void

 

SetDebugGeneratorFilter

(
    const FString* InFilter
)

Public function Virtual

void

 

SetDebugGeneratorsEnabled

(
    bool bInIsEnabled
)

Public function Virtual

void

 

SetDebugGeneratorTypeFilter

(
    const FString* InFilter,
    bool bInIsEnabled
)

Public function Virtual

void

 

SetDebugMatrixEnabled

(
    bool bInIsEnabled
)

Public function Virtual

void

 

SetDebugMixFilter

(
    const FString* InFilter
)

Public function

void

 

SoloBusMix

(
    const USoundControlBusMix& InBusMi...
)

Public function

void

 

UpdateMix

(
    const USoundControlBusMix& InMix,
    float InFadeTime
)

Public function

void

 

UpdateMix

(
    const TArray< FSoundControlBusMixSt...,
    USoundControlBusMix& InOutMix,
    bool bInUpdateObject,
    float InFadeTime
)

Public function

void

 

UpdateMixByFilter

(
    const FString& InAddressFilter,
    const TSubclassOf< USoundModulation...,
    USoundModulationParameter* InP...,
    float Value,
    float FadeTime,
    USoundControlBusMix& InOutMix,
    bool bInUpdateObject
)

Overridden from IAudioModulation

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

 

ProcessModulators

(
    const double InElapsed
)

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

Protected function Virtual

void

 

RegisterModulator

(
    Audio::FModulatorHandleId InHandleI...,
    Audio::FModulatorId InModulatorId
)

Protected function Virtual

Audio::FModu...

 

RegisterModulator

(
    Audio::FModulatorHandleId InHandleI...,
    const USoundModulatorBase* InM...,
    Audio::FModulationParameter& OutPa...
)

Protected function Virtual

void

 

UnregisterModulator

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

Public function Virtual

void

 

UpdateModulator

(
    const USoundModulatorBase& InModul...
)