1. Epic GamesDeveloper
  3. UMetaSoundSource

UMetaSoundSource

This Metasound type can be played as an audio source.

API > API/Plugins > API/Plugins/MetasoundEngine

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;HideCategories&61;object, BlueprintType&41;  
class UMetaSoundSource :  
    public USoundWaveProcedural,  
    public FMetasoundAssetBase,  
    public IMetaSoundDocumentInterface

Remarks

This Metasound type can be played as an audio source.

Variables

  Type Name Description
Public variable UProperty assetregistrysearchable FGuid AssetClassID  
Public variable UProperty assetregistrysearchable bool bIsPreset  
Protected variable UProperty TObjectPtr< UMetasoundEditorGraphBase > Graph  
Public variable FOnGeneratorInstanceCreated OnGeneratorInstanceCreated  
Public variable FOnGeneratorInstanceDestroyed OnGeneratorInstanceDestroyed  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly EMetaSoundOutputAudioFormat OutputFormat The output audio format of the metasound source.
Protected variable UProperty TSet< FSoftObjectPath > ReferenceAssetClassCache  
Protected variable UProperty TSet< FString > ReferencedAssetClassKeys  
Protected variable UProperty TSet< TObjectPtr< UObject > > ReferencedAssetClassObjects  
Public variable UProperty assetregistrysearchable FString RegistryInputTypes  
Public variable UProperty assetregistrysearchable FString RegistryOutputTypes  
Public variable UProperty assetregistrysearchable int32 RegistryVersionMajor  
Public variable UProperty assetregistrysearchable int32 RegistryVersionMinor  
Protected variable UProperty Category, EditAnywhere FMetasoundFrontendDocument RootMetasoundDocument  

Constructors

  Type Name Description
Public function  

UMetaSoundSource ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static FName Returns document name (for editor purposes, and avoids making document public for edit while allowing editor to reference directly)
Public function Const TWeakPtr< Metasound::FMetasoundGenerator >

GetGeneratorForAudioComponent ( uint64 ComponentId
)

  

Overridden from USoundWave

  Type Name Description
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void

OnEndGenerate ( ISoundGeneratorPtr Generator
)

  
Public function Virtual void

SetRedrawThumbnail ( bool bInRedraw
)

  

Overridden from USoundBase

  Type Name Description
Public function Virtual Const TSharedPtr< Audio::IParameterTransmitter > Creates a parameter transmitter for communicating with active sound instances.
Public function Virtual ISoundGeneratorPtr

CreateSoundGenerator ( const FSoundGeneratorInitParams& InParams,
TArray< FAudioParameter >&& InDefaultParameters
)

 Creates a sound generator instance from this sound base.
Public function Virtual Const bool Whether or not this sound allows submix sends on preview.
Protected function Virtual Const bool Gets all the default parameters for this Asset.
Public function Virtual Const float Returns the length of the sound
Public function Virtual Const bool Whether or not the given sound is a generator and implements an interface with the given name.
Public function Virtual void

InitParameters ( TArray< FAudioParameter >& ParametersToInit,
FName InFeatureName
)

 Called from the Game Thread prior to attempting to pass parameters to the ParameterTransmitter.
Public function Virtual void Called from the Game Thread prior to attempting to initialize a sound instance.
Public function Virtual Const bool Returns whether or not this sound is looping.
Public function Virtual Const bool Query if it's one shot. One shot is defined as a sound which is intended to have a fixed duration.
Public function Virtual Const bool

IsParameterValid ( const FAudioParameter& InParameter
)

 Returns whether parameter is valid input for the given sound
Public function Virtual Const bool Returns whether the sound base is set up in a playable manner
Public function Virtual Const bool Returns whether sound supports subtitles.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostDuplicate ( EDuplicateMode::Type InDuplicateMode
)

  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from FMetasoundAssetBase

  Type Name Description
Public function Virtual bool Called when the interface is changed, presenting the opportunity for.
Public function Virtual Const Metasound::Frontend::FNodeClassInfo Returns Asset Metadata associated with this MetaSoundSource.
Public function Virtual Const const TSet< FSoftObjectPath > & Return all dependent asset paths to load asynchronously.
Public function Virtual Const FText Name to display in editors.
Protected function Virtual Metasound::Frontend::FDocumentAccessPtr Returns an access pointer to the document.
Protected function Virtual Const Metasound::Frontend::FConstDocumentAccessPtr Returns an access pointer to the document.
Public function Virtual UEdGraph * Returns the graph associated with this Metasound.
Public function Virtual Const const UEdGraph *  
Public function Virtual Const const UEdGraph &  
Public function Virtual UEdGraph &  
Public function Virtual Const const UObject * Returns the owning asset responsible for transactions applied to MetaSound.
Public function Virtual UObject * Returns the owning asset responsible for transactions applied to MetaSound.
Public function Virtual Const const TSet< FString > & Returns all the class keys of this asset's referenced assets.
Public function Virtual TArray< FMetasoundAssetBase * > Returns set of class references set call to serialize in the editor Used at runtime load register referenced classes.
Public function Virtual void

OnAsyncReferencedAssetsLoaded ( const TArray< FMetasoundAssetBase* >& InAsyncReferences
)

 Called when async assets have finished loading.
Public function Virtual void

SetGraph ( UEdGraph* InGraph
)

 Sets the graph associated with this Metasound.
Protected function Virtual void  
Public function Virtual void Sets Asset Registry Metadata associated with this MetaSoundSource.

Overridden from IMetaSoundDocumentInterface

  Type Name Description
Protected function Virtual Const const UClass & Returns the parent class registered with the MetaSound UObject registry.
Protected function Virtual Const const FMetasoundFrontendDocument & Returns read-only reference to the the MetaSoundFrontendDocument containing all MetaSound runtime & editor data.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page