Navigation
API > API/Plugins > API/Plugins/MetasoundEngine
Inheritance Hierarchy
- UEngineSubsystem
- IDocumentBuilderRegistry
- UMetaSoundBuilderSubsystem
References
| Module | MetasoundEngine |
| Header | /Engine/Plugins/Runtime/Metasound/Source/MetasoundEngine/Public/MetasoundBuilderSubsystem.h |
| Include | #include "MetasoundBuilderSubsystem.h" |
Syntax
UCLASS ()
class UMetaSoundBuilderSubsystem :
public UEngineSubsystem,
public Metasound::Frontend::IDocumentBuilderRegistry
Remarks
The subsystem in charge of tracking MetaSound builders
Variables
| Type | Name | Description | |
|---|---|---|---|
| FMetaSoundBuilderNodeOutputHandleFMetaSoundBuilderNodeInputHandleTArray< FMetaSoundBuilderNodeInputH... | AudioOutNodeInputs | ||
| FMetaSoundBuilderNodeOutputHandleFMetaSoundBuilderNodeInputHandleTArray< FMetaSoundBuilderNodeInputH... | bIsOneShot | ||
| FName & | DataType | ||
| FMetaSoundBuilderNodeOutputHandleFMetaSoundBuilderNodeInputHandle & | OnFinishedNodeInput | ||
| FMetaSoundBuilderNodeOutputHandle & | OnPlayNodeOutput | ||
| FMetaSoundBuilderNodeOutputHandleFMetaSoundBuilderNodeInputHandleTArray< FMetaSoundBuilderNodeInputH... | OutputFormat | ||
| const TScriptInterface< IMetaSoundDocumentInterface > EMetaSoundBuilderResult & | OutResult | ||
| FMetaSoundBuilderNodeOutputHandleFMetaSoundBuilderNodeInputHandleTArray< FMetaSoundBuilderNodeInputH... | OutResult | ||
| EMetaSoundBuilderResult & | OutResult | ||
| const TScriptInterface< IMetaSoundDocumentInterface > & | ReferencedPatchClass | ||
| const TScriptInterface< IMetaSoundDocumentInterface > & | ReferencedSourceClass |
Functions
| Type | Name | Description | |
|---|---|---|---|
| UMetaSoundBuilderBase & | AttachBuilderToAssetChecked
(
UObject& InMetaSound |
||
| UMetaSoundPatchBuilder * | AttachPatchBuilderToAsset
(
UMetaSoundPatch* InPatch |
Moving toward becoming UFUNCTIONS in the future, but right now unguarded case where a user could improperly reference transient assets. | |
| UMetaSoundSourceBuilder * | AttachSourceBuilderToAsset
(
UMetaSoundSource* InSource |
||
| UMetaSoundBuilderBase & | CreatePresetBuilder
(
FName BuilderName, |
||
| bool | DetachBuilderFromAsset
(
const FMetasoundFrontendClassName& InClassName |
||
| UMetaSoundBuilderSubsystem * | Get () |
||
| UMetaSoundBuilderSubsystem & | GetChecked () |
||
| const UMetaSoundBuilderSubsystem * | GetConst () |
||
| const UMetaSoundBuilderSubsystem & | |||
| void | Initialize
(
FSubsystemCollectionBase& Collection |
||
| void | PostBuilderAssetTransaction
(
const FMetasoundFrontendClassName& InClassName |
Updates builder data should a builder-managed asset be updated via the transaction stack. | |
| void | RegisterBuilder
(
FName BuilderName, |
Adds builder to subsystem's registry to make it persistent and easily accessible by multiple systems or Blueprints. | |
| void | RegisterPatchBuilder
(
FName BuilderName, |
Adds builder to subsystem's registry to make it persistent and easily accessible by multiple systems or Blueprints. | |
| void | RegisterSourceBuilder
(
FName BuilderName, |
Adds builder to subsystem's registry to make it persistent and easily accessible by multiple systems or Blueprints. | |
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
Returns the source builder manually registered with the MetaSound Builder Subsystem with the provided custom name (if previously registered) | ||
UPARAM
(
DisplayName |
Returns the patch builder manually registered with the MetaSound Builder Subsystem with the provided custom name (if previously registered) | ||
UPARAM
(
DisplayName |
Returns the builder associated with the given MetaSound (if one exists, transient or asset). | ||
UPARAM
(
DisplayName |
Returns the builder manually registered with the MetaSound Builder Subsystem with the provided custom name (if previously registered) | ||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
|||
UPARAM
(
DisplayName |
Overridden from IDocumentBuilderRegistry
| Type | Name | Description | |
|---|---|---|---|
| void | InvalidateDocumentCache
(
const FMetasoundFrontendClassName& InClassName |
Invalidates the cache of a given document's builder should one be registered, causing it to be rebuilt. |