FModulatorHandle

Handle to a modulator which interacts with the modulation API to manage lifetime of modulator proxy objects internal to modulation plugin implementation.

Choose your operating system:

Windows

macOS

Linux

References

Module

AudioExtensions

Header

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

Include

#include "IAudioModulation.h"

Syntax

struct FModulatorHandle

Remarks

Handle to a modulator which interacts with the modulation API to manage lifetime of modulator proxy objects internal to modulation plugin implementation.

Constructors

Name Description

Public function

FModulatorHandle()

Public function

FModulatorHandle

(
    Audio::FModulationParameter&& InPa...
)

Public function

FModulatorHandle

(
    const FModulatorHandle& InOther
)

Public function

FModulatorHandle

(
    FModulatorHandle&& InOther
)

Public function

FModulatorHandle

(
    IAudioModulationManager& InModulat...,
    const Audio::IModulatorSettings& I...,
    Audio::FModulationParameter&& InPa...
)

Destructors

Name Description

Public function

~FModulatorHandle()

Functions

Name Description

Public function Const

FModulatorHa...

 

GetHandleId()

Public function Const

FModulatorId

 

GetModulatorId()

Public function Const

const FModul...

 

GetParameter()

Public function Const

FModulatorTy...

 

GetTypeId()

Public function Const

bool

 

GetValue

(
    float& OutValue
)

Public function Const

bool

 

GetValueThreadSafe

(
    float& OutValue
)

Public function Const

bool

 

IsValid()

Operators

Name Description

Public function

FModulatorHa...

 

operator=

(
    const FModulatorHandle& InOther
)

Public function

FModulatorHa...

 

operator=

(
    FModulatorHandle&& InOther
)