1. Epic GamesDeveloper
  3. MetasoundGraphCore

MetasoundGraphCore

API > API/Plugins

Classes

  Type Name Description
Public class FAnyDataReference Container for any data reference.  
Public class FAudioBuffer FAudioBuffer  
Public struct FBuildDynamicGraphOperatorParams Parameters for building a dynamic graph operator consist of the parameters needed to build a standard graph operator as well as a transform queue and set of callbacks in order to communicate and react to changes in the dynamic operator.  
Public class FBuildErrorBase FBuildErrorBase  
Public struct FBuildGraphOperatorParams Parameters for building an operator from a graph.  
Public struct FBuildGraphParams Parameters for building an operator from a graph.  
Public struct FBuildOperatorParams FBuildOperatorParams holds the parameters provided to operator factories during the creation of an IOperator  
Public struct FBuildResults Structure of all resulting data generated during graph operator build.  
Public struct FConstructWithLiteral This tag resolves issues around the behavior of the TLiteralTraits<>::bIsParsable.  
Public struct FCreateOperatorParams FCreateOperatorParams holds the parameters provided to operator factories during the creation of an IOperator  
Public class FDanglingVertexError FDanglingVertexError  
Public struct FDataEdge FDataEdge  
Public class FDataReferenceCollection    
Public class FDataVertex FDataVertex  
Public struct FDataVertexMetadata Vertex metadata.  
Public struct FDirectedGraphAlgo    
Public class FDuplicateInputError FDuplicateInputError  
Public class FDynamicGraphIncrementalSorter FDynamicGraphIncrementalSorter implements a dynamic topological sorting algorithm which offers several optimizations over doing full sorts.  
Public class FDynamicOperatorTransactor The FDynamicOperatorTransactor is used for communicating with a dynamic MetaSound operator.  
Public struct FDynamicOperatorUpdateCallbacks A collection of callbacks for handling updates to MetaSound dynamic operators.  
Public class FEnvironmentVertex FEnvironmentVertex  
Public class FExecuter FExecuter  
Public class FGraph FGraph contains the edges between nodes as well as input and output vertices.  
Public class FGraphCycleError FGraphCycleError  
Public class FGraphLinter FGraphLinter  
Public class FGraphOperator    
Public class FGraphRenderCost FGraphRenderCost represents the accumulated render cost of a graph.  
Public class FInputBinding An input binding which connects an FInputVertex to a IDataReference.  
Public struct FInputBindingFactory Factory for creating a new FInputBinding from a IDataReference derived class and a vertex name.  
Public struct FInputDataDestination FInputDataSource describes the destination of data which produced external to the graph and read internal to the graph.  
Public class FInputDataVertex FInputDataVertex  
Public class FInputReceiverInitializationError FInputReceiverInitializationError  
Public class FInputVertexInterfaceData An input vertex interface with optionally bound data references.  
Public class FInternalError FInternalError  
Public class FInvalidConnectionDataTypeError FInvalidConnectionDataTypeError  
Public struct FLiteral FLiteral represents a constant value in a Metasound graph and is primarily used to invoke the correct constructor of a Metasound data type.  
Public class FMetasoundEnvironment FMetasoundEnvironment contains a set of TMetasoundEnvironmentVariables requiring that each environment variable has a unique name.  
Public class FMissingInputDataReferenceError FMissingInputDataReferenceError  
Public class FMissingOutputDataReferenceError FMissingOutputDataReferenceError  
Public class FMissingVertexError FMissingVertexError  
Public class FNode    
Public struct FNodeClassMetadata Provides metadata for a given node.  
Public class FNodeClassName Name of a node class.  
Public struct FNodeDisplayStyle Node style data  
Public class FNodeFacade FNodeFacade implements a significant amount of boilerplate code required to build a MetasoundINode.  
Public class FNodeFactoryRegister    
Public struct FNodeInitData This struct is used to pass in any arguments required for constructing a single node instance.  
Public class FNodePrunedError FNodePrunedError  
Public class FNodeRenderCost FNodeRenderCost allows individual nodes to report their render cost.  
Public class FNoOpOperator FNoOpOperator is for IOperators which do not perform any execution.  
Public struct FOperatorAndInputs Todo: better place to put this? needs to be in core  
Public class FOperatorBuilder FOperatorBuilder builds an IOperator from an IGraph.  
Public struct FOperatorBuilderSettings FOperatorBuilderSettings  
Public class FOperatorSettings FOperatorSettings  
Public struct FOrdinalSwap FOrdinalSwap represents a change in ordinal for an individual operator.  
Public class FOutputBinding Binds an IDataReference to a FOutputDataVertex.  
Public struct FOutputBindingFactory Factory for creating FOutputBinding from an IDataReference derived object.  
Public struct FOutputDataSource FOutputDataSource describes the source of data which is produced within a graph and exposed external to the graph.  
Public class FOutputDataVertex FOutputDataVertexVertex for outputs.  
Public class FOutputVertexInterfaceData An output vertex interface with optionally bound data references.  
Public struct FStronglyConnectedComponent A strongly connected component containing Metasound INodes and FDataEdges.  
Public struct FVertexDataState FVertexDataState encapsulates which data reference a vertex is associated with.  
Public class FVertexInterface FVertexInterface provides access to a collection of input and output vertex interfaces.  
Public class FVertexInterfaceData A vertex interface with optionally bound data.  
Public class IAudioDataType This empty base class is used so that we can specialize various nodes (Send, Receive, etc.) for subclasses of IAudioDatatype.  
Public class IDataReference A Data Reference Interface.  
Public class IGraph Interface for graph of nodes.  
Public class IMetasoundEnvironmentVariable Interface for a metasound environment variable which supports a name, a runtime type ID, and a clone method.  
Public class IMetasoundGraphCoreModule    
Public class INode INodeInterface for all nodes that can create operators.  
Public class INodeBase INodeBase  
Public class IOperator IOperator  
Public class IOperatorBuilder IOperatorBuilder  
Public class IOperatorBuildError IOperatorBuildError  
Public class IOperatorFactory IOperatorFactory  
Public struct TAnyConstructorForwarding Denotes that parameter pack arguments and/or FOperatorSettings is optional when constructing the Metasound Data Type.  
Public struct TDataFactory A base factory type for creating objects related to Metasound DataTypes.  
Public struct TDataFactoryInternal Core factory type for creating objects related to metasound data types.  
Public struct TDataLiteralFactory A base factory type for creating objects related to Metasound DataTypes.  
Public class TDataReadReference Forward declare.  
Public struct TDataReadReferenceFactory TDataReadReferenceFactory creates TDataReadReferences for the given DataType.  
Public struct TDataReadReferenceLiteralFactory TDataReadReferenceLiteralFactory creates TDataReadReferences for the given DataType.  
Public class TDataReference Template class for a paramter reference.  
Public struct TDataReferenceTypeInfo Info for templated data reference types help perform runtime type verification.  
Public struct TDataTypeConstructorTraits Description of available constructors for a registered Metasound Data Type.  
Public struct TDataTypeCreator Create a DataType. For use in TDataFactory.  
Public struct TDataTypeFactory TDataTypeFactory creates a DataType.  
Public struct TDataTypeLiteralFactory TDataTypeLiteralFactory creates a DataType.  
Public struct TDataTypeVariantConstructorTraits Constructor traits for a for variant inputs.  
Public struct TDataTypeVariantFallbackHelper Helper for determine whether constructor accepts the variant type.  
Public struct TDataTypeVariantParsing TDataTypeVariantParsing informs the TDataVariantFactoryInternal on which factory method to instantiate.  
Public class TDataValueReference TDataValueReference represents a constant value and provides read only access.  
Public struct TDataValueReferenceFactory TDataValueReferenceFactory creates TDataValueReferences for the given DataType.  
Public struct TDataValueReferenceLiteralFactory TDataValueReferenceLiteralFactory creates TDataValueReferences for the given DataType.  
Public struct TDataVariantFactoryInternal Core factory type for creating objects related to Metasound DataTypes.  
Public class TDataWriteReference Forward declare.  
Public struct TDataWriteReferenceFactory TDataWriteReferenceFactory creates TDataWriteReferences for the given DataType.  
Public struct TDataWriteReferenceLiteralFactory TDataWriteReferenceLiteralFactory creates TDataWriteReferences for the given DataType.  
Public struct TElementType TElementType determines the element type of a container.  
Public struct TEnvironmentVariableTypeInfo Struct TEnvironmentVariableTypeInfo  
Public struct TExecutableDataType As a general rule, ExecutableDataTypes should be avoided whenever possible as they incur an undesired cost and are generally not typically necessary.  
Public class TExecutableOperator Convenience class for supporting the IOperator interface's GetExecuteFunction virtual member function.  
Public struct TExplicitArgsConstructorForwarding Denotes that parameter pack arguments must be used in the constructor of the Metasound Data Type.  
Public struct TExplicitConstructorForwarding Denotes that both FOperatorSettings and parameter pack arguments must be used in the constructor of the Metasound Data Type.  
Public struct TFacadeOperatorClass TFacadeOperatorClass encapsulates an operator type and checks that the required static functions exist to build the facade operator class.  
Public struct TGetVertexAccess Helper for getting a EVertexAccessType from a TData*Reference object.  
Public class TInputConstructorVertex Create a FInputDataVertex with a templated MetaSound data type which only reads data at operator time.  
Public class TInputDataVertex Create a FInputDataVertex with a templated MetaSound data type.  
Public struct TIsArrayType Determines whether a DataType is an array type.  
Public class TIsFactoryMethodDeclared Helper template to determine whether a static class function is declared for a given template class.  
Public class TIsNodeInfoDeclared Helper template to determine whether a static class function is declared for a given template class.  
Public struct TIsParsable Determines whether a DataType supports a constructor which accepts and FOperatorSettings with ArgTypes and/or just ArgTypes.  
Public class TIsPostExecuteMethodDeclared Helper template to determine whether a member function is declared for a given template class.  
Public class TIsResetMethodDeclared Helper template to determine whether a member function is declared for a given template class.  
Public struct TIsVariable Template to determine if data type is a variable.  
Public struct TLiteralDefaultValueFromDecayed    
Public struct TLiteralTraits Determines whether a DataType supports construction using the given literal.  
Public struct TLiteralTypeInfo Provides literal type information for a given type.  
Public class TMetasoundEnvironmentVariable    
Public class TNodeFacade TNodeFacade further reduces boilerplate code by allowing shorthand node implementations.  
Public class TOutputConstructorVertex Create a FOutputDataVertex with a templated MetaSound data type which is only sets data at operator construction time.  
Public class TOutputDataVertex Create a FOutputDataVertex with a templated MetaSound data type.  
Public struct TPostExecutableDataType    
Public struct TPostExecuteFunctionAdapter Helper to determine whether an PostExecute(...) function exists.  
Public struct TResetFunctionAdapter Helper to determine whether an Reset(...) function exists.  
Public struct TSpecializationHelper Helper class to enforce specialization of TDataReferenceTypeInfo  
Public struct TSpecializationHelper Helper class to ensure that DECLARE_METASOUND_ENVIRONMENT_VARIABLE is used.  
Public struct TTypePromoter Promote which type to use for fallback.  
Public struct TVariable A MetaSound Variable contains a data reference's prior and current value.  
Public class TVariableAccessorNode FGetVariable node provides delay free, cpu free access to a set variable.  
Public class TVariableAccessorOperator Operator for providing inline access to a variable  
Public class TVariableDeferredAccessorNode TVariableDeferredAccessorNode provides access to the prior executions variable value.  
Public class TVariableDeferredAccessorOperator Operator for providing delayed access to a variable  
Public class TVariableMutatorNode TVariableMutatorNode allows variable values to be set.  
Public class TVariableMutatorOperator Operator for providing setting a variable  
Public class TVariableNode Variable nodes initialize variable values.  
Public class TVariableOperator    
Public class TVertexInterfaceGroup TVertexInterfaceGroups encapsulates multiple related data vertices.  
Public class TVertexInterfaceGroupData    

Constants

Name Description
Metasound::VariableNames::InputDataDisplayName  
Metasound::VariableNames::InputDataMetadata  
Metasound::VariableNames::InputDataName  
Metasound::VariableNames::InputDataTooltip  
Metasound::VariableNames::InputVariableDisplayName  
Metasound::VariableNames::InputVariableMetadata  
Metasound::VariableNames::InputVariableName  
Metasound::VariableNames::InputVariableTooltip  
Metasound::VariableNames::OutputDataDisplayName  
Metasound::VariableNames::OutputDataMetadata  
Metasound::VariableNames::OutputDataName  
Metasound::VariableNames::OutputDataTooltip  
Metasound::VariableNames::OutputVariableDisplayName  
Metasound::VariableNames::OutputVariableMetadata  
Metasound::VariableNames::OutputVariableName  
Metasound::VariableNames::OutputVariableTooltip  

Typedefs

Name Description
FAudioBufferReadRef  
FAudioBufferTypeInfo  
FAudioBufferWriteRef  
FBuildErrorArray Array of build errors.
FDataReferenceID Unique ID type which corresponds to the underlying object referred to by a data reference.
FEnvironmentVertexInterface FEnvironmentVertexInterface is a TVertexInterfaceGroup which holds FEnvironmentVertexes.
FInputDataDestinationCollection FInputDataDestinationCollection contains multiple FInputDataDestinations mapped by FNodeDataVertexKeys.
FInputVertexInterface FInputVertexInterface is a TVertexInterfaceGroup which holds FInputDataVertexes.
FMetasoundDataTypeId  
FMetasoundEnvironmentVariableTypeId  
FNodeDataVertexKey Key type for an FOutputDataSource or FInputDataDestination.
FOnInputVertexUpdated  
FOnOutputVertexUpdated  
FOperatorFactorySharedRef Shared ref type of operator factory.
FOutputDataSourceCollection FOutputDataSourceCollection contains multiple FOutputDataSources mapped by FNodeDataVertexKeys.
FOutputVertexInterface FOutputVertexInterface is a TVertexInterfaceGroup which holds FOutputDataVertexes.
FReferenceCreationFunction  
FSampleRate  
FVertexName Name of a given vertex. Only unique for a given node interface.
ProxyDataPtrType_DEPRECATED Deprecated in 5.2. Use TSharedPtr instead of TUniquePtr.
TSortedVertexNameMap Convenience for using a TSortedMap with FVertexName Key type.

Enums

  Type Name Description
Public enum Metasound::EDataReferenceAccessType EDataReferenceAccessType describes the underlying data reference access type for a data reference contained in a FAnyDataReference.  
Public enum Metasound::EDataRefShouldConstruct This enum is used as a token to explicitly delineate when we should create a new object for the reference, or use a different constructor.  
Public enum Metasound::ELiteralType ELiteralType describes the format of the values held in the literal.  
Public enum Metasound::EOperatorBuilderNodePruning EOperatorBuildNodePruning expresses the desired pruning behavior during the node pruning step.  
Public enum Metasound::EVertexAccessType Describe how the vertex will access connected data.  

Functions

  Type Name Description
Public function FString

LexToString ( const Metasound::FLiteral& InLiteral
)

  
Public function FString Convert EVertexAccessType to string
Public function FString Convert a EDataReferenceAccessType to FString.
Public function  

LLM_DECLARE_TAG_API ( Audio_MetaSound,
METASOUNDGRAPHCORE_API
)

  
Public function void

Metasound::AddBuildError ( FBuildErrorArray& OutErrors,
ArgTypes&&... Args
)

 Convenience template for adding build errors.
Public function const TMetasoundEnvironmentVariable< Type > & Casts an environment variable to the derived type.
Public function TMetasoundEnvironmentVariable< Type > & Casts an environment variable to the derived type.
Public function FDataReferenceID

Metasound::GetDataReferenceID ( const IDataReference& InDataReference
)

 Return the ID of the data reference.
Public function const FText & Return the display text for a registered data type.
Public function const void *const Return the data type ID for a registered data type.
Public function const FName & Return the data type FName for a registered data type.
Public function const FString & Return the data type string for a registered data type.
Public function FMetasoundEnvironmentVariableTypeId Return the type ID for a environment variable type.
Public function bool Test if an IDataReference contains the same data type as the template parameter.
Public function bool Returns true if the environment variable contains the same type as the `VarType_
Public function FNodeDataVertexKey  
Public function TSharedRef< FactoryType, ESPMode::ThreadSafe >

Metasound::MakeOperatorFactoryRef ( ArgTypes&&... Args
)

 Convenience function for making operator factory references
Public function FNodeDataVertexKey Make a FNodeDataVertexKey from an FOutputDataSource.
Public function ELiteralType  
Public function ELiteralType Default template for converting a template parameter to a literal argument type.
Public function TDataValueReference< T > Cast a TDataWriteReference to a TDataValueReference.
Public function TDataValueReference< T > Cast a TDataReadReference to a TDataValueReference.
Public function const FNodeClassName & Class name for variable accessor node
Public function const FNodeClassName & Class name for variable deferred accessor node.
Public function const FNodeClassName & Class name for variable mutator node.
Public function const FNodeClassName & Class name for variable node.
Public function TDataWriteReference< DataType >

Metasound::WriteCast ( const TDataReadReference< DataType >& InReadableRef
)

 Cast a TDataReadReference to a TDataWriteReference.

Variables

  Type Name Description
Public variable int32 ORDINAL_NONE  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page