1. Epic GamesDeveloper
  3. IDocumentController

IDocumentController

An [IDocumentController](API\Plugins\MetasoundFrontend\IDocumentController) provides methods for querying and manipulating a [Metasound](API\Plugins\MetasoundGraphCore\TDataReferenceTypeInfo_FAudioBuf-) document.

API > API/Plugins > API/Plugins/MetasoundFrontend

An IDocumentController provides methods for querying and manipulating a Metasound document.

   
Name IDocumentController
Type class
Header File /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundFrontendController.h
Include Path #include "MetasoundFrontendController.h"

Syntax

class IDocumentController :  
    public TSharedFromThis< IDocumentController > ,  
    public Metasound::Frontend::IDocumentAccessor

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

IDocumentController()

   MetasoundFrontendController.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IDocumentController()

   MetasoundFrontendController.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FGraphHandle AddDuplicateSubgraph ( const IGraphController& InGraph
)

 Adds a duplicate subgraph to the document. MetasoundFrontendController.h  

void AddInterfaceVersion ( const FMetasoundFrontendVersion& InVersion
)

   MetasoundFrontendController.h  

void ClearInterfaceVersions()

   MetasoundFrontendController.h  

FString ExportToJSON()

 Exports the document to a json formatted string. MetasoundFrontendController.h  

bool ExportToJSONAsset ( const FString& InAbsolutePath
) const

 Exports the document to a json file at the provided path. MetasoundFrontendController.h  
Returns an existing Metasound class description corresponding to a dependency which matches the provided class information. MetasoundFrontendController.h  

FConstClassAccessPtr FindClass ( const FNodeRegistryKey& InKey
) const

 Returns an existing Metasound class description corresponding to a dependency which matches the provided class information. MetasoundFrontendController.h  

FConstClassAccessPtr FindClassWithID ( FGuid InClassID
) const

   MetasoundFrontendController.h  

FConstClassAccessPtr FindDependencyWithID ( FGuid InClassID
) const

   MetasoundFrontendController.h  

FConstClassAccessPtr FindOrAddClass ( const FNodeRegistryKey& InKey,
bool bInRefreshFromRegistry
)

 Attempts to find an existing Metasound class description corresponding to a dependency which matches the provided class information. MetasoundFrontendController.h  
Attempts to find an existing Metasound class description corresponding to a dependency which matches the provided class information. MetasoundFrontendController.h  

FConstGraphClassAccessPtr FindSubgraphWithID ( FGuid InClassID
) const

   MetasoundFrontendController.h  
TODO: add info on environment variables. MetasoundFrontendController.h  
  MetasoundFrontendController.h  
Returns the document if set. MetasoundFrontendController.h  

const TSet< FMetasoundFrontendVersion > & GetInterfaceVersions()

   MetasoundFrontendController.h  
  MetasoundFrontendController.h  
  MetasoundFrontendController.h  

FGraphHandle GetRootGraph ()

 Returns the root graph of this document. MetasoundFrontendController.h  

FConstGraphHandle GetRootGraph ()

 Returns the root graph of this document. MetasoundFrontendController.h  

const FMetasoundFrontendGraphClass & GetRootGraphClass()

   MetasoundFrontendController.h  

TArray< FGraphHandle > GetSubgraphHandles ()

 Returns an array of all subgraphs for this document. MetasoundFrontendController.h  

TArray< FConstGraphHandle > GetSubgraphHandles ()

 Returns an array of all subgraphs for this document. MetasoundFrontendController.h  

const TArray< FMetasoundFrontendGraphClass > & GetSubgraphs()

   MetasoundFrontendController.h  

FGraphHandle GetSubgraphWithClassID ( FGuid InClassID
)

 Returns a graphs in the document with the given class ID. MetasoundFrontendController.h  

FConstGraphHandle GetSubgraphWithClassID ( FGuid InClassID
) const

 Returns a graphs in the document with the given class ID. MetasoundFrontendController.h  

bool IsValid()

 Returns true if the controller is in a valid state. MetasoundFrontendController.h  

void IterateDependencies ( TFunctionRef< void(const FMetasoundFrontendClass&)> InFunction
) const

   MetasoundFrontendController.h  
Iterates all dependent class definitions that exist on the document (do not necessarily correspond to registered dependencies) MetasoundFrontendController.h  

void RemoveInterfaceVersion ( const FMetasoundFrontendVersion& InVersion
)

   MetasoundFrontendController.h  

void RemoveUnreferencedDependencies()

 Removes all dependencies which are no longer referenced by any graphs within this document. MetasoundFrontendController.h  

void SetMetadata ( const FMetasoundFrontendDocumentMetadata& InMetadata
)

   MetasoundFrontendController.h  

void SetRootGraphClass ( FMetasoundFrontendGraphClass&& InClass
)

   MetasoundFrontendController.h  
Synchronizes all dependency Metadata in document with that found in the registry. MetasoundFrontendController.h  

Static

Name Remarks Include Path Unreal Specifiers

static FDocumentHandle CreateDocumentHandle ( FDocumentAccessPtr InDocument
)

 Create a document from FMetasoundFrontendDocument description pointer. MetasoundFrontendController.h  

static FConstDocumentHandle CreateDocumentHandle ( const FMetasoundFrontendDocument& InDocument
)

   MetasoundFrontendController.h  

static FDocumentHandle CreateDocumentHandle ( FMetasoundFrontendDocument& InDocument
)

   MetasoundFrontendController.h  

static FConstDocumentHandle CreateDocumentHandle ( FConstDocumentAccessPtr InDocument
)

 Create a document from FMetasoundFrontendDocument description pointer. MetasoundFrontendController.h  

static FDocumentHandle GetInvalidHandle()

   MetasoundFrontendController.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page