Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > MetasoundFrontend > FMetasoundAssetBase

Light Theme

Dark Theme

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
	bool	bSynchronizationClearUpdateNotes
	bool	bSynchronizationRequired
	bool	bSynchronizationUpdateDetails

Constructors

	Name	Description
	FMetasoundAssetBase()

Destructors

	Name	Description
	~FMetasoundAssetBase()

Functions

	Name	Description
void	AddDefaultInterfaces()
bool	AddingReferenceCausesLoop ( const FSoftObjectPath& InReference... )
bool	AutoUpdate ( bool bInMarkDirty )
bool	ConformObjectDataToInterfaces()	Called when the interface is changed, presenting the opportunity for.
void	ConvertFromPreset()
Metasound::F...	GetAssetClassInfo()	Gets the asset class info.
bool	GetDeclaredInterfaces ( TArray< const Metasound::Frontend::... )	Returns the interface entries declared by the given asset's document from the InterfaceRegistry.
FText	GetDisplayName ( FString&& InTypeName )
FText	GetDisplayName()
Metasound::F...	GetDocument()	Returns an access pointer to the document.
Metasound::F...	GetDocument()	Returns an access pointer to the document.
const FMetas...	GetDocumentChecked()
FMetasoundFr...	GetDocumentChecked()
Metasound::F...	GetDocumentHandle()	Returns handle for the root metasound graph of this asset.
Metasound::F...	GetDocumentHandle()	Returns handle for the root metasound graph of this asset.
UEdGraph ...	GetGraph()	Returns the graph associated with this Metasound.
const UEdGra...	GetGraph()
const UEdGra...	GetGraphChecked()
UEdGraph &	GetGraphChecked()
TSharedPtr< ...	GetMetasoundCoreGraph()	Returns a shared instance of the core metasound graph.
const UObjec...	GetOwningAsset()	Returns the owning asset responsible for transactions applied to MetaSound.
UObject *...	GetOwningAsset()	Returns the owning asset responsible for transactions applied to MetaSound.
FString	GetOwningAssetName()
TSet< FSoftO...	GetReferencedAssetClassCache()	Returns set of cached class references set on last registration prior to serialize.
const TSet< ...	GetReferencedAssetClassCache()
const TSet< ...	GetReferencedAssetClassKeys()	Returns all the class keys of this asset's referenced assets.
Metasound::F...	GetRootGraphHandle()	Returns handle for the root metasound graph of this asset.
Metasound::F...	GetRootGraphHandle()	Returns handle for the root metasound graph of this asset.
TArray< FSen...	GetSendInfos ( uint64 InInstanceID )	Get information for communicating asynchronously with MetaSound running instance.
bool	GetSynchronizationClearUpdateNotes()
bool	GetSynchronizationRequired()	TODO: These flags & associated functions are highly UE editor-specific.
bool	GetSynchronizationUpdateDetails()
bool	ImportFromJSON ( const FString& InJSON )	Imports data from a JSON string directly.
bool	ImportFromJSONAsset ( const FString& InAbsolutePath )	Imports the asset from a JSON file at provided path.
bool	IsInterfaceDeclared ( const FMetasoundFrontendVersion& I... )	Returns whether an interface with the given version is declared by the given asset's document.
bool	IsReferencedAsset ( const FMetasoundAssetBase& InAsset... )
bool	IsRegistered()
bool	MarkMetasoundDocumentDirty()	Calls the outermost package and marks it dirty.
void	RegisterGraphWithFrontend ( Metasound::Frontend::FMetaSoundAsse... )	Registers the root graph of the given asset with the MetaSound Frontend.
void	ResetSynchronizationState()
void	SetClearNodeNotesOnSynchronization()
void	SetDocument ( const FMetasoundFrontendDocument& ... )	Overwrites the existing document.
void	SetGraph ( UEdGraph* InGraph )	Sets the graph associated with this Metasound.
void	SetMetadata ( FMetasoundFrontendClassMetadata& I... )	Sets/overwrites the root class metadata.
void	SetReferencedAssetClassKeys ( TSet< Metasound::Frontend::FNodeReg... )
void	SetRegistryAssetClassInfo ( const Metasound::Frontend::FNodeCla... )	Only required for editor builds.
void	SetSynchronizationRequired()
void	SetUpdateDetailsOnSynchronization()
void	UnregisterGraphWithFrontend()	Unregisters the root graph of the given asset with the MetaSound Frontend.
bool	VersionAsset()

Classes

	Name	Description
	FSendInfoAndVertexName

Constants

Name	Description
FileExtension