FMetasoundGeneratorHandle | Unreal Engine 5.5 Documentation

API > API/Plugins > API/Plugins/MetasoundEngine

Inheritance Hierarchy

FSharedFromThisBase
TSharedFromThis
FMetasoundGeneratorHandle

References


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

Syntax

class FMetasoundGeneratorHandle : public TSharedFromThis< FMetasoundGeneratorHandle >

Remarks

User-facing interface to a FMetasoundGenerator on a UAudioComponent.

Variables

Type	Name	Description
FOnGeneratorIOUpdated	OnGeneratorIOUpdated	Fires on the game thread when the generator's graph inputs or outputs change.
FOnGeneratorIOUpdatedWithChanges	OnGeneratorIOUpdatedWithChanges	Fires on the game thread when the generator's graph inputs or outputs change, and includes a list of those changes.
FOnGeneratorSet	OnGeneratorSet	Fires on the game thread when a generator is set or unset on this handle.
FOnGeneratorGraphSet	OnGraphUpdated	Fires on the game thread when a graph is updated on the generator.

Constructors

	Type	Name	Description
		FMetasoundGeneratorHandle ( FPrivateToken, TWeakObjectPtr< UAudioComponent >&& InAudioComponent )	NOTE: This constructor is effectively private, but will work with TSharedPtr/TSharedFromThis.

Destructors

	Type	Name	Description
		~FMetasoundGeneratorHandle ()

Functions

Type	Name	Description
TSharedPtr< FMetasoundGeneratorHandle >	Create ( TWeakObjectPtr< UAudioComponent >&& InAudioComponent )	Create a handle to a MetaSound generator on the given audio component
void	EnableRuntimeRenderTiming ( bool Enable )	Enable the profiling of the MetaSound render for this playing instance.
uint64	GetAudioComponentId ()	Get the id for the UAudioComponent associated with this handle.
double	GetCPUCoreUtilization ()	Get the CPU usage as "fraction of real time" used to render this metasound.
TSharedPtr< FMetasoundGenerator >	GetGenerator ()
bool	IsValid ()	Find out if this handle is still valid.
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()
FString	ToString ()	Returns a text representation of this generator handle, useful for logging
bool	TryCreateAnalyzerAddress ( const FName OutputName, const FName AnalyzerName, const FName AnalyzerOutputName, Frontend::FAnalyzerAddress& OutAnalyzerAddress )
bool	UnwatchOutput ( FName OutputName, const FOnMetasoundOutputValueChanged& OnOutputValueChanged, FName AnalyzerName, FName AnalyzerOutputName )	Unwatch/Stop watching an output value
bool	UnwatchOutput ( FName OutputName, const FOnMetasoundOutputValueChangedNative& OnOutputValueChanged, FName AnalyzerName, FName AnalyzerOutputName )
bool	UnwatchOutput ( FName OutputName, const FDelegateHandle& OnOutputValueChanged, FName AnalyzerName, FName AnalyzerOutputName )
void	UpdateOutputWatchers ()	Update any watched outputs
void	UpdateParameters ( const UMetasoundParameterPack& ParameterPack )	Update the current parameter state on this handle and enqueue the changes on the generator.
bool	WatchOutput ( FName OutputName, const FOnMetasoundOutputValueChanged& OnOutputValueChanged, FName AnalyzerName, FName AnalyzerOutputName )	Watch an output value.
bool	WatchOutput ( FName OutputName, const FOnMetasoundOutputValueChangedNative& OnOutputValueChanged, FName AnalyzerName, FName AnalyzerOutputName )