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

Light Theme

Dark Theme

UMetaSoundSource

This Metasound type can be played as an audio source.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USoundBase

USoundWave

USoundWaveProcedural

UMetaSoundSource

References

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

Syntax

UCLASS(HideCategories=object, BlueprintType)
class UMetaSoundSource :
public USoundWaveProcedural,
public FMetasoundAssetBase

Remarks

This Metasound type can be played as an audio source.

Variables

	Name	Description
FGuid	AssetClassID
UMetasoundEdito...	Graph
EMetasoundSourc...	OutputFormat	The output audio format of the metasound source.
TSet< FSoftObje...	ReferenceAssetClassCache
TSet< FString >	ReferencedAssetClassKeys
FString	RegistryInputTypes
FString	RegistryOutputTypes
int32	RegistryVersionMajor
int32	RegistryVersionMinor
FMetasoundFront...	RootMetasoundDocument

Constructors

	Name	Description
	UMetaSoundSource ( 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)
	bool	IsParameterValid ( const FAudioParameter& InParameter, const TMap< FName, FName >& InInpu... )

Overridden from USoundWave

		Name	Description
	bool	CanVisualizeAsset()
	bool	GetRedrawThumbnail()
	void	SetRedrawThumbnail ( bool bInRedraw )

Overridden from USoundBase

	Name	Description
TUniquePtr< ...	CreateParameterTransmitter ( Audio::FParameterTransmitterInitPar... )	Creates a parameter transmitter for communicating with active sound instances.
ISoundGenera...	CreateSoundGenerator ( const FSoundGeneratorInitParams& I... )	Creates a sound generator instance from this sound base.
bool	GetAllDefaultParameters ( TArray< FAudioParameter >& OutPara... )	Gets all the default parameters for this Asset.
float	GetDuration()	Returns the length of the sound
bool	ImplementsParameterInterface ( Audio::FParameterInterfacePtr InPar... )	Whether or not the given sound is a generator and implements an interface with the given name.
void	InitParameters ( TArray< FAudioParameter >& InParam..., FName InFeatureName )	Called from the Game Thread prior to attempting to pass parameters to the ParameterTransmitter.
void	InitResources()	Called from the Game Thread prior to attempting to initialize a sound instance.
bool	IsLooping()	Returns whether or not this sound is looping.
bool	IsOneShot()	Query if it's one shot. One shot is defined as a sound which is intended to have a fixed duration.
bool	IsParameterValid ( const FAudioParameter& InParameter )	Returns whether parameter is valid input for the given sound
bool	IsPlayable()	Returns whether the sound base is set up in a playable manner
bool	SupportsSubtitles()	Returns whether sound supports subtitles.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	PostDuplicate ( EDuplicateMode::Type InDuplicateMod... )
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 MetaSoundSource.
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.
UEdGraph ...	GetGraph()	Returns the graph associated with this Metasound.
const UEdGra...	GetGraph()
UEdGraph &	GetGraphChecked()
const UEdGra...	GetGraphChecked()
UObject *...	GetOwningAsset()	Returns the owning asset responsible for transactions applied to MetaSound.
const UObjec...	GetOwningAsset()	Returns the owning asset responsible for transactions applied to MetaSound.
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.
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 MetaSoundSource.