Navigation
API > API/Plugins > API/Plugins/MetasoundEngine
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UMetasoundGeneratorHandle
References
| Module | MetasoundEngine |
| Header | /Engine/Plugins/Runtime/Metasound/Source/MetasoundEngine/Public/MetasoundGeneratorHandle.h |
| Include | #include "MetasoundGeneratorHandle.h" |
Syntax
UCLASS&40;BlueprintType, Category&61;"MetaSound"&41;
class UMetasoundGeneratorHandle : public UObject
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
UMetasoundGeneratorHandle::FOnAttached | OnGeneratorHandleAttached | |
 |
UMetasoundGeneratorHandle::FOnDetached | OnGeneratorHandleDetached |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
FDelegateHandle | AddGraphSetCallback
(
UMetasoundGeneratorHandle::FOnSetGraph::FDelegate&& Delegate |
Note: We don't allow direct assignment to the OnGeneratorsGraphChanged delegate because we need to know that someone actually wants this message so we can start actively listening for the corresponding audio render thread callback... |
   |
bool | ApplyParameterPack
(
UMetasoundParameterPack* Pack |
Makes a copy of the supplied parameter pack and passes it to the MetaSoundGenerator for asynchronous processing. |
    |
UMetasoundGeneratorHandle * | CreateMetaSoundGeneratorHandle
(
UAudioComponent* OnComponent |
|
  |
uint64 | Get the id for the UAudioComponent associated with this handle. | |
 |
TSharedPtr< Metasound::FMetasoundGenerator > | GetGenerator () |
|
  |
bool | IsValid () |
|
  |
void | RegisterPassthroughAnalyzerForType
(
FName TypeName, |
Map a type name to a passthrough analyzer name to use as a default for UMetasoundOutputSubsystem::WatchOutput() |
 |
bool | RemoveGraphSetCallback
(
const FDelegateHandle& Handle |
|
 |
void | Update any watched outputs | |
   |
bool | WatchOutput
(
FName OutputName, |
Watch an output value. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | BeginDestroy () |
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 | |
| FOnSetGraph | |
| FOnSetGraphMulticast | Note: We don't allow direct assignment to the OnGeneratorsGraphChanged delegate because we need to know that someone actually wants this message so we can start actively listening for the corresponding audio render thread callback. |
Constants
| Name | Description |
|---|---|
| PassthroughAnalyzers |