Navigation
API > API/Plugins > API/Plugins/MetasoundFrontend
Inheritance Hierarchy
- TSharedFromThis
- IDocumentAccessor
- IDocumentController
References
| Module | MetasoundFrontend |
| Header | /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundFrontendController.h |
| Include | #include "MetasoundFrontendController.h" |
Syntax
class IDocumentController :
public TSharedFromThis< IDocumentController >,
public Metasound::Frontend::IDocumentAccessor
Remarks
An IDocumentController provides methods for querying and manipulating a Metasound document.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
FGraphHandle | AddDuplicateSubgraph
(
const IGraphController& InGraph |
Adds a duplicate subgraph to the document. |
 |
void | AddInterfaceVersion
(
const FMetasoundFrontendVersion& InVersion |
|
 |
void | ||
  |
FConstDocumentHandle | CreateDocumentHandle
(
FConstDocumentAccessPtr InDocument |
Create a document from FMetasoundFrontendDocument description pointer. |
  |
FConstDocumentHandle | CreateDocumentHandle
(
const FMetasoundFrontendDocument& InDocument |
Create a document from FMetasoundFrontendDocument description pointer. |
  |
FDocumentHandle | CreateDocumentHandle
(
FMetasoundFrontendDocument& InDocument |
Create a document from FMetasoundFrontendDocument description pointer. |
  |
FDocumentHandle | CreateDocumentHandle
(
FDocumentAccessPtr InDocument |
Create a document from FMetasoundFrontendDocument description pointer. |
  |
FString | ExportToJSON () |
Exports the document to a json formatted string. |
  |
bool | ExportToJSONAsset
(
const FString& InAbsolutePath |
Exports the document to a json file at the provided path. |
  |
FConstClassAccessPtr | FindClass
(
const FMetasoundFrontendClassMetadata& InMetadata |
Returns an existing Metasound class description corresponding to a dependency which matches the provided class information. |
  |
FConstClassAccessPtr | FindClass
(
const FNodeRegistryKey& InKey |
Returns an existing Metasound class description corresponding to a dependency which matches the provided class information. |
  |
FConstClassAccessPtr | FindClassWithID
(
FGuid InClassID |
|
  |
FConstClassAccessPtr | FindDependencyWithID
(
FGuid InClassID |
|
 |
FConstClassAccessPtr | FindOrAddClass
(
const FNodeRegistryKey& InKey, |
Attempts to find an existing Metasound class description corresponding to a dependency which matches the provided class information. |
 |
FConstClassAccessPtr | FindOrAddClass
(
const FMetasoundFrontendClassMetadata& InMetadata |
Attempts to find an existing Metasound class description corresponding to a dependency which matches the provided class information. |
  |
FConstGraphClassAccessPtr | FindSubgraphWithID
(
FGuid InClassID |
|
  |
const TArray< FMetasoundFrontendClass > & | TODO: add info on environment variables. | |
  |
const TSet< FMetasoundFrontendVersion > & | ||
  |
FDocumentHandle | ||
  |
const FMetasoundFrontendDocumentMetadata & | GetMetadata () |
|
 |
FMetasoundFrontendDocumentMetadata * | GetMetadata () |
|
 |
FGraphHandle | GetRootGraph () |
Returns the root graph of this document. |
  |
FConstGraphHandle | GetRootGraph () |
Returns the root graph of this document. |
  |
const FMetasoundFrontendGraphClass & | ||
 |
TArray< FGraphHandle > | Returns an array of all subgraphs for this document. | |
  |
TArray< FConstGraphHandle > | Returns an array of all subgraphs for this document. | |
  |
const TArray< FMetasoundFrontendGraphClass > & | GetSubgraphs () |
|
 |
FGraphHandle | GetSubgraphWithClassID
(
FGuid InClassID |
Returns a graphs in the document with the given class ID. |
  |
FConstGraphHandle | GetSubgraphWithClassID
(
FGuid InClassID |
Returns a graphs in the document with the given class ID. |
  |
bool | IsValid () |
Returns true if the controller is in a valid state. |
  |
void | IterateDependencies
(
TFunctionRef< void(const FMetasoundFrontendClass&)> InFunction |
|
 |
void | IterateDependencies
(
TFunctionRef< void(FMetasoundFrontendClass&)> InFunction |
Iterates all dependent class definitions that exist on the document (do not necessarily correspond to registered dependencies) |
 |
void | RemoveInterfaceVersion
(
const FMetasoundFrontendVersion& InVersion |
|
 |
void | Removes all dependencies which are no longer referenced by any graphs within this document. | |
 |
void | SetMetadata
(
const FMetasoundFrontendDocumentMetadata& InMetadata |
|
 |
void | SetRootGraphClass
(
FMetasoundFrontendGraphClass&& InClass |
|
 |
TArray< FConstClassAccessPtr > | Synchronizes all dependency Metadata in document with that found in the registry. |