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 > MetasoundEngine > UMetaSound

Light Theme

Dark Theme

UMetaSound

This asset type is used for Metasound assets that can only be used as nodes in other Metasound graphs.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMetaSound

References

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

Syntax

UCLASS(HideCategories=object, BlueprintType)
class UMetaSound :
public UObject,
public FMetasoundAssetBase

Remarks

This asset type is used for Metasound assets that can only be used as nodes in other Metasound graphs. Because of this, they contain no required inputs or outputs.

Variables

		Name	Description
	FGuid	AssetClassID
	UMetasoundEdito...	Graph
	TSet< FSoftObje...	ReferenceAssetClassCache
	TSet< FString >	ReferencedAssetClassKeys
	FString	RegistryInputTypes
	FString	RegistryOutputTypes
	int32	RegistryVersionMajor
	int32	RegistryVersionMinor
	FMetasoundFront...	RootMetaSoundDocument

Constructors

	Name	Description
	UMetaSound ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	FName	GetDocumentPropertyName()	Returns document name (for editor purposes, and avoids making document public for edit while allowing editor to reference directly)

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	PostDuplicate ( EDuplicateMode::Type DuplicateMode )
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostEditUndo()	Called after applying a transaction to the object.
void	PreSave ( FObjectPreSaveContext SaveContext )	Presave function.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from FMetasoundAssetBase

	Name	Description
bool	ConformObjectDataToInterfaces()	Called when the interface is changed, presenting the opportunity for.
Metasound::F...	GetAssetClassInfo()	Returns Asset Metadata associated with this MetaSound.
FText	GetDisplayName()	Name to display in editors.
Metasound::F...	GetDocument()	Returns an access pointer to the document.
Metasound::F...	GetDocument()	Returns an access pointer to the document.
const UEdGra...	GetGraph()
UEdGraph ...	GetGraph()	Returns the graph associated with this Metasound.
const UEdGra...	GetGraphChecked()
UEdGraph &	GetGraphChecked()
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.
const TSet< ...	GetReferencedAssetClassCache()
TSet< FSoftO...	GetReferencedAssetClassCache()	Returns set of cached class references set on last registration prior to serialize.
const TSet< ...	GetReferencedAssetClassKeys()	Returns all the class keys of this asset's referenced assets.
void	SetGraph ( UEdGraph* InGraph )	Sets the graph associated with this Metasound.
void	SetReferencedAssetClassKeys ( TSet< Metasound::Frontend::FNodeReg... )
void	SetRegistryAssetClassInfo ( const Metasound::Frontend::FNodeCla... )	Sets Asset Registry Metadata associated with this MetaSound.