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 (HideCategories=object, BlueprintType, Meta=(DisplayName="MetaSound Source"))  
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  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly FPerPlatformFloat BlockRateOverride Override the BlockRate for this Sound (overrides Quality). NOTE: A Zero value will have no effect and use either the Quality setting (if set), or the defaults.
Protected variable UProperty Transient TObjectPtr< UMetasoundEditorGraphBase > EditorGraph  
Protected variable UProperty Meta 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.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite assetregistrysearchable FName QualitySetting The QualitySetting MetaSound will use, as defined in 'MetaSound' Settings.
Public variable UProperty FGuid QualitySettingGuid This a editor only look up for the Quality Setting above. Preventing orphaning of the original name.
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  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly FPerPlatformInt SampleRateOverride Override the SampleRate for this Sound (overrides Quality). NOTE: A Zero value will have no effect and use either the Quality setting (if set), or the Device Rate.

Constructors

  Type Name Description
Public function  

UMetaSoundSource ( const FObjectInitializer& ObjectInitializer
)

  

Functions

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

CanEditChange ( const FProperty* InProperty
)

  
Public function Virtual Const bool  
Public function Const Metasound::FMetasoundEnvironment

CreateEnvironment ( const FSoundGeneratorInitParams& InParams
)

  
Public function Virtual Const TSharedPtr< Audio::IParameterTransmitter >  
Public function Virtual ISoundGeneratorPtr

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

  
Public function Virtual Const bool  
Public function Const const UMetaSoundSource & Find the Source related to this Preset.
Protected function Virtual Const bool Gets all the default parameters for this Asset.
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 Virtual Const float  
Public function Const TWeakPtr< Metasound::FMetasoundGenerator >  
Public function Const Metasound::FOperatorSettings  
Public function Const const TArray< Metasound::FVertexName > &  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void

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

  
Public function Virtual void  
Public function Virtual Const EDataValidationResult  
Public function Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool

IsParameterValid ( const FAudioParameter& InParameter
)

  
Public function Virtual Const bool  
Public function Virtual void

OnEndGenerate ( ISoundGeneratorPtr Generator
)

  
Public function Virtual void

PostDuplicate ( EDuplicateMode::Type InDuplicateMode
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function void  
Public function Virtual void  
Public function Virtual void

PreSave ( FObjectPreSaveContext InSaveContext
)

  
Public function Virtual void  
Public function Virtual void

SetRedrawThumbnail ( bool bInRedraw
)

  

Overridden from FMetasoundAssetBase

  Type Name Description
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 Const UEdGraph * Returns the graph associated with this Metasound.
Public function Virtual Const UEdGraph &  
Public function Virtual UObject * Returns the owning asset responsible for transactions applied to MetaSound.
Public function Virtual Const const 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  
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.
Public function Virtual void Registers the root graph of the given asset with the MetaSound Frontend.

Overridden from IMetaSoundDocumentInterface

  Type Name Description
Public function Virtual bool Conforms UProperty data outside the Frontend Document Model to the document's data.
Public function Virtual Const FTopLevelAssetPath  
Public function Virtual Const const UClass & Returns the parent class registered with the MetaSound UObject registry.
Public function Virtual Const const UClass & Returns the builder class used to modify the given document.
Public function Virtual Const const FMetasoundFrontendDocument & Returns read-only reference to the the MetaSoundFrontendDocument containing all MetaSound runtime & editor data.
Public function Virtual Const bool Returns whether or not a document builder is currently active and can mutate the given interface's document.

Classes

  Type Name Description
Public class FAudioParameterCollector    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page