Navigation
API > API/Runtime > API/Runtime/AudioExtensions
Handle to a modulator which interacts with the modulation API to manage lifetime of modulator proxy objects internal to modulation plugin implementation.
| Name | FModulatorHandle |
| Type | struct |
| Header File | /Engine/Source/Runtime/AudioExtensions/Public/IAudioModulation.h |
| Include Path | #include "IAudioModulation.h" |
Syntax
struct FModulatorHandle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FModulatorHandle
(
IAudioModulationManager& InModulation, |
IAudioModulation.h | ||
FModulatorHandle
(
FModulatorHandle&& InOther |
IAudioModulation.h | ||
| IAudioModulation.h | |||
FModulatorHandle
(
Audio::FModulationParameter&& InParameter |
IAudioModulation.h | ||
FModulatorHandle
(
const FModulatorHandle& InOther |
IAudioModulation.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FModulatorHandle() |
IAudioModulation.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| HandleId | FModulatorHandleId | IAudioModulation.h | ||
| Modulation | TWeakPtr< IAudioModulationManager > | IAudioModulation.h | ||
| ModulatorId | FModulatorId | IAudioModulation.h | ||
| ModulatorTypeId | FModulatorTypeId | IAudioModulation.h | ||
| Parameter | FModulationParameter | IAudioModulation.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FModulatorHandleId GetHandleId() |
IAudioModulation.h | ||
FModulatorId GetModulatorId() |
IAudioModulation.h | ||
const FModulationParameter & GetParameter() |
IAudioModulation.h | ||
FModulatorTypeId GetTypeId() |
IAudioModulation.h | ||
bool GetValue
(
float& OutValue |
IAudioModulation.h | ||
bool GetValueThreadSafe
(
float& OutValue |
IAudioModulation.h | ||
bool IsValid() |
IAudioModulation.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FModulatorHandle& Other |
IAudioModulation.h | ||
FModulatorHandle & operator=
(
const FModulatorHandle& InOther |
IAudioModulation.h | ||
FModulatorHandle & operator=
(
FModulatorHandle&& InOther |
IAudioModulation.h | ||
bool operator==
(
const FModulatorHandle& Other |
IAudioModulation.h |