1. Epic GamesDeveloper
  3. UMetaSoundBuilderSubsystem

UMetaSoundBuilderSubsystem

The subsystem in charge of tracking MetaSound builders

API > API/Plugins > API/Plugins/MetasoundEngine

The subsystem in charge of tracking MetaSound builders

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

Syntax

UCLASS (MinimalAPI, Meta=(DisplayName="MetaSound Builder Subsystem"))  
class UMetaSoundBuilderSubsystem : public UEngineSubsystem

Inheritance Hierarchy

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
NamedBuilders TMap< FName, TObjectPtr< UMetaSoundBuilderBase > >   MetasoundBuilderSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UMetaSoundBuilderBase & AttachBuilderToAssetChecked ( UObject& InObject
) const

   MetasoundBuilderSubsystem.h  

UMetaSoundPatchBuilder * AttachPatchBuilderToAsset ( UMetaSoundPatch* InPatch
) const

   MetasoundBuilderSubsystem.h  

UMetaSoundSourceBuilder * AttachSourceBuilderToAsset ( UMetaSoundSource* InSource
) const

   MetasoundBuilderSubsystem.h  

FMetasoundFrontendLiteral CreateBoolArrayMetaSoundLiteral ( const TArray< bool >& Value,
FName& DataType
)

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(DisplayName="Create MetaSound Bool Array Literal")

FMetasoundFrontendLiteral CreateBoolMetaSoundLiteral ( bool Value,
FName& DataType
)

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(DisplayName="Create MetaSound Bool Literal")

FMetasoundFrontendLiteral CreateFloatArrayMetaSoundLiteral ( const TArray< float >& Value,
FName& DataType
)

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(DisplayName="Create MetaSound Float Array Literal")

FMetasoundFrontendLiteral CreateFloatMetaSoundLiteral ( float Value,
FName& DataType
)

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(DisplayName="Create MetaSound Float Literal")

FMetasoundFrontendLiteral CreateIntArrayMetaSoundLiteral ( const TArray< int32 >& Value,
FName& DataType
)

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(DisplayName="Create MetaSound Int Array Literal")

FMetasoundFrontendLiteral CreateIntMetaSoundLiteral ( int32 Value,
FName& DataType
)

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(DisplayName="Create MetaSound Int Literal")

FMetasoundFrontendLiteral CreateMetaSoundLiteralFromParam ( const FAudioParameter& Param
)

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(DisplayName="Create MetaSound Literal From AudioParameter")

FMetasoundFrontendLiteral CreateObjectArrayMetaSoundLiteral ( const TArray< UObject* >& Value
)

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(DisplayName="Create MetaSound Object Array Literal")

FMetasoundFrontendLiteral CreateObjectMetaSoundLiteral ( UObject* Value
)

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(DisplayName="Create MetaSound Object Literal")

UMetaSoundPatchBuilder * CreatePatchBuilder ( FName BuilderName,
EMetaSoundBuilderResult& OutResult
)

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

UMetaSoundPatchBuilder * CreatePatchPresetBuilder ( FName BuilderName,
const TScriptInterface< IMetaSoundDocumentInterface >& ReferencedPatchClass,
EMetaSoundBuilderResult& OutResult
)

 Creates a builder that acts on a generated, transient preset MetaSound UObject. Fails if Referenced MetaSound is not a UMetaSoundPatch. MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

UMetaSoundBuilderBase & CreatePresetBuilder ( FName BuilderName,
const TScriptInterface< IMetaSoundDocumentInterface >& ReferencedMetaSound,
EMetaSoundBuilderResult& OutResult
)

   MetasoundBuilderSubsystem.h  

UMetaSoundSourceBuilder * CreateSourceBuilder ( FName BuilderName,
FMetaSoundBuilderNodeOutputHandle& OnPlayNodeOutput,
FMetaSoundBuilderNodeInputHandle& OnFinishedNodeInput,
TArray< FMetaSoundBuilderNodeInputHandle >& AudioOutNodeInputs,
EMetaSoundBuilderResult& OutResult,
EMetaSoundOutputAudioFormat OutputFormat,
bool bIsOneShot
)

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

UMetaSoundSourceBuilder * CreateSourcePresetBuilder ( FName BuilderName,
const TScriptInterface< IMetaSoundDocumentInterface >& ReferencedSourceClass,
EMetaSoundBuilderResult& OutResult
)

 Creates a builder that acts on a generated, transient preset MetaSound UObject. Fails if Referenced MetaSound is not a UMetaSoundSource. MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

FMetasoundFrontendLiteral CreateStringArrayMetaSoundLiteral ( const TArray< FString >& Value,
FName& DataType
)

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(DisplayName="Create MetaSound String Array Literal")

FMetasoundFrontendLiteral CreateStringMetaSoundLiteral ( const FString& Value,
FName& DataType
)

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(DisplayName="Create MetaSound String Literal")

bool DetachBuilderFromAsset ( const FMetasoundFrontendClassName& InClassName
) const

   MetasoundBuilderSubsystem.h  

UMetaSoundBuilderBase * FindBuilder ( FName BuilderName
)

 Returns the builder manually registered with the MetaSound Builder Subsystem with the provided custom name (if previously registered) MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(DisplayName="Find Builder By Name")

UMetaSoundBuilderBase * FindBuilderOfDocument ( TScriptInterface< const IMetaSoundDocumentInterface > InMetaSound
) const

 Returns the builder associated with the given MetaSound (if one exists, transient or asset). MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(DisplayName="Find Builder By MetaSound")

UMetaSoundPatchBuilder * FindPatchBuilder ( FName BuilderName
)

 Returns the patch builder manually registered with the MetaSound Builder Subsystem with the provided custom name (if previously registered) MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

UMetaSoundSourceBuilder * FindSourceBuilder ( FName BuilderName
)

 Returns the source builder manually registered with the MetaSound Builder Subsystem with the provided custom name (if previously registered) MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

virtual void InvalidateDocumentCache ( const FMetasoundFrontendClassName& InClassName
) const

   MetasoundBuilderSubsystem.h  

bool IsInterfaceRegistered ( FName InInterfaceName
) const

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

void PostBuilderAssetTransaction ( const FMetasoundFrontendClassName& InClassName
)

   MetasoundBuilderSubsystem.h  

void RegisterBuilder ( FName BuilderName,
UMetaSoundBuilderBase* Builder
)

 Adds builder to subsystem's registry to make it persistent and easily accessible by multiple systems or Blueprints. MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

void RegisterPatchBuilder ( FName BuilderName,
UMetaSoundPatchBuilder* Builder
)

 Adds builder to subsystem's registry to make it persistent and easily accessible by multiple systems or Blueprints. MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

void RegisterSourceBuilder ( FName BuilderName,
UMetaSoundSourceBuilder* Builder
)

 Adds builder to subsystem's registry to make it persistent and easily accessible by multiple systems or Blueprints. MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

bool SetTargetPage ( FName PageName
)

 Sets the targeted page for all MetaSound graph & input default to resolve against. MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="MetaSounds|Pages"

bool UnregisterBuilder ( FName BuilderName
)

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

bool UnregisterPatchBuilder ( FName BuilderName
)

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

bool UnregisterSourceBuilder ( FName BuilderName
)

   MetasoundBuilderSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

Static

Name Remarks Include Path Unreal Specifiers
  MetasoundBuilderSubsystem.h  

static UMetaSoundBuilderSubsystem & GetChecked()

   MetasoundBuilderSubsystem.h  

static const UMetaSoundBuilderSubsystem * GetConst()

   MetasoundBuilderSubsystem.h  

static const UMetaSoundBuilderSubsystem & GetConstChecked()

   MetasoundBuilderSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page