1. Epic GamesDeveloper
  3. FMetasoundAssetBase

FMetasoundAssetBase

[FMetasoundAssetBase](API\Plugins\MetasoundFrontend\FMetasoundAssetBase) is intended to be a mix-in subclass for UObjects which utilize Metasound assets.

API > API/Plugins > API/Plugins/MetasoundFrontend

Inheritance Hierarchy

References

   
Module MetasoundFrontend
Header /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundAssetBase.h
Include #include "MetasoundAssetBase.h"

Syntax

class FMetasoundAssetBase

Remarks

FMetasoundAssetBase is intended to be a mix-in subclass for UObjects which utilize Metasound assets. It provides consistent access to FMetasoundFrontendDocuments, control over the FMetasoundFrontendClassInterface of the FMetasoundFrontendDocument. It also enables the UObject to be utilized by a host of other engine tools built to support MetaSounds.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const bool

AddingReferenceCausesLoop ( const FSoftObjectPath& InReferencePath
)

  
Protected function bool

AutoUpdate ( bool bInLogWarningsOnDroppedConnection
)

  
Public function void Caches transient metadata (class & vertex) found in the registry that is not necessary for serialization or core graph generation.
Public function bool Called when the interface is changed, presenting the opportunity for.
Public function Const Metasound::Frontend::FNodeClassInfo Gets the asset class info.
Public function Const const TSet< FSoftObjectPath > & Return all dependent asset paths to load asynchronously.
Protected function Const FText

GetDisplayName ( FString&& InTypeName
)

  
Public function Const FText  
Protected function Metasound::Frontend::FDocumentAccessPtr Returns an access pointer to the document.
Public function Const const FMetasoundFrontendDocument &  
Public function FMetasoundFrontendDocument &  
Protected function Const Metasound::Frontend::FConstDocumentAccessPtr Returns an access pointer to the document.
Public function Metasound::Frontend::FDocumentHandle Returns handle for the root metasound graph of this asset.
Public function Const Metasound::Frontend::FConstDocumentHandle Returns handle for the root metasound graph of this asset.
Public function UEdGraph * Returns the graph associated with this Metasound.
Public function Const const UEdGraph *  
Public function Const const UEdGraph &  
Public function UEdGraph &  
Public function Const const FMetasoundFrontendDocumentModifyContext &  
Public function FMetasoundFrontendDocumentModifyContext &  
Public function UObject * Returns the owning asset responsible for transactions applied to MetaSound.
Public function Const const UObject * Returns the owning asset responsible for transactions applied to MetaSound.
Public function Const FString  
Protected function Const TArray< FMetasoundFrontendClassInput > Returns all public class inputs.
Public function Const const TSet< FString > & Returns all the class keys of this asset's referenced assets.
Public function TArray< FMetasoundAssetBase * > Returns set of class references set call to serialize in the editor Used at runtime load register referenced classes.
Public function Const const Metasound::Frontend::FNodeRegistryKey &  
Public function Const Metasound::Frontend::FConstGraphHandle Returns handle for the root metasound graph of this asset.
Public function Metasound::Frontend::FGraphHandle Returns handle for the root metasound graph of this asset.
Protected function Const const FRuntimeData & Returns the cached runtime data.
Public function bool

ImportFromJSON ( const FString& InJSON
)

 Imports data from a JSON string directly.
Public function bool

ImportFromJSONAsset ( const FString& InAbsolutePath
)

 Imports the asset from a JSON file at provided path.
Public function Const bool Returns whether an interface with the given version is declared by the given asset's document.
Public function Const bool

IsReferencedAsset ( const FMetasoundAssetBase& InAssetToCheck
)

  
Public function Const bool  
Public function Const bool Calls the outermost package and marks it dirty.
Public function void

OnAsyncReferencedAssetsLoaded ( const TArray< FMetasoundAssetBase* >& InAsyncReferences
)

 Called when async assets have finished loading.
Protected function TSharedPtr< FMetasoundFrontendDocument >  
Public function void Rebuild dependent asset classes.
Protected function void  
Public function void Registers the root graph of the given asset with the MetaSound Frontend.
Public function void

SetDocument ( const FMetasoundFrontendDocument& InDocument
)

 Overwrites the existing document.
Public function void Overwrites the existing document.
Public function void

SetGraph ( UEdGraph* InGraph
)

 Sets the graph associated with this Metasound.
Protected function void  
Public function void Only required for editor builds.
Public function void Unregisters the root graph of the given asset with the MetaSound Frontend.
Public function bool  

Classes

  Type Name Description
Protected struct FRuntimeData Container for runtime data of MetaSound graph.  
Public struct FSendInfoAndVertexName    

Constants

Name Description
FileExtension  

Deprecated Functions

  Type Name Description
Public function void AddDefaultInterfaces is included in now applied via FMetaSoundFrontendDocumentBuilder::InitDocument and no longer directly supported via this function.
Public function void ConvertFromPreset moved to FMetaSoundFrontendDocumentBuilder.
Public function Const bool Use static FMetaSoundFrontendDocumentBuilder 'FindDeclaredInterfaces instead.
Protected function Const TArray< FSendInfoAndVertexName >

GetSendInfos ( uint64 InInstanceID
)

 MetaSounds no longer communicate using FSendInfo.
Public function Virtual void Directly setting graph class Metadata is no longer be supported. Use the FMetaSoundFrontendDocumentBuilder to modify class data.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page