1. Epic GamesDeveloper
  3. UMetasoundGeneratorHandle

UMetasoundGeneratorHandle

Blueprint-facing interface to a FMetasoundGenerator on a UAudioComponent.

API > API/Plugins > API/Plugins/MetasoundEngine

Inheritance Hierarchy

References

   
Module MetasoundEngine
Header /Engine/Plugins/Runtime/Metasound/Source/MetasoundEngine/Public/MetasoundGeneratorHandle.h
Include #include "MetasoundGeneratorHandle.h"

Syntax

UCLASS (BlueprintType, Category="MetaSound", Meta=(DisplayName="MetaSound Generator Handle"))  
class UMetasoundGeneratorHandle : public UObject

Remarks

Blueprint-facing interface to a FMetasoundGenerator on a UAudioComponent.

Variables

  Type Name Description
Public variable FOnAttached OnGeneratorHandleAttached  
Public variable FOnDetached OnGeneratorHandleDetached  
Public variable FOnIOUpdated OnIOUpdated  
Public variable FOnIOUpdatedWithChanges OnIOUpdatedWithChanges  

Functions

  Type Name Description
Public function FDelegateHandle

AddGraphSetCallback ( UMetasoundGeneratorHandle::FOnSetGraph::FDelegate&& Delegate
)

  
Public function UFunction BlueprintCallable, Category bool Makes a copy of the supplied parameter pack and passes it to the MetaSoundGenerator for asynchronous processing.
Public function Static UFunction BlueprintCallable, Category UMetasoundGeneratorHandle *

CreateMetaSoundGeneratorHandle ( UAudioComponent* OnComponent
)

  
Public function Const UFunction BlueprintCallable, Category void

EnableRuntimeRenderTiming ( bool Enable
)

 Enable the profiling of the MetaSound render for this playing instance.
Public function Const uint64 Get the id for the UAudioComponent associated with this handle.
Public function Const UFunction BlueprintCallable, Category double Get the CPU usage as "fraction of real time" used to render this metasound.
Public function Const TSharedPtr< Metasound::FMetasoundGenerator > Get a shared pointer to the generator, if available.
Public function Const bool

IsValid ()

  
Public function Static void

RegisterPassthroughAnalyzerForType ( FName TypeName,
FName AnalyzerName,
FName OutputName
)

 Map a type name to a passthrough analyzer name to use as a default for UMetasoundOutputSubsystem::WatchOutput()
Public function bool  
Public function bool

TryCreateAnalyzerAddress ( const FName OutputName,
const FName AnalyzerName,
const FName AnalyzerOutputName,
Metasound::Frontend::FAnalyzerAddress& OutAnalyzerAddress
)

  
Public function Const UFunction BlueprintCallable, Category void Update any watched outputs
Public function UFunction BlueprintCallable, Category, Meta bool

WatchOutput ( FName OutputName,
const FOnMetasoundOutputValueChanged& OnOutputValueChanged,
FName AnalyzerName,
FName AnalyzerOutputName
)

 Watch an output value.
Public function bool

WatchOutput ( FName OutputName,
const FOnMetasoundOutputValueChangedNative& OnOutputValueChanged,
FName AnalyzerName,
FName AnalyzerOutputName
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.

Typedefs

Name Description
FOnAttached 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.
FOnDetached  
FOnIOUpdated  
FOnIOUpdatedWithChanges  
FOnSetGraph  
FOnSetGraphMulticast  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page