1. Epic GamesDeveloper
  3. FMetasoundGeneratorHandle

FMetasoundGeneratorHandle

User-facing interface to a FMetasoundGenerator on a [UAudioComponent](API\Runtime\Engine\UAudioComponent).

API > API/Plugins > API/Plugins/MetasoundEngine

User-facing interface to a FMetasoundGenerator on a UAudioComponent.

   
Name FMetasoundGeneratorHandle
Type class
Header File /Engine/Plugins/Runtime/Metasound/Source/MetasoundEngine/Public/MetasoundGeneratorHandle.h
Include Path #include "MetasoundGeneratorHandle.h"

Syntax

class FMetasoundGeneratorHandle : public TSharedFromThis< FMetasoundGeneratorHandle >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FMetasoundGeneratorHandle ( FPrivateToken,
TWeakObjectPtr< UAudioComponent >&& InAudioComponent
)

 NOTE: This constructor is effectively private, but will work with TSharedPtr/TSharedFromThis. MetasoundGeneratorHandle.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FMetasoundGeneratorHandle()

   MetasoundGeneratorHandle.h  

Structs

Name Remarks
FOutputPayload  
FOutputWatcher Info about an output being watched by one or more listeners
FOutputWatcherKey  
FPassthroughAnalyzerInfo  
FPrivateToken  
FWatchOutputUnifiedDelegate  
FWatchOutputUnifiedMulticastDelegate  

Typedefs

Name Type Remarks Include Path
FOnGeneratorGraphSet TBaseDelegate_NoParams< void >   MetasoundGeneratorHandle.h
FOnGeneratorIOUpdated TBaseDelegate_NoParams< void >   MetasoundGeneratorHandle.h
FOnGeneratorIOUpdatedWithChanges TBaseDelegate_OneParam< void, const TArray< FVertexInterfaceChange > & >   MetasoundGeneratorHandle.h
FOnGeneratorSet TBaseDelegate_OneParam< void, TWeakPtr< FMetasoundGenerator > && >   MetasoundGeneratorHandle.h

Constants

Name Type Remarks Include Path
ChangedOutputsQueueMax int32 Keep ChangedOutputs from growing infinitely. MetasoundGeneratorHandle.h
PassthroughAnalyzers TMap< FName, FPassthroughAnalyzerInfo >   MetasoundGeneratorHandle.h

Variables

Public

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

Protected

Name Type Remarks Include Path Unreal Specifiers
AudioComponent TWeakObjectPtr< UAudioComponent >   MetasoundGeneratorHandle.h  
AudioComponentId const uint64   MetasoundGeneratorHandle.h  
bRuntimeRenderTimingShouldBeEnabled bool   MetasoundGeneratorHandle.h  
ChangedOutputs TSpscQueue< FOutputPayload >   MetasoundGeneratorHandle.h  
ChangedOutputsQueueCount std::atomic< int32 >   MetasoundGeneratorHandle.h  
ChangedOutputsQueueShouldLogIfFull std::atomic< bool >   MetasoundGeneratorHandle.h  
CurrentGeneratorInstanceID uint64   MetasoundGeneratorHandle.h  
Generator TWeakPtr< FMetasoundGenerator >   MetasoundGeneratorHandle.h  
GeneratorCreatedDelegateHandle FDelegateHandle   MetasoundGeneratorHandle.h  
GeneratorDestroyedDelegateHandle FDelegateHandle   MetasoundGeneratorHandle.h  
GeneratorGraphSetDelegateHandle FDelegateHandle   MetasoundGeneratorHandle.h  
GeneratorOutputChangedDelegateHandle FDelegateHandle   MetasoundGeneratorHandle.h  
GeneratorVertexInterfaceChangedDelegateHandle FDelegateHandle   MetasoundGeneratorHandle.h  
LatestParameterState FSharedMetasoundParameterStoragePtr   MetasoundGeneratorHandle.h  
OutputWatchers TMap< FOutputWatcherKey, FOutputWatcher >   MetasoundGeneratorHandle.h  
OutputWatcherUpdateScheduled std::atomic_flag   MetasoundGeneratorHandle.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void EnableRuntimeRenderTiming ( bool Enable
)

 Enable the profiling of the MetaSound render for this playing instance. MetasoundGeneratorHandle.h  
Get the id for the UAudioComponent associated with this handle. MetasoundGeneratorHandle.h  
Get the CPU usage as "fraction of real time" used to render this metasound. MetasoundGeneratorHandle.h  

TSharedPtr< FMetasoundGenerator > GetGenerator()

   MetasoundGeneratorHandle.h  

bool IsValid()

 Find out if this handle is still valid. MetasoundGeneratorHandle.h  

FString ToString()

 Returns a text representation of this generator handle, useful for logging MetasoundGeneratorHandle.h  

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

   MetasoundGeneratorHandle.h  

bool UnwatchOutput ( FName OutputName,
const FDelegateHandle& OnOutputValueChanged,
FName AnalyzerName,
FName AnalyzerOutputName
)

   MetasoundGeneratorHandle.h  

bool UnwatchOutput ( FName OutputName,
const FOnMetasoundOutputValueChangedNative& OnOutputValueChanged,
FName AnalyzerName,
FName AnalyzerOutputName
)

   MetasoundGeneratorHandle.h  

bool UnwatchOutput ( FName OutputName,
const FOnMetasoundOutputValueChanged& OnOutputValueChanged,
FName AnalyzerName,
FName AnalyzerOutputName
)

 Unwatch/Stop watching an output value MetasoundGeneratorHandle.h  

void UpdateOutputWatchers()

 Update any watched outputs MetasoundGeneratorHandle.h  

void UpdateParameters ( const UMetasoundParameterPack& ParameterPack
)

 Update the current parameter state on this handle and enqueue the changes on the generator. MetasoundGeneratorHandle.h  

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

 Watch an output value. MetasoundGeneratorHandle.h  

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

   MetasoundGeneratorHandle.h  

Static

Name Remarks Include Path Unreal Specifiers

static TSharedPtr< FMetasoundGeneratorHandle > Create ( TWeakObjectPtr< UAudioComponent >&& InAudioComponent
)

 Create a handle to a MetaSound generator on the given audio component MetasoundGeneratorHandle.h  

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() MetasoundGeneratorHandle.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page