UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::FModulatorHandle Struct Reference

#include <IAudioModulation.h>

Public Member Functions

 FModulatorHandle ()=default
 
AUDIOEXTENSIONS_API FModulatorHandle (Audio::FModulationParameter &&InParameter)
 
AUDIOEXTENSIONS_API FModulatorHandle (IAudioModulationManager &InModulation, const Audio::IModulatorSettings &InModulatorSettings, Audio::FModulationParameter &&InParameter)
 
AUDIOEXTENSIONS_API FModulatorHandle (const FModulatorHandle &InOther)
 
AUDIOEXTENSIONS_API FModulatorHandle (FModulatorHandle &&InOther)
 
AUDIOEXTENSIONS_API ~FModulatorHandle ()
 
AUDIOEXTENSIONS_API FModulatorHandleoperator= (const FModulatorHandle &InOther)
 
AUDIOEXTENSIONS_API FModulatorHandleoperator= (FModulatorHandle &&InOther)
 
AUDIOEXTENSIONS_API FModulatorId GetModulatorId () const
 
AUDIOEXTENSIONS_API const FModulationParameterGetParameter () const
 
AUDIOEXTENSIONS_API FModulatorTypeId GetTypeId () const
 
AUDIOEXTENSIONS_API FModulatorHandleId GetHandleId () const
 
AUDIOEXTENSIONS_API bool GetValue (float &OutValue) const
 
AUDIOEXTENSIONS_API bool GetValueThreadSafe (float &OutValue) const
 
AUDIOEXTENSIONS_API bool IsValid () const
 
bool operator== (const FModulatorHandle &Other) const
 
bool operator!= (const FModulatorHandle &Other) const
 

Friends

uint32 GetTypeHash (const FModulatorHandle &InModulatorHandle)
 

Detailed Description

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

Constructor & Destructor Documentation

◆ FModulatorHandle() [1/5]

Audio::FModulatorHandle::FModulatorHandle ( )
default

◆ FModulatorHandle() [2/5]

Audio::FModulatorHandle::FModulatorHandle ( Audio::FModulationParameter &&  InParameter)

◆ FModulatorHandle() [3/5]

Audio::FModulatorHandle::FModulatorHandle ( IAudioModulationManager InModulation,
const Audio::IModulatorSettings InModulatorSettings,
Audio::FModulationParameter &&  InParameter 
)

◆ FModulatorHandle() [4/5]

Audio::FModulatorHandle::FModulatorHandle ( const FModulatorHandle InOther)

◆ FModulatorHandle() [5/5]

Audio::FModulatorHandle::FModulatorHandle ( FModulatorHandle &&  InOther)

◆ ~FModulatorHandle()

Audio::FModulatorHandle::~FModulatorHandle ( )

Member Function Documentation

◆ GetHandleId()

uint32 Audio::FModulatorHandle::GetHandleId ( ) const

◆ GetModulatorId()

FModulatorId Audio::FModulatorHandle::GetModulatorId ( ) const

◆ GetParameter()

const FModulationParameter & Audio::FModulatorHandle::GetParameter ( ) const

◆ GetTypeId()

FModulatorTypeId Audio::FModulatorHandle::GetTypeId ( ) const

◆ GetValue()

bool Audio::FModulatorHandle::GetValue ( float OutValue) const

◆ GetValueThreadSafe()

bool Audio::FModulatorHandle::GetValueThreadSafe ( float OutValue) const

◆ IsValid()

bool Audio::FModulatorHandle::IsValid ( ) const

◆ operator!=()

bool Audio::FModulatorHandle::operator!= ( const FModulatorHandle Other) const
inline

◆ operator=() [1/2]

FModulatorHandle & Audio::FModulatorHandle::operator= ( const FModulatorHandle InOther)

◆ operator=() [2/2]

FModulatorHandle & Audio::FModulatorHandle::operator= ( FModulatorHandle &&  InOther)

◆ operator==()

bool Audio::FModulatorHandle::operator== ( const FModulatorHandle Other) const
inline

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FModulatorHandle InModulatorHandle)
friend

The documentation for this struct was generated from the following files: