FMetasoundAssetBase

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FMetasoundAssetBase

UMetaSound

UMetaSoundSource

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.

Variables

Name Description

Protected variable

bool

 

bSynchronizationClearUpdateNotes

Protected variable

bool

 

bSynchronizationRequired

Protected variable

bool

 

bSynchronizationUpdateDetails

Constructors

Name Description

Public function

FMetasoundAssetBase()

Destructors

Name Description

Public function Virtual

~FMetasoundAssetBase()

Functions

Name Description

Public function

void

 

AddDefaultInterfaces()

Public function Const

bool

 

AddingReferenceCausesLoop

(
    const FSoftObjectPath& InReference...
)

Public function

bool

 

AutoUpdate

(
    bool bInMarkDirty
)

Public function

bool

 

ConformObjectDataToInterfaces()

Called when the interface is changed, presenting the opportunity for.

Public function

void

 

ConvertFromPreset()

Public function Const

Metasound::F...

 

GetAssetClassInfo()

Gets the asset class info.

Public function Const

bool

 

GetDeclaredInterfaces

(
    TArray< const Metasound::Frontend::...
)

Returns the interface entries declared by the given asset's document from the InterfaceRegistry.

Protected function Const

FText

 

GetDisplayName

(
    FString&& InTypeName
)

Public function Const

FText

 

GetDisplayName()

Protected function

Metasound::F...

 

GetDocument()

Returns an access pointer to the document.

Protected function Const

Metasound::F...

 

GetDocument()

Returns an access pointer to the document.

Public function Const

const FMetas...

 

GetDocumentChecked()

Public function

FMetasoundFr...

 

GetDocumentChecked()

Public function Const

Metasound::F...

 

GetDocumentHandle()

Returns handle for the root metasound graph of this asset.

Public function

Metasound::F...

 

GetDocumentHandle()

Returns handle for the root metasound graph of this asset.

Public function

UEdGraph ...

 

GetGraph()

Returns the graph associated with this Metasound.

Public function Const

const UEdGra...

 

GetGraph()

Public function Const

const UEdGra...

 

GetGraphChecked()

Public function

UEdGraph &

 

GetGraphChecked()

Protected function Const

TSharedPtr< ...

 

GetMetasoundCoreGraph()

Returns a shared instance of the core metasound graph.

Public function Const

const UObjec...

 

GetOwningAsset()

Returns the owning asset responsible for transactions applied to MetaSound.

Public function

UObject *...

 

GetOwningAsset()

Returns the owning asset responsible for transactions applied to MetaSound.

Public function Const

FString

 

GetOwningAssetName()

Public function

TSet< FSoftO...

 

GetReferencedAssetClassCache()

Returns set of cached class references set on last registration prior to serialize.

Public function Const

const TSet< ...

 

GetReferencedAssetClassCache()

Public function Const

const TSet< ...

 

GetReferencedAssetClassKeys()

Returns all the class keys of this asset's referenced assets.

Public function Const

Metasound::F...

 

GetRootGraphHandle()

Returns handle for the root metasound graph of this asset.

Public function

Metasound::F...

 

GetRootGraphHandle()

Returns handle for the root metasound graph of this asset.

Protected function Const

TArray< FSen...

 

GetSendInfos

(
    uint64 InInstanceID
)

Get information for communicating asynchronously with MetaSound running instance.

Public function Const

bool

 

GetSynchronizationClearUpdateNotes()

Public function Const

bool

 

GetSynchronizationRequired()

TODO: These flags & associated functions are highly UE editor-specific.

Public function Const

bool

 

GetSynchronizationUpdateDetails()

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

 

IsInterfaceDeclared

(
    const FMetasoundFrontendVersion& I...
)

Returns whether an interface with the given version is declared by the given asset's document.

Public function Const

bool

 

IsReferencedAsset

(
    const FMetasoundAssetBase& InAsset...
)

Public function Const

bool

 

IsRegistered()

Public function Const

bool

 

MarkMetasoundDocumentDirty()

Calls the outermost package and marks it dirty.

Public function

void

 

RegisterGraphWithFrontend

Registers the root graph of the given asset with the MetaSound Frontend.

Public function

void

 

ResetSynchronizationState()

Public function

void

 

SetClearNodeNotesOnSynchronization()

Public function

void

 

SetDocument

(
    const FMetasoundFrontendDocument& ...
)

Overwrites the existing document.

Public function

void

 

SetGraph

(
    UEdGraph* InGraph
)

Sets the graph associated with this Metasound.

Public function Virtual

void

 

SetMetadata

Sets/overwrites the root class metadata.

Protected function

void

 

SetReferencedAssetClassKeys

Public function

void

 

SetRegistryAssetClassInfo

(
    const Metasound::Frontend::FNodeCla...
)

Only required for editor builds.

Public function

void

 

SetSynchronizationRequired()

Public function

void

 

SetUpdateDetailsOnSynchronization()

Public function

void

 

UnregisterGraphWithFrontend()

Unregisters the root graph of the given asset with the MetaSound Frontend.

Public function

bool

 

VersionAsset()

Classes

Name

Description

Public struct

FSendInfoAndVertexName

Constants

Name

Description

FileExtension