1. Epic GamesDeveloper
  3. UMetaSoundBuilderBase

UMetaSoundBuilderBase

Base implementation of MetaSound builder

API > API/Plugins > API/Plugins/MetasoundEngine

Base implementation of MetaSound builder

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

Syntax

UCLASS (MinimalAPI, Abstract, BlueprintType, Transient,  
       Meta=(DisplayName="MetaSound Builder Base"))  
class UMetaSoundBuilderBase : public UObject

Inheritance Hierarchy

Derived Classes

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
aligned path keys kept   MetasoundBuilderBase.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
BuilderReloadDelegate Metasound::Engine::FOnBuilderReload   MetasoundBuilderBase.h  
LastTransactionRegistered int32   MetasoundBuilderBase.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FMetaSoundBuilderNodeOutputHandle AddGraphInputNode ( FName Name,
FName DataType,
FMetasoundFrontendLiteral DefaultValue,
EMetaSoundBuilderResult& OutResult,
bool bIsConstructorInput
)

 Adds a graph input node with the given name, DataType, and sets the graph input to default value. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult", AdvancedDisplay="3")

FMetaSoundBuilderNodeInputHandle AddGraphOutputNode ( FName Name,
FName DataType,
FMetasoundFrontendLiteral DefaultValue,
EMetaSoundBuilderResult& OutResult,
bool bIsConstructorOutput
)

 Adds a graph output node with the given name, DataType, and sets output node's input to default value. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult", AdvancedDisplay="3")

void AddGraphPage ( FName PageName,
bool bDuplicateLastGraph,
bool bSetAsBuildGraph,
EMetaSoundBuilderResult& OutResult
)

 Adds a graph page to the given builder's document. MetasoundBuilderBase.h  

void AddGraphVariable ( FName Name,
FName DataType,
FMetasoundFrontendLiteral DefaultValue,
EMetaSoundBuilderResult& OutResult
)

 Adds a graph variable node with the given name, DataType, and sets to default value. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

FMetaSoundNodeHandle AddGraphVariableGetDelayedNode ( FName Name,
EMetaSoundBuilderResult& OutResult
)

 Adds a graph variable node with the given name, DataType, and sets to default value. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

FMetaSoundNodeHandle AddGraphVariableGetNode ( FName Name,
EMetaSoundBuilderResult& OutResult
)

 Adds a graph variable node with the given name, DataType, and sets to default value. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

FMetaSoundNodeHandle AddGraphVariableSetNode ( FName Name,
EMetaSoundBuilderResult& OutResult
)

 Adds a graph variable node with the given name, DataType, and sets to default value. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void AddInterface ( FName InterfaceName,
EMetaSoundBuilderResult& OutResult
)

 Adds an interface registered with the given name to the graph, adding associated input and output nodes. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")
Adds a node to the graph using the provided MetaSound asset as its defining NodeClass. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • DisplayName="Add MetaSound Node From Asset Class"
  • Meta=(ExpandEnumAsExecs="OutResult")
  MetasoundBuilderBase.h  
Adds node referencing the highest native class version of the given class name to the document. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • DisplayName="Add MetaSound Node By ClassName"
  • Meta=(ExpandEnumAsExecs="OutResult", AdvancedDisplay="2")
Adds transaction listener which allows objects to respond to when certain graph operations are applied from anywhere (adding or removing nodes, edges, pages, etc.) Currently there is no guarantee all transactions will be represented until the Controller API is fully deprecated! (ex. if a node or edge is added or removed via a controller API call, the transaction will be missed). MetasoundBuilderBase.h  
  MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(WorldContext="Parent", DisplayName="Build (Soft Deprecated. Parent no longer supported and field is ignored.)")
  MetasoundBuilderBase.h  

void BuildAndOverwriteMetaSound ( TScriptInterface< IMetaSoundDocumentInterface > ExistingMetaSound,
bool bForceUniqueClassName
)

 Copies a transient MetaSound with the provided builder options, copying the underlying MetaSound managed by this builder and registering it with the MetaSound Node Registry as a unique name. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(DisplayName="Build And Overwrite MetaSound", AdvancedDisplay="1")
Builds a transient MetaSound with the provided builder options, copying the underlying MetaSound managed by this builder and registering it with the MetaSound Node Registry as a unique class. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(DisplayName="Build New MetaSound")

bool ClearMemberMetadata ( const FGuid& InMemberID
)

   MetasoundBuilderBase.h  

virtual bool ConformObjectToDocument()

   MetasoundBuilderBase.h  

void ConnectGraphInputToNode ( const FName& GraphInputName,
const FMetaSoundNodeHandle& DestinationNode,
const FName& InputName,
EMetaSoundBuilderResult& OutResult
)

   MetasoundBuilderBase.h  

void ConnectNamedNodeOutputToGraphOutput ( const FMetaSoundNodeHandle& SourceNode,
const FName& NodeOutputName,
const FMetaSoundBuilderNodeInputHandle& GraphOutput,
EMetaSoundBuilderResult& OutResult
)

 Connects a given node's named output to the graph output with the given handle. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void ConnectNamedNodeOutputToNamedGraphOutput ( const FMetaSoundNodeHandle& SourceNode,
const FName& NodeOutputName,
const FName& GraphOutputName,
EMetaSoundBuilderResult& OutResult
)

 Connects a given node's named output to the graph output with the given name. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

TArray< FMetaSoundBuilderNodeOutputHandle > ConnectNodeInputsToMatchingGraphInterfaceInputs ( const FMetaSoundNodeHandle& NodeHandle,
EMetaSoundBuilderResult& OutResult
)

 Connects a given node's inputs to all graph inputs for shared interfaces implemented on both the node's referenced class and the builder's MetaSound graph. Returns outputs of connected input nodes. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void ConnectNodeInputToGraphInput ( FName GraphInputName,
const FMetaSoundBuilderNodeInputHandle& NodeInputHandle,
EMetaSoundBuilderResult& OutResult
)

 Connects a given node input to the graph input with the given name. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

TArray< FMetaSoundBuilderNodeInputHandle > ConnectNodeOutputsToMatchingGraphInterfaceOutputs ( const FMetaSoundNodeHandle& NodeHandle,
EMetaSoundBuilderResult& OutResult
)

 Connects a given node's outputs to all graph outputs for shared interfaces implemented on both the node's referenced class and the builder's MetaSound graph. Returns inputs of connected output nodes. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void ConnectNodeOutputToGraphOutput ( FName GraphOutputName,
const FMetaSoundBuilderNodeOutputHandle& NodeOutputHandle,
EMetaSoundBuilderResult& OutResult
)

 Connects a given node output to the graph output with the given name. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void ConnectNodes ( const FMetaSoundBuilderNodeOutputHandle& NodeOutputHandle,
const FMetaSoundBuilderNodeInputHandle& NodeInputHandle,
EMetaSoundBuilderResult& OutResult
)

 Connects node output to a node input. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void ConnectNodes ( const FMetaSoundNodeHandle& SourceNode,
const FName& OutputName,
const FMetaSoundNodeHandle& DestinationNode,
const FName& InputName,
EMetaSoundBuilderResult& OutResult
)

   MetasoundBuilderBase.h  

void ConnectNodesByInterfaceBindings ( const FMetaSoundNodeHandle& FromNodeHandle,
const FMetaSoundNodeHandle& ToNodeHandle,
EMetaSoundBuilderResult& OutResult
)

 Connects two nodes using defined MetaSound Interface Bindings registered with the MetaSound Interface registry. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void ConnectNodeToGraphOutput ( const FMetaSoundNodeHandle& SourceNode,
const FName& NodeOutputName,
const FMetaSoundBuilderNodeInputHandle& GraphOutput,
EMetaSoundBuilderResult& OutResult
)

   MetasoundBuilderBase.h  

void ConnectNodeToGraphOutput ( const FMetaSoundNodeHandle& SourceNode,
const FName& NodeOutputName,
const FName& GraphOutputName,
EMetaSoundBuilderResult& OutResult
)

   MetasoundBuilderBase.h  

bool ContainsNode ( const FMetaSoundNodeHandle& Node
) const

 Returns whether node exists. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

bool ContainsNodeInput ( const FMetaSoundBuilderNodeInputHandle& Input
) const

 Returns whether node input exists. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

bool ContainsNodeOutput ( const FMetaSoundBuilderNodeOutputHandle& Output
) const

 Returns whether node output exists. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

void ConvertFromPreset ( EMetaSoundBuilderResult& OutResult
)

 Converts this preset to a fully accessible MetaSound; sets result to succeeded if it was converted successfully and failed if it was not. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void ConvertToPreset ( const TScriptInterface< IMetaSoundDocumentInterface >& ReferencedNodeClass,
EMetaSoundBuilderResult& OutResult
)

 Convert this builder to a MetaSound source preset with the given referenced source builder. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void DisconnectNodeInput ( const FMetaSoundBuilderNodeInputHandle& NodeInputHandle,
EMetaSoundBuilderResult& OutResult
)

 Removes connection to a given node input. Returns success if connection was removed, failed if not. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void DisconnectNodeOutput ( const FMetaSoundBuilderNodeOutputHandle& NodeOutputHandle,
EMetaSoundBuilderResult& OutResult
)

 Removes all connections from a given node output. Returns success if all connections were removed, failed if not. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void DisconnectNodes ( const FMetaSoundBuilderNodeOutputHandle& NodeOutputHandle,
const FMetaSoundBuilderNodeInputHandle& NodeInputHandle,
EMetaSoundBuilderResult& OutResult
)

 Disconnects node output to a node input. Returns success if connection was removed, failed if not. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void DisconnectNodesByInterfaceBindings ( const FMetaSoundNodeHandle& FromNodeHandle,
const FMetaSoundNodeHandle& ToNodeHandle,
EMetaSoundBuilderResult& OutResult
)

 Disconnects two nodes using defined MetaSound Interface Bindings registered with the MetaSound Interface registry. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

const FMetaSoundFrontendGraphComment * FindGraphComment ( const FGuid& InCommentID
) const

   MetasoundBuilderBase.h  
  MetasoundBuilderBase.h  
  MetasoundBuilderBase.h  
Returns graph input node by the given name if it exists, or an invalid handle if not found. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")
  MetasoundBuilderBase.h  
Returns graph output node by the given name if it exists, or an invalid handle if not found. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

TArray< FMetaSoundNodeHandle > FindInterfaceInputNodes ( FName InterfaceName,
EMetaSoundBuilderResult& OutResult
)

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

TArray< FMetaSoundNodeHandle > FindInterfaceOutputNodes ( FName InterfaceName,
EMetaSoundBuilderResult& OutResult
)

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

UMetaSoundFrontendMemberMetadata * FindMemberMetadata ( const FGuid& InMemberID
)

   MetasoundBuilderBase.h  

FMetasoundFrontendVersion FindNodeClassVersion ( const FMetaSoundNodeHandle& NodeHandle,
EMetaSoundBuilderResult& OutResult
)

 Returns output's parent node if the input is valid, otherwise returns invalid node handle. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

FMetaSoundBuilderNodeInputHandle FindNodeInputByName ( const FMetaSoundNodeHandle& NodeHandle,
FName InputName,
EMetaSoundBuilderResult& OutResult
)

 Returns node input by the given name if it exists, or an invalid handle if not found. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

FMetaSoundNodeHandle FindNodeInputParent ( const FMetaSoundBuilderNodeInputHandle& InputHandle,
EMetaSoundBuilderResult& OutResult
)

 Returns input's parent node if the input is valid, otherwise returns invalid node handle. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

TArray< FMetaSoundBuilderNodeInputHandle > FindNodeInputs ( const FMetaSoundNodeHandle& NodeHandle,
EMetaSoundBuilderResult& OutResult
)

 Returns all node inputs. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

TArray< FMetaSoundBuilderNodeInputHandle > FindNodeInputsByDataType ( const FMetaSoundNodeHandle& NodeHandle,
EMetaSoundBuilderResult& OutResult,
FName DataType
)

 Returns node inputs by the given DataType (ex. "Audio", "Trigger", "String", "Bool", "Float", "Int32", etc.). MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

FMetaSoundBuilderNodeOutputHandle FindNodeOutputByName ( const FMetaSoundNodeHandle& NodeHandle,
FName OutputName,
EMetaSoundBuilderResult& OutResult
)

 Returns node output by the given name. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

FMetaSoundNodeHandle FindNodeOutputParent ( const FMetaSoundBuilderNodeOutputHandle& OutputHandle,
EMetaSoundBuilderResult& OutResult
)

 Returns output's parent node if the input is valid, otherwise returns invalid node handle. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

TArray< FMetaSoundBuilderNodeOutputHandle > FindNodeOutputs ( const FMetaSoundNodeHandle& NodeHandle,
EMetaSoundBuilderResult& OutResult
)

 Returns all node outputs. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

TArray< FMetaSoundBuilderNodeOutputHandle > FindNodeOutputsByDataType ( const FMetaSoundNodeHandle& NodeHandle,
EMetaSoundBuilderResult& OutResult,
FName DataType
)

 Returns node outputs by the given DataType (ex. "Audio", "Trigger", "String", "Bool", "Float", "Int32", etc.). MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

FMetaSoundFrontendGraphComment & FindOrAddGraphComment ( const FGuid& InCommentID
)

   MetasoundBuilderBase.h  

virtual const UClass & GetBaseMetaSoundUClass()

 Returns the base class registered with the MetaSound UObject registry. MetasoundBuilderBase.h  
  MetasoundBuilderBase.h  
  MetasoundBuilderBase.h  

virtual const UClass & GetBuilderUClass()

   MetasoundBuilderBase.h  

const FMetaSoundFrontendDocumentBuilder & GetConstBuilder()

   MetasoundBuilderBase.h  

FMetasoundFrontendLiteral GetGraphInputDefault ( FName InputName,
EMetaSoundBuilderResult& OutResult
) const

 Gets the graph input's default literal value. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

TArray< FName > GetGraphInputNames ( EMetaSoundBuilderResult& OutResult
) const

 Gets names of all graph inputs. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

TArray< FName > GetGraphOutputNames ( EMetaSoundBuilderResult& OutResult
) const

 Gets names of all graph outputs. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

FMetasoundFrontendLiteral GetGraphVariableDefault ( FName VariableName,
EMetaSoundBuilderResult& OutResult
) const

 Gets the graph variable's default literal value. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

int32 GetLastTransactionRegistered()

   MetasoundBuilderBase.h  

FMetasoundFrontendLiteral GetNodeInputClassDefault ( const FMetaSoundBuilderNodeInputHandle& InputHandle,
EMetaSoundBuilderResult& OutResult
)

 Returns node input's class literal value if set, otherwise fails and returns default literal. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void GetNodeInputData ( const FMetaSoundBuilderNodeInputHandle& InputHandle,
FName& Name,
FName& DataType,
EMetaSoundBuilderResult& OutResult
)

 Returns node input's data if valid (including things like name and datatype). MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

FMetasoundFrontendLiteral GetNodeInputDefault ( const FMetaSoundBuilderNodeInputHandle& InputHandle,
EMetaSoundBuilderResult& OutResult
)

 Returns node input's literal value if set on graph, otherwise fails and returns default literal. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

bool GetNodeInputIsConstructorPin ( const FMetaSoundBuilderNodeInputHandle& InputHandle
) const

 Returns whether the given node input is a constructor pin. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

void GetNodeOutputData ( const FMetaSoundBuilderNodeOutputHandle& OutputHandle,
FName& Name,
FName& DataType,
EMetaSoundBuilderResult& OutResult
)

 Returns node output's data if valid (including things like name and datatype). MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

bool GetNodeOutputIsConstructorPin ( const FMetaSoundBuilderNodeOutputHandle& OutputHandle
) const

 Returns whether the given node output is a constructor pin. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

UObject * GetReferencedPresetAsset()

 Return the parent asset referenced by this preset builder. Returns nullptr if the builder is not a preset. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(DisplayName="Get Preset Parent")

FMetasoundFrontendClassName GetRootGraphClassName()

 Returns the MetaSound asset's graph class name (used by the MetaSound Node Class Registry) MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder|Advanced"
  • Meta=(DisplayName="Get MetaSound Class Name")
  MetasoundBuilderBase.h  

void Initialize ()

 Resets FrontendBuilder instance, creating a transient MetaSound document that is managed by this UObject Builder. MetasoundBuilderBase.h  

virtual void InitNodeLocations()

 Initializes and ensures all nodes have a position (required prior to exporting to an asset if expected to be viewed in the editor). MetasoundBuilderBase.h  

void InjectInputTemplateNodes ( bool bForceNodeCreation,
EMetaSoundBuilderResult& OutResult
)

 Injects template nodes between builder's document inputs not connected to existing template inputs, copying locational data from the represented input metadata. MetasoundBuilderBase.h  

bool InterfaceIsDeclared ( FName InterfaceName
) const

 Returns if a given interface is declared. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

bool IsPreset()

 Returns whether this is a preset. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

bool NodeInputIsConnected ( const FMetaSoundBuilderNodeInputHandle& InputHandle
) const

 Returns if a given node input has connections. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

bool NodeOutputIsConnected ( const FMetaSoundBuilderNodeOutputHandle& OutputHandle
) const

 Returns if a given node output is connected. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

bool NodesAreConnected ( const FMetaSoundBuilderNodeOutputHandle& OutputHandle,
const FMetaSoundBuilderNodeInputHandle& InputHandle
) const

 Returns if a given node output and node input are connected. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

path keys kept and priming managed internally void ReloadCache ( bool bPrimeCache
)

   MetasoundBuilderBase.h  

bool RemoveGraphComment ( const FGuid& InCommentID
)

   MetasoundBuilderBase.h  

void RemoveGraphInput ( FName Name,
EMetaSoundBuilderResult& OutResult
)

 Removes input from all paged graphs if it exists; sets result to succeeded if it was removed and failed if it was not. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void RemoveGraphOutput ( FName Name,
EMetaSoundBuilderResult& OutResult
)

 Removes output from all paged graphs if it exists; sets result to succeeded if it was removed and failed if it was not. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void RemoveGraphPage ( FName Name,
EMetaSoundBuilderResult& OutResult
)

 Removes a graph page with the given name, setting result to failed if the name was not found or was invalid. MetasoundBuilderBase.h  

void RemoveGraphVariable ( FName Name,
EMetaSoundBuilderResult& OutResult
)

 Removes graph variable from the current build graph if it exists; sets result to succeeded if it was removed and failed if it was not. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void RemoveInterface ( FName InterfaceName,
EMetaSoundBuilderResult& OutResult
)

 Removes the interface with the given name from the builder's MetaSound. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void RemoveNode ( const FMetaSoundNodeHandle& NodeHandle,
EMetaSoundBuilderResult& OutResult,
bool bRemoveUnusedDependencies
)

 Removes node and any associated connections from the current build graph. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult", AdvancedDisplay="2")
Removes node input literal default if set, reverting the value to be whatever the node class defaults the value to. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void RemoveTransactionListener ( FDelegateHandle BuilderListenerDelegateHandle
)

 Explicitly remove transaction listener from builder (see corresponding 'AddTransactionListener' function). MetasoundBuilderBase.h  

void RemoveUnusedDependencies()

 Removes dependencies in document that are no longer referenced by nodes. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"

void RenameRootGraphClass ( const FMetasoundFrontendClassName& InName
)

   MetasoundBuilderBase.h  

void ResetGraphPages ( bool bClearDefaultPage
)

 Removes all graph pages except the default. If bClearDefaultPage is true, clears the default graph page implementation. MetasoundBuilderBase.h  

void SetAuthor ( const FString& InAuthor
)

 Sets the author of the MetaSound. MetasoundBuilderBase.h  
Disconnects the given graph input's respective template nodes and sets the graph input's AccessType should it not match the current AccessType. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void SetGraphInputDataType ( FName InputName,
FName DataType,
EMetaSoundBuilderResult& OutResult
)

 Disconnects the given graph input's respective template nodes and sets the graph input's DataType should it not match the current DataType. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void SetGraphInputDefault ( FName InputName,
const FMetasoundFrontendLiteral& Literal,
EMetaSoundBuilderResult& OutResult
)

 Sets the input node's default value, overriding the default provided by the referenced graph if the graph is a preset. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void SetGraphInputName ( FName InputName,
FName NewName,
EMetaSoundBuilderResult& OutResult
)

 Sets the given graph input's name to the new name. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")
Disconnects the given graph output's respective template nodes and sets the graph output's AccessType should it not match the current AccessType. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void SetGraphOutputDataType ( FName OutputName,
FName DataType,
EMetaSoundBuilderResult& OutResult
)

 Disconnects the given graph output's respective template nodes and sets the graph output's DataType should it not match the current DataType. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void SetGraphOutputName ( FName OutputName,
FName NewName,
EMetaSoundBuilderResult& OutResult
)

 Sets the given graph output's name to the new name. MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void SetMemberMetadata ( UMetaSoundFrontendMemberMetadata& NewMetadata
)

   MetasoundBuilderBase.h  

void SetNodeComment ( const FMetaSoundNodeHandle& InNodeHandle,
const FString& InNewComment,
EMetaSoundBuilderResult& OutResult
)

   MetasoundBuilderBase.h  

void SetNodeCommentVisible ( const FMetaSoundNodeHandle& InNodeHandle,
bool bIsVisible,
EMetaSoundBuilderResult& OutResult
)

   MetasoundBuilderBase.h  
Sets the node's input default value (used if no connection to the given node input is present) MetasoundBuilderBase.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

void SetNodeInputDefault ( const FMetaSoundNodeHandle& NodeHandle,
const FName& InputName,
const LiteralType& Literal,
EMetaSoundBuilderResult& OutResult
)

 Templated convenience function for setting the node's input default value (used if no connection to the given node input is present) MetasoundBuilderBase.h  

void SetNodeLocation ( const FMetaSoundNodeHandle& InNodeHandle,
const FVector2D& InLocation,
EMetaSoundBuilderResult& OutResult
)

   MetasoundBuilderBase.h  

void SetNodeLocation ( const FMetaSoundNodeHandle& InNodeHandle,
const FVector2D& InLocation,
const FGuid& InLocationGuid,
EMetaSoundBuilderResult& OutResult
)

   MetasoundBuilderBase.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   MetasoundBuilderBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void BuildAndOverwriteMetaSoundInternal ( TScriptInterface< IMetaSoundDocumentInterface > ExistingMetaSound,
bool bForceUniqueClassName
) const

   MetasoundBuilderBase.h  

UClassType & BuildInternal ( UObject* Parent,
const FMetaSoundBuilderOptions& BuilderOptions
) const

 Runs build, conforming the document and corresponding object data on a MetaSound UObject to that managed by this builder. MetasoundBuilderBase.h  

virtual void CreateTransientBuilder()

   MetasoundBuilderBase.h  

UMetaSoundBuilderDocument * CreateTransientDocumentObject()

   MetasoundBuilderBase.h  

virtual void InitDelegates ( Metasound::Frontend::FDocumentModifyDelegates& OutDocumentDelegates
)

   MetasoundBuilderBase.h  

void InvalidateCache ( bool bPrimeCache
)

   MetasoundBuilderBase.h  

virtual void OnAssetReferenceAdded ( TScriptInterface< IMetaSoundDocumentInterface > DocInterface
)

   MetasoundBuilderBase.h  

virtual void OnRemovingAssetReference ( TScriptInterface< IMetaSoundDocumentInterface > DocInterface
)

   MetasoundBuilderBase.h  

Static

Name Remarks Include Path Unreal Specifiers

static void RegisterGraphIfOutstandingTransactions ( UObject& InMetaSound
)

 Only registers provided MetaSound's graph class and referenced graphs recursively if it has yet to be registered or if it has an attached builder reporting outstanding transactions that have yet to be registered. MetasoundBuilderBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page