1. Epic GamesDeveloper
  3. UMetaSoundBuilderBase

UMetaSoundBuilderBase

Base implementation of MetaSound builder

API > API/Plugins > API/Plugins/MetasoundEngine

Inheritance Hierarchy

References

   
Module MetasoundEngine
Header /Engine/Plugins/Runtime/Metasound/Source/MetasoundEngine/Public/MetasoundBuilderSubsystem.h
Include #include "MetasoundBuilderSubsystem.h"

Syntax

UCLASS&40;Abstract&41;  
class UMetaSoundBuilderBase : public UObject

Remarks

Base implementation of MetaSound builder

Variables

  Type Name Description
Protected variable UProperty bool bIsAttached If true, builder is attached to an existing asset (directly making changes to its document).
Protected variable UProperty FMetaSoundFrontendDocumentBuilder Builder  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category, Meta 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.
Public function UFunction BlueprintCallable, Category, Meta 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.
Public function UFunction BlueprintCallable, Category, Meta void

AddInterface ( FName InterfaceName,
EMetaSoundBuilderResult& OutResult
)

 Adds an interface registered with the given name to the graph, adding associated input and output nodes.
Public function UFunction BlueprintCallable, Category, Meta displayname FMetaSoundNodeHandle Adds a node to the graph using the provided MetaSound asset as its defining NodeClass.
Public function UFunction BlueprintCallable, Category, Meta displayname FMetaSoundNodeHandle

AddNodeByClassName ( const FMetasoundFrontendClassName& ClassName,
int32 MajorVersion,
EMetaSoundBuilderResult& OutResult
)

 Adds node referencing the highest native class version of the given class name to the document.
Public function Virtual Const TScriptInterface< IMetaSoundDocumentInterface >

Build ( UObject* Parent,
const FMetaSoundBuilderOptions& Options
)

  
Protected function Const UClassType &

BuildInternal ( UObject* Parent,
const FMetaSoundBuilderOptions& BuilderOptions
)

 Runs build, conforming the document and corresponding object data on a MetaSound UObject to that managed by this builder.
Public function UFunction BlueprintCallable, Category, Meta TArray< FMetaSoundBuilderNodeOutputHandle > 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.
Public function UFunction BlueprintCallable, Category, Meta void

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

 Connects a given node input to the graph input with the given name.
Public function UFunction BlueprintCallable, Category, Meta TArray< FMetaSoundBuilderNodeInputHandle > 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.
Public function UFunction BlueprintCallable, Category, Meta void

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

 Connects a given node output to the graph output with the given name.
Public function UFunction BlueprintCallable, Category, Meta void

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

 Connects node output to a node input.
Public function UFunction BlueprintCallable, Category, Meta void

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

 Connects two nodes using defined MetaSound Interface Bindings registered with the MetaSound Interface registry.
Public function Const UFunction BlueprintCallable, Category bool Returns whether node exists.
Public function Const UFunction BlueprintCallable, Category bool Returns whether node input exists.
Public function Const UFunction BlueprintCallable, Category bool Returns whether node output exists.
Public function UFunction BlueprintCallable, Category, Meta void Converts this preset to a fully accessible MetaSound; sets result to succeeded if it was converted successfully and failed if it was not.
Public function UFunction BlueprintCallable, Category, Meta void Convert this builder to a MetaSound source preset with the given referenced source builder.
Protected function Const UMetaSoundBuilderDocument * Constructs a transient UMetaSoundBuilderDocument to be acted upon by this builder instance.
Public function UFunction BlueprintCallable, Category, Meta void Removes connection to a given node input. Returns success if connection was removed, failed if not.
Public function UFunction BlueprintCallable, Category, Meta void Removes all connections from a given node output. Returns success if all connections were removed, failed if not.
Public function UFunction BlueprintCallable, Category, Meta 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.
Public function UFunction BlueprintCallable, Category, Meta void Disconnects two nodes using defined MetaSound Interface Bindings registered with the MetaSound Interface registry.
Public function UFunction BlueprintCallable, Category, Meta FMetaSoundNodeHandle Returns graph input node by the given name if it exists, or an invalid handle if not found.
Public function UFunction BlueprintCallable, Category, Meta FMetaSoundNodeHandle Returns graph output node by the given name if it exists, or an invalid handle if not found.
Public function UFunction BlueprintCallable, Category, Meta TArray< FMetaSoundNodeHandle >

FindInterfaceInputNodes ( FName InterfaceName,
EMetaSoundBuilderResult& OutResult
)

  
Public function UFunction BlueprintCallable, Category, Meta TArray< FMetaSoundNodeHandle >  
Public function UFunction BlueprintCallable, Category, Meta FMetasoundFrontendVersion Returns output's parent node if the input is valid, otherwise returns invalid node handle.
Public function UFunction BlueprintCallable, Category, Meta 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.
Public function UFunction BlueprintCallable, Category, Meta FMetaSoundNodeHandle Returns input's parent node if the input is valid, otherwise returns invalid node handle.
Public function UFunction BlueprintCallable, Category, Meta TArray< FMetaSoundBuilderNodeInputHandle >

FindNodeInputs ( const FMetaSoundNodeHandle& NodeHandle,
EMetaSoundBuilderResult& OutResult
)

 Returns node output by the given name.
Public function UFunction BlueprintCallable, Category, Meta 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.).
Public function UFunction BlueprintCallable, Category, Meta FMetaSoundBuilderNodeOutputHandle

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

 Returns node output by the given name.
Public function UFunction BlueprintCallable, Category, Meta FMetaSoundNodeHandle Returns output's parent node if the input is valid, otherwise returns invalid node handle.
Public function UFunction BlueprintCallable, Category, Meta TArray< FMetaSoundBuilderNodeOutputHandle > Returns all node outputs.
Public function UFunction BlueprintCallable, Category, Meta 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.).
Public function Virtual Const const UClass & Returns the base MetaSound UClass the builder is operating on (ex. MetaSoundSource, MetaSoundPatch, etc. not to be confused with the underlying document builder's MetaSound class type)
Protected function Const const FMetaSoundFrontendDocumentBuilder &  
Public function UFunction BlueprintCallable, Category, Meta FMetasoundFrontendLiteral Returns node input's class literal value if set, otherwise fails and returns default literal.
Public function UFunction BlueprintCallable, Category, Meta void

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

 Returns node input's data if valid (including things like name and datatype).
Public function UFunction BlueprintCallable, Category, Meta FMetasoundFrontendLiteral Returns node input's literal value if set on graph, otherwise fails and returns default literal.
Public function UFunction BlueprintCallable, Category, Meta void

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

 Returns node output's data if valid (including things like name and datatype).
Public function Const UFunction BlueprintCallable, Category UObject * Return the asset referenced by this preset builder. Returns nullptr if the builder is not a preset.
Public function Const FMetasoundFrontendClassName Returns the document's root graph class name.
Public function Virtual void  
Public function void Initializes and ensures all nodes have a position (required prior to exporting to an asset if expected to be viewed in the editor).
Public function Const UFunction BlueprintCallable, Category bool

InterfaceIsDeclared ( FName InterfaceName
)

 Returns if a given interface is declared.
Public function Const UFunction BlueprintCallable, Category bool Returns whether this is a preset.
Public function Const UFunction BlueprintCallable, Category bool Returns if a given node input has connections.
Public function Const UFunction BlueprintCallable, Category bool Returns if a given node output is connected.
Public function Const UFunction BlueprintCallable, Category bool Returns if a given node output and node input are connected.
Public function void Primarily used by editor transaction stack to avoid corruption when object is changed outside of the builder API.
Public function UFunction BlueprintCallable, Category, Meta void Removes graph input if it exists; sets result to succeeded if it was removed and failed if it was not.
Public function UFunction BlueprintCallable, Category, Meta void Removes graph output if it exists; sets result to succeeded if it was removed and failed if it was not.
Public function UFunction BlueprintCallable, Category, Meta void

RemoveInterface ( FName InterfaceName,
EMetaSoundBuilderResult& OutResult
)

 Removes the interface with the given name from the builder's MetaSound.
Public function UFunction BlueprintCallable, Category, Meta void

RemoveNode ( const FMetaSoundNodeHandle& NodeHandle,
EMetaSoundBuilderResult& OutResult
)

 Removes node and any associated connections from the builder's MetaSound.
Public function UFunction BlueprintCallable, Category, Meta void Removes node input literal default if set, reverting the value to be whatever the node class defaults the value to.
Public function void Rename the document's root graph class with a guid and optional namespace and variant.
Public function void

SetAuthor ( const FString& InAuthor
)

 Sets the author of the MetaSound.
Public function UFunction BlueprintCallable, Category, Meta void Sets the input node's default value, overriding the default provided by the referenced graph if the graph is a preset.
Public function UFunction BlueprintCallable, Category, Meta void Sets the node's input default value (used if no connection to the given node input is present)
Public function void

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

  
Public function void Update dependency class names given a map of old to new referenced class names.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page