Navigation
Filters
Classes
| Type | Name | Description | |
|---|---|---|---|
| ConstructorTakesNodeInitData | Utility class to ensure that a node class can use the constructor the frontend uses. | ||
| FAccessPoint | FAccessPoint acts as a lifecycle tracker for the TAccessPtrs it creates. | ||
| FAccessToken | The access token mirrors the lifespan of a object in a non-intrusive manner. | ||
| FAddressRouter | Basic router that takes an FName address,. | ||
| FArrayIndexShuffler | |||
| FArrayRandomGet | |||
| FAutoUpdateRootGraph | Automatically updates all nodes and respective dependencies in graph where newer versions exist in the loaded MetaSound Class Node Registry. | ||
| FClassAccessPtr | |||
| FClassInterfaceUpdates | Provides list of interface members that have been added or removed when querying if a node's class has been updated | ||
| FConnectability | Struct that indicates whether an input and an output can be connected, and whether an intermediate node is necessary to connect the two. | ||
| FConstClassAccessPtr | |||
| FConstDocumentAccess | Container holding various access pointers to the FMetasoundFrontendDocument. | ||
| FConstDocumentAccessPtr | |||
| FConstGraphClassAccessPtr | |||
| FConstNodeAccessPtr | |||
| FConverterNodeInfo | |||
| FConverterNodeRegistryKey | |||
| FConverterNodeRegistryValue | |||
| FDataTransmissionCenter | Main entry point for all sender/receiver registration. | ||
| FDataTypeRegistryInfo | FDataTypeRegsitryInfo contains runtime inspectable behavior of a registered MetaSound data type. | ||
| FDefaultLiteralNodeConstructorParams | |||
| FDefaultNamedVertexNodeConstructorParams | Base implementation for NodeConstructorCallbacks. | ||
| FDefaultNamedVertexWithLiteralNodeConstructorParams | |||
| FDocumentAccess | Container holding various access pointers to the FMetasoundFrontendDocument. | ||
| FDocumentAccessPtr | |||
| FDocumentModifyDelegates | |||
| FEdgeModifyDelegates | |||
| FFilterClassesByClassID | |||
| FFilterClassesByInputVertexDataType | |||
| FFilterClassesByOutputVertexDataType | |||
| FFrontendGraph | FFrontendGraph is a utility graph for use in the frontend. | ||
| FFrontendGraphBuilder | FFrontendGraphBuilder builds a FFrontendGraph from a FMetasoundDocument or FMetasoundFrontendClass. | ||
| FFrontendQuery | FFrontendQuery contains a set of query steps which produce a FFrontendQuerySelectionView | ||
| FFrontendQueryEntry | FFrontendQueryEntry represents one value in the query. | ||
| FFrontendQueryKey | FFrontendQueryKey allows entries to be partitioned by their key. | ||
| FFrontendQueryStep | FFrontendQueryStep wraps all the support IFrontenQueryStep interfaces and supplies unified `ExecuteStep(...)_ member function. | ||
| FGraphClassAccessPtr | |||
| FGraphLinter | |||
| FInputNode | FInputNode represents an input to a metasound graph. | ||
| FInputNodeConstructorParams | |||
| FInputOperatorBase | |||
| FInterfaceModifyDelegates | |||
| FLiteralNode | TLiteralNode represents a variable within a metasound graph. | ||
| FMapClassesToClassName | |||
| FMapRegistrationEventsToNodeRegistryKeys | Partitions node registration events by their node registration keys. | ||
| FMapToFullClassName | |||
| FMapToNull | |||
| FMetasoundAssetBase | FMetasoundAssetBase is intended to be a mix-in subclass for UObjects which utilize Metasound assets. | ||
| FMetaSoundAssetRegistrationOptions | |||
| FMetasoundFrontendClass | |||
| FMetasoundFrontendClassEnvironmentVariable | |||
| FMetasoundFrontendClassInput | Contains info for input vertex of a Metasound class. | ||
| FMetasoundFrontendClassInterface | |||
| FMetasoundFrontendClassMetadata | |||
| FMetasoundFrontendClassName | Name of a Metasound class. | ||
| FMetasoundFrontendClassOutput | Contains info for output vertex of a Metasound class. | ||
| FMetasoundFrontendClassStyle | |||
| FMetasoundFrontendClassStyleDisplay | Information regarding how to display a node class. | ||
| FMetasoundFrontendClassVariable | Contains info for variable vertex of a Metasound class. | ||
| FMetasoundFrontendClassVertex | |||
| FMetasoundFrontendDocument | |||
| FMetaSoundFrontendDocumentBuilder | Builder used to support dynamically generating MetaSound documents at runtime. | ||
| FMetasoundFrontendDocumentMetadata | |||
| FMetasoundFrontendDocumentModifyContext | Struct containing any modified data breadcrumbs to inform what the editor/view layer must synchronize or refresh. | ||
| FMetasoundFrontendEdge | Represents a single connection from one point to another. | ||
| FMetasoundFrontendEdgeStyle | Styling for all edges associated with a given output (characterized by NodeID & Name) | ||
| FMetasoundFrontendEdgeStyleLiteralColorPair | |||
| FMetasoundFrontendGraph | |||
| FMetasoundFrontendGraphClass | |||
| FMetasoundFrontendGraphClassPresetOptions | Preset options related to a parent graph class. | ||
| FMetasoundFrontendGraphStyle | Styling for a class. | ||
| FMetasoundFrontendInterface | Definition of an interface that an FMetasoundFrontendClass adheres to in part or full. | ||
| FMetasoundFrontendInterfaceBinding | |||
| FMetasoundFrontendInterfaceStyle | |||
| FMetasoundFrontendInterfaceUClassOptions | Options used to restrict a corresponding UClass that interface may be applied to. | ||
| FMetasoundFrontendInterfaceVertexBinding | |||
| FMetasoundFrontendLiteral | Check that the static_cast<>s above are using the correct type. | ||
| FMetasoundFrontendNode | An FMetasoundFrontendNode represents a single instance of a FMetasoundFrontendClass. | ||
| FMetasoundFrontendNodeInterface | |||
| FMetasoundFrontendNodeStyle | |||
| FMetasoundFrontendNodeStyleDisplay | |||
| FMetasoundFrontendRegistryContainer | Singleton registry for all types and nodes. | ||
| FMetasoundFrontendVariable | Contains graph data associated with a variable. | ||
| FMetasoundFrontendVersion | General purpose version info for Metasound Frontend objects. | ||
| FMetasoundFrontendVersionNumber | General purpose version number for Metasound Frontend objects. | ||
| FMetasoundFrontendVertex | An FMetasoundFrontendVertex provides a named connection point of a node. | ||
| FMetasoundFrontendVertexHandle | Pair of guids used to address location of vertex within a FrontendDocument graph. | ||
| FMetasoundFrontendVertexLiteral | Contains a default value for a single vertex ID. | ||
| FMetasoundFrontendVertexMetadata | Metadata associated with a vertex. | ||
| FMetasoundParameterPackItem | A template that lets us stick an arbitrary data type into the raw 'bag-o-bytes' that is the parameter storage. | ||
| FMetasoundParameterPackItemBase | |||
| FMetasoundParameterPackProxy | Here is the proxy that UMetasoundParameterPack creates when asked for a proxy by the audio system. | ||
| FMetasoundParameterPackStorage | This next class owns the 'bag-o-bytes' that holds all of the parameters. | ||
| FMetasoundParameterStorageWrapper | And finally... | ||
| FMetaSoundParameterTransmitter | FMetaSoundParameterTransmitter provides a communication interface for sending values to a MetaSound instance. | ||
| FMissingOutputNodeInputReferenceError | FMissingOutputNodeInputReferenceError | ||
| FModifyInterfaceOptions | |||
| FModifyRootGraphInterfaces | Adds or swaps document members (inputs, outputs) and removing any document members where necessary and adding those missing. | ||
| FNamedEdge | |||
| FNodeAccessPtr | |||
| FNodeClassInfo | FNodeClassInfo contains a minimal set of information needed to find and query node classes. | ||
| FNodeClassRegistrationEvents | Streams node classes that have been newly registered or unregistered since last call to Stream() | ||
| FNodeModifyDelegates | |||
| FNodeRegistryTransaction | |||
| FNonExecutableInputOperatorBase | |||
| FNonExecutableInputPassThroughOperator | |||
| FOutputNode | |||
| FOutputOperator | |||
| FRebuildPresetRootGraph | Completely rebuilds the graph connecting a preset's inputs to the reference document's root graph. | ||
| FReceiverInitParams | |||
| FReduceClassesToHighestVersion | |||
| FReduceRegistrationEventsToCurrentStatus | Reduces registration events mapped to the same key by inspecting their add/remove state in order to determine their final state. | ||
| FRenameRootGraphClass | Sets the document's graph class, optionally updating the namespace and variant. | ||
| FSendAddress | FSendAddress is used as a addressing system for MetaSound Send nodes, Recieve nodes and MetaSound script communication | ||
| FSenderInitParams | |||
| FSharedStateRandomGetManager | |||
| FSharedStateShuffleManager | |||
| FSortClassesByVersion | |||
| FTime | Strongly typed time class. | ||
| FTransformRegistrationEventsToClasses | Transforms a registration event into a FMetasoundFrontendClass. | ||
| FTransmissionAddress | A FTranmissionAddress acts as a identifier for a data channel shared by one or more senders and or receivers. | ||
| FTransmissionDataChannelFactory | |||
| FTrigger | FTrigger supports sample accurate triggering, sample accurate internal tracking, and a convenient interface for running trigger-aligned audio signal processing routines on buffers.. | ||
| FUpdateRootGraphInterface | Updates document's given interface to the most recent version. | ||
| HasRawParameterAssignmentOp | |||
| IDataChannel | This contains an intermediary buffer for use between the send and receive nodes. | ||
| IDataTransmissionBase | Base class that defines shared state and utilities for senders, receivers, and the shared channel state. | ||
| IDataTypeRegistry | |||
| IDataTypeRegistryEntry | Registry entry interface for a MetaSound data type. | ||
| IDocumentAccessor | IDocumentAccessor describes an interface for various I*Controllers to interact with each other without exposing that interface publicly or requiring friendship between various controller implementation classes. | ||
| IDocumentCache | Interface for querying cached document dependencies. | ||
| IDocumentController | An IDocumentController provides methods for querying and manipulating a Metasound document. | ||
| IDocumentGraphEdgeCache | Interface for querying cached document edges. | ||
| IDocumentGraphInterfaceCache | Interface for querying cached document interface. | ||
| IDocumentGraphNodeCache | Interface for querying cached document nodes. | ||
| IDocumentTransform | Interface for transforms applied to documents. | ||
| IEnumDataTypeInterface | Interface for metadata of a registered MetaSound enum type. | ||
| IFrontendQueryFilterStep | Interface for a query step which filters entries. | ||
| IFrontendQueryLimitStep | |||
| IFrontendQueryMapStep | Interface for a query step which maps entries to keys. | ||
| IFrontendQueryMultiMapStep | Interface for a query step which maps entries to multiple keys. | ||
| IFrontendQueryReduceStep | Interface for a query step which reduces entries with the same key. | ||
| IFrontendQueryScoreStep | Interface for a query step which scores entries. | ||
| IFrontendQuerySortStep | Interface for a query step which sorts entries. | ||
| IFrontendQueryStep | Interface for an individual step in a query | ||
| IFrontendQueryStreamStep | Interface for a query step which streams new entries. | ||
| IFrontendQueryTransformStep | Interface for a query step which transforms an entry's value. | ||
| IGraphController | An IGraphController provides methods for querying and manipulating a Metasound graph. | ||
| IGraphTransform | Interface for transforms applied to a graph. | ||
| IInputController | An IInputController provides methods for querying and manipulating a metasound input vertex. | ||
| IMetaSoundAssetManager | |||
| IMetaSoundDocumentBuilderRegistry | |||
| IMetaSoundDocumentInterface | |||
| InitSharedStateArgs | |||
| INodeController | An INodeController provides methods for querying and manipulating a Metasound node. | ||
| INodeRegistryEntry | INodeRegistryEntry declares the interface for a node registry entry. | ||
| INodeTemplate | Base interface for a node template, which acts in place of frontend node class and respective instance(s). | ||
| INodeTemplateRegistry | |||
| INodeTransform | Interface for transforming a node. | ||
| IOutputController | An IOutputController provides methods for querying and manipulating a metasound output vertex. | ||
| IOutputStorage | |||
| IReceiver | This is a handle to something that will retrieve a datatype. | ||
| ISearchEngine | Interface for frontend search engine. | ||
| ISender | This is a handle to something that will retrieve a datatype. | ||
| IVariableController | |||
| TAccessPtr | TAccessPtr | ||
| TArrayConcatNode | |||
| TArrayConcatOperator | TArrayConcatOperator concatenates two arrays on trigger. | ||
| TArrayElementType | Retrieve the ElementType from an ArrayType. | ||
| TArrayGetNode | |||
| TArrayGetOperator | TArrayGetOperator copies a value from the array to the output when a trigger occurs. | ||
| TArrayNodeSupport | TArrayNodeSupport acts as a configuration sturct to determine whether a particular TArrayNode can be instantiated for a specific ArrayType. | ||
| TArrayNumNode | |||
| TArrayNumOperator | TArrayNumOperator gets the number of elements in an Array. | ||
| TArrayRandomGetNode | |||
| TArrayRandomGetOperator | |||
| TArraySetNode | |||
| TArraySetOperator | TArraySetOperator sets an element in an array to a specific value. | ||
| TArrayShuffleNode | |||
| TArrayShuffleOperator | TArrayShuffleOperator shuffles an array on trigger and outputs values sequentially on "next". | ||
| TArraySubsetNode | |||
| TArraySubsetOperator | TArraySubsetOperator slices an array on trigger. | ||
| TAudioDataChannel | |||
| TAudioReceiver | |||
| TAudioSender | AUDIO SPECIALIZATIONS: | ||
| TAutoConverterNode | This convenience node can be registered and will invoke static_cast |
||
| TCopyableDataChannel | Generic templated implementation of IDataChannel that can use for any copyable type. | ||
| TDataTypeProxyConstructorDeprecation | |||
| TEnableArrayNodes | |||
| TEnableAutoArrayTypeRegistration | Enables or disables automatic registration of array types given a MetaSound data type. | ||
| TEnableAutoConverterNodeRegistration | Enables or disables automatic registration of auto conversion nodes given a MetaSound data type. | ||
| TEnableConstructorVertex | Enables or disables using a data type in constructor vertices. | ||
| TEnableTransmission | Determines whether send/receive nodes are enabled for a specific data type. | ||
| TEnableTransmissionNodeRegistration | Enables or disables send and receive node registration for a given MetaSound data type. | ||
| TEnableVariables | Allow or disallow types to be registered as MetaSound Variables. | ||
| TEnum | Metasound Enum Wrapper | ||
| TEnumEntry | Struct to hold each of the entries of the Enum. | ||
| TEnumStringHelper | Metasound Enum String Helper | ||
| TEnumStringHelperBase | CRTP base class for Enum String Helper type. Provides common code for all specializations. | ||
| TEnumTraits | |||
| TExecutableDataTypeDeprecation | ExecutableDataTypes are deprecated in 5.3 in favor of TPostExecutableDataTypes. | ||
| TExecutableInputOperator | |||
| TInputNode | TInputNode represents an input to a metasound graph. | ||
| TInputValueOperator | TInputValueOperator provides an input for value references. | ||
| TIsAutoConvertible | Determines whether an auto converter node will be registered to convert between two types. | ||
| TIsConstructorVertexSupported | Helper to test if data type can be used on constructor pins. | ||
| TIsCopyable | Helper utility to test if we a datatype is copyable. | ||
| TIsExplicit | Helper utility to test if exact types are required for a datatype. | ||
| TIsTransmittable | Helper utility to test if we can transmit a datatype between a send and a receive node. | ||
| TLiteralArrayEnum | Returns the Array version of a literal type if it exists. | ||
| TLiteralNode | TLiteralNode represents a variable within a metasound graph. | ||
| TLiteralOperatorLiteralFactory | TLiteralOperatorLiteralFactory creates an input by passing it a literal. | ||
| TMetasoundDataTypeRegistration | Registration info for a data type. | ||
| TNonOperationalDataChannel | |||
| TNonOperationalReceiver | |||
| TNonOperationalSender | Generic templates: | ||
| TOutputNode | Output nodes are used to expose graph data to external entities. | ||
| TOutputStorage | |||
| TParamPackFixedArray | |||
| TPostExecutableInputOperator | |||
| TReceiveNode | |||
| TReceiver | |||
| TResetableExecutableInputOperator | |||
| TResetablePostExecutableInputOperator | |||
| TRootValueType | |||
| TRootValueTypeHelper | |||
| TSender | Specializations for trivially copyable types: | ||
| TSendNode | |||
| TTransmissionSupport | TTransmissionSupport determines whether the send/receive system is supported for a given data type. | ||
| TVariablesSupport | Determine if data type supports necessary operations required of all MetaSound variable types. | ||
| UMetaSoundBuilderDocument | |||
| UMetaSoundDocumentInterface | UInterface for all MetaSound UClasses that implement a MetaSound document as a means for accessing data via code, scripting, execution, or node class generation. | ||
| UMetasoundParameterPack | Here is the UObject BlueprintType that can be used in c++ and blueprint code. |
Constants
Typedefs
Enums
| Type | Name | Description | |
|---|---|---|---|
| EMetasoundFrontendClassType | |||
| EMetasoundFrontendLiteralType | The type of a given literal for an input value. | ||
| EMetasoundFrontendNodeStyleDisplayVisibility | DEPRECATED in Document Model v1.1. | ||
| EMetasoundFrontendVertexAccessType | Describes how a vertex accesses the data connected to it. | ||
| ESetParamResult | |||
| Metasound::Frontend::EInvalidEdgeReason | Copyright Epic Games, Inc. All Rights Reserved. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| const TCHAR * | LexToString
(
EMetasoundFrontendClassType InClassType |
||
| const TCHAR * | LexToString
(
EMetasoundFrontendVertexAccessType InVertexAccess |
||
| void | Metasound::BindInputs
(
FInputVertexInterfaceData& InVertexData |
||
| void | Metasound::BindOutputs
(
FOutputVertexInterfaceData& InVertexData |
||
| const DerivedAddressType * | Metasound::CastAddressType
(
const FTransmissionAddress& InOther |
Attempt to cast a FTransmissionAddress to a derived address type. | |
| TSenderPtr< TDataType > | Metasound::Downcast
(
TUniquePtr< ISender >&& InPtr |
For Audio Senders: | |
| TReceiverPtr< TDataType > | Metasound::Downcast
(
TUniquePtr< IReceiver >&& InPtr |
For audio receivers: | |
| void | |||
| ToAccessPtrType | Metasound::Frontend::ConstCastAccessPtr
(
const FromAccessPtrType& InAccessPtr |
||
| FMetasoundFrontendClass | Generates a new FMetasoundFrontendClass from a NodeType | ||
| FMetasoundFrontendClass | Metasound::Frontend::GenerateClass
(
const FNodeInitData& InNodeInitData |
Generates a new FMetasoundFrontendClass from Node init data | |
| AccessPtrType | Metasound::Frontend::MakeAccessPtr
(
const FAccessPoint& InAccessPoint, |
||
| FDataReferenceCollection | |||
| FDataReferenceCollection | |||
| uint32 | |||
| TSharedRef< IDataChannel, ESPMode::ThreadSafe > | Metasound::MakeDataChannel
(
const FOperatorSettings& InSettings |
||
| bool | |||
| bool | |||
| bool | |||
| bool | |||
| bool | |||
| bool | |||
| bool | |||
| void | This utility function can be used to check to see if we can static cast between two types, and autogenerate a node for that static cast. | ||
| void | This utility function can be used to optionally check to see if we can transmit a data type, and autogenerate send and receive nodes for that datatype. | ||
| Frontend::FDataTypeRegistryInfo | Creates the FDataTypeRegistryInfo for a data type. | ||
| TSharedPtr< Frontend::IEnumDataTypeInterface > | Returns an IEnumDataTypeInterface pointer for the data type. | ||
| void | Here we attempt to infer and autogenerate conversions for basic datatypes. | ||
| bool | Registers an array of a data type with the MetaSound Frontend. | ||
| bool | Registers a data type with the MetaSound Frontend. | ||
| bool | Registers all available array nodes which can be instantiated for the given ArrayType. | ||
| bool | Registers a data type with the MetaSound Frontend. | ||
| bool | |||
| bool | Metasound::RegisterNodeWithFrontend
(
const Metasound::FNodeClassMetadata& InMetadata |
||
| void | Metasound::Reset
(
const IOperator::FResetParams& InParams |
||
Metasound::TExecutableLiteralOperator
(
const FOperatorSettings& InSettings, |
Executable DataTypes require a copy of the output to operate on whereas non-executable types do not. | ||
Metasound::TLiteralOperator
(
TDataValueReference< DataType > InValue |
The TLiteralOperator will be removed. | ||
| bool | RegisterConversionNode
(
const Metasound::FVertexName& FromPin, |
Variables
| Type | Name | Description | |
|---|---|---|---|
| FDataWriteReference | InputValue | ||
| FLiteral | Literal | ||
| FDataWriteReference | OutputValue | ||
| TDataValueReference< DataType > | Value |