IAudioModulation

Windows
MacOS
Linux

Inheritance Hierarchy

IAudioModulation

FAudioModulation

References

Module

AudioExtensions

Header

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

Include

#include "IAudioExtensionPlugin.h"

Syntax

class IAudioModulation

Destructors

Name Description

Public function Virtual

~IAudioModulation()

Virtual destructor

Functions

Name Description

Public function Virtual

float

 

CalculateInitialVolume

(
    const USoundModulationPluginSourceS...
)

Calculates initial volume to determine if sound is audible using base settings data

Public function Virtual

void

 

Initialize

(
    const FAudioPluginInitializationPar...
)

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

Public function Virtual

void

 

OnInitSound

(
    ISoundModulatable& Sound,
    const USoundModulationPluginSourceS...
)

Called when a USoundBase type begins playing a sound

Public function Virtual

void

 

OnInitSource

(
    const uint32 SourceId,
    const FName& AudioComponentUserId,
    const uint32 NumChannels,
    const USoundModulationPluginSourceS...
)

Called when a source is assigned to a voice

Public function Virtual

bool

 

OnPostHelp

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

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

Public function Virtual

void

 

OnReleaseSound

(
    ISoundModulatable& Sound
)

Called when a USoundBase type stops playing any sounds

Public function Virtual

void

 

OnReleaseSource

(
    const uint32 SourceId
)

Called when a source is done playing and is released

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

bool

 

ProcessControls

(
    const uint32 SourceId,
    FSoundModulationControls& Controls
)

Processes modulated sound controls, returning whether or not controls were modified and an update is pending.

Public function Virtual

void

 

ProcessModulators

(
    const float Elapsed
)

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