Navigation
API > API/Plugins > API/Plugins/MetasoundEngine
Blueprint-facing interface to a FMetasoundGenerator on a UAudioComponent.
| Name | UMetasoundGeneratorHandle |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Metasound/Source/MetasoundEngine/Public/MetasoundGeneratorHandle.h |
| Include Path | #include "MetasoundGeneratorHandle.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, Category="MetaSound",
Meta=(DisplayName="MetaSound Generator Handle"))
class UMetasoundGeneratorHandle : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMetasoundGeneratorHandle
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnAttached | TMulticastDelegate_NoParams< void > | UMetasoundGeneratorHandle shields its "clients" from "cross thread" issues related to callbacks coming in the audio control or rendering threads that game thread clients (e.g. blueprints) want to know about. | MetasoundGeneratorHandle.h |
| FOnDetached | TMulticastDelegate_NoParams< void > | MetasoundGeneratorHandle.h | |
| FOnIOUpdated | TMulticastDelegate_NoParams< void > | MetasoundGeneratorHandle.h | |
| FOnIOUpdatedWithChanges | TMulticastDelegate_OneParam< void, const TArray< Metasound::FVertexInterfaceChange > & > | MetasoundGeneratorHandle.h | |
| FOnSetGraph | TMulticastDelegate_NoParams< void > | MetasoundGeneratorHandle.h | |
| FOnSetGraphMulticast | TMulticastDelegate_NoParams< void > | MetasoundGeneratorHandle.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnGeneratorHandleAttached | FOnAttached | MetasoundGeneratorHandle.h | ||
| OnGeneratorHandleDetached | FOnDetached | MetasoundGeneratorHandle.h | ||
| OnIOUpdated | FOnIOUpdated | MetasoundGeneratorHandle.h | ||
| OnIOUpdatedWithChanges | FOnIOUpdatedWithChanges | MetasoundGeneratorHandle.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| GeneratorHandle | TSharedPtr< Metasound::FMetasoundGeneratorHandle > | MetasoundGeneratorHandle.h | ||
| OnGeneratorsGraphChanged | FOnSetGraphMulticast | MetasoundGeneratorHandle.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDelegateHandle AddGraphSetCallback
(
UMetasoundGeneratorHandle::FOnSetGraph::FDelegate&& Delegate |
MetasoundGeneratorHandle.h | ||
bool ApplyParameterPack
(
UMetasoundParameterPack* Pack |
Makes a copy of the supplied parameter pack and passes it to the MetaSoundGenerator for asynchronous processing. | MetasoundGeneratorHandle.h |
|
void EnableRuntimeRenderTiming
(
bool Enable |
Enable the profiling of the MetaSound render for this playing instance. | MetasoundGeneratorHandle.h |
|
uint64 GetAudioComponentId () |
Get the id for the UAudioComponent associated with this handle. | MetasoundGeneratorHandle.h | |
double GetCPUCoreUtilization () |
Get the CPU usage as "fraction of real time" used to render this metasound. | MetasoundGeneratorHandle.h |
|
TSharedPtr< Metasound::FMetasoundGenerator > GetGenerator () |
Get a shared pointer to the generator, if available. | MetasoundGeneratorHandle.h | |
bool IsValid() |
MetasoundGeneratorHandle.h | ||
bool RemoveGraphSetCallback
(
const FDelegateHandle& Handle |
MetasoundGeneratorHandle.h | ||
bool TryCreateAnalyzerAddress
(
const FName OutputName, |
MetasoundGeneratorHandle.h | ||
void UpdateWatchers() |
Update any watched outputs | MetasoundGeneratorHandle.h |
|
bool WatchOutput
(
FName OutputName, |
Watch an output value. | MetasoundGeneratorHandle.h |
|
bool WatchOutput
(
FName OutputName, |
MetasoundGeneratorHandle.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
MetasoundGeneratorHandle.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UMetasoundGeneratorHandle * CreateMetaSoundGeneratorHandle
(
UAudioComponent* OnComponent |
MetasoundGeneratorHandle.h |
|
|
| Map a type name to a passthrough analyzer name to use as a default for UMetasoundOutputSubsystem::WatchOutput() | MetasoundGeneratorHandle.h |