1. Epic GamesDeveloper
  3. UMetaSoundSource

UMetaSoundSource

This Metasound type can be played as an audio source.

API > API/Plugins > API/Plugins/MetasoundEngine

This Metasound type can be played as an audio source.

   
Name UMetaSoundSource
Type class
Header File /Engine/Plugins/Runtime/Metasound/Source/MetasoundEngine/Public/MetasoundSource.h
Include Path #include "MetasoundSource.h"

Syntax

UCLASS (MinimalAPI, HideCategories=object, BlueprintType, Meta=(DisplayName="MetaSound Source"))  
class UMetaSoundSource :  
    public USoundWaveProcedural ,  
    public FMetasoundAssetBase ,  
    public IMetaSoundDocumentInterface

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UMetaSoundSource ( const FObjectInitializer& ObjectInitializer
)

   MetasoundSource.h  

Classes

Name Remarks
FAudioParameterCollector  

Structs

Name Remarks
FRuntimeInput FRuntimeInput represents an input to a MetaSound which can be manipulated.
FRuntimeInputData  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AssetClassID FGuid   MetasoundSource.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Property is now serialized directly as asset tag")
bIsPreset bool   MetasoundSource.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Property is now serialized directly as asset tag")
BlockRateOverride FPerPlatformFloat 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. MetasoundSource.h
  • EditAnywhere
  • BlueprintReadOnly
  • AdvancedDisplay
  • Category=Metasound
  • Meta=(UIMin=0, UIMax=1000.0, DisplayAfter="OutputFormat", DisplayName="Override Block Rate (in Hz)")
OnGeneratorInstanceCreated PRAGMA_DISABLE_DEPRECATION_WARNINGSFOnGeneratorInstanceCreated   MetasoundSource.h  
OnGeneratorInstanceDestroyed FOnGeneratorInstanceDestroyed   MetasoundSource.h  
OnGeneratorInstanceInfoCreated FGeneratorInstanceInfoDelegate   MetasoundSource.h  
OnGeneratorInstanceInfoDestroyed FGeneratorInstanceInfoDelegate   MetasoundSource.h  
OutputFormat EMetaSoundOutputAudioFormat The output audio format of the metasound source. MetasoundSource.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Metasound
QualitySetting FName The QualitySetting MetaSound will use, as defined in 'MetaSound' Settings. MetasoundSource.h
  • EditAnywhere
  • BlueprintReadWrite
  • AssetRegistrySearchable
  • Meta=(GetOptions="MetasoundEngine.MetaSoundSettings.GetQualityNames")
  • Category="Metasound"
QualitySettingGuid FGuid This a editor only look up for the Quality Setting above. Preventing orphaning of the original name. MetasoundSource.h  
RegistryInputTypes FString   MetasoundSource.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Property is now serialized directly as asset tag")
RegistryOutputTypes FString   MetasoundSource.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Property is now serialized directly as asset tag")
RegistryVersionMajor int32   MetasoundSource.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Property is now serialized directly as asset tag")
RegistryVersionMinor int32   MetasoundSource.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Property is now serialized directly as asset tag")
SampleRateOverride FPerPlatformInt 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. MetasoundSource.h
  • EditAnywhere
  • BlueprintReadOnly
  • AdvancedDisplay
  • Category=Metasound
  • Meta=(UIMin=0, UIMax=96000, DisplayName="Override Sample Rate (in Hz)")

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsBuilderActive bool   MetasoundSource.h  
bIsPresetGraphInflationSupported bool Preset graph inflation is a performance optimization intended for use with the MetaSoundOperatorPool. MetasoundSource.h  
CachedAudioDeviceSampleRate Metasound::FSampleRate Cache the AudioDevice Samplerate. (so that if we have to regenerate operator settings without the device rate we can use this). MetasoundSource.h  
CookedQualitySettings TPimplPtr< Metasound::SourcePrivate::FCookedQualitySettings >   MetasoundSource.h  
DynamicTransactor TSharedPtr< Metasound::DynamicGraph::FDynamicOperatorTransactor >   MetasoundSource.h  
GeneratorMapCriticalSection FCriticalSection   MetasoundSource.h  
Generators TArray< Metasound::FGeneratorInstanceInfo >   MetasoundSource.h  
RuntimeInputData FRuntimeInputData   MetasoundSource.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
  MetasoundSource.h  

const UMetaSoundSource & FindFirstNoninflatableSource ( Metasound::FMetasoundEnvironment& InOutEnvironment,
TFunctionRef< void(const UMetaSoundSource&)> OnTraversal
) const

 Find the Source related to this Preset. MetasoundSource.h  

TWeakPtr< Metasound::FMetasoundGenerator > GetGeneratorForAudioComponent ( uint64 ComponentId
) const

 Attempt to get a generator for a given AudioComponentID. MetasoundSource.h  

TWeakPtr< Metasound::FMetasoundGenerator > GetGeneratorForInstanceID ( uint64 InstanceId
) const

 Attempt to get a generator for a given InstanceID. MetasoundSource.h  

Metasound::FOperatorSettings GetOperatorSettings ( Metasound::FSampleRate InDeviceSampleRate
) const

   MetasoundSource.h  

const TArray< Metasound::FVertexName > & GetOutputAudioChannelOrder()

   MetasoundSource.h  

bool IsDynamic()

   MetasoundSource.h  

void PostLoadQualitySettings()

   MetasoundSource.h  
  MetasoundSource.h  

Overridden from USoundWave

Name Remarks Include Path Unreal Specifiers

virtual bool CanVisualizeAsset()

   MetasoundSource.h  

virtual bool GetRedrawThumbnail()

   MetasoundSource.h  

virtual void OnEndGenerate ( ISoundGeneratorPtr Generator
)

   MetasoundSource.h  

virtual void SetRedrawThumbnail ( bool bInRedraw
)

   MetasoundSource.h  

Overridden from USoundBase

Name Remarks Include Path Unreal Specifiers

virtual TSharedPtr< Audio::IParameterTransmitter > CreateParameterTransmitter ( Audio::FParameterTransmitterInitParams&& InParams
) const

   MetasoundSource.h  

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

   MetasoundSource.h  

virtual float GetDuration()

   MetasoundSource.h  

virtual bool ImplementsParameterInterface ( Audio::FParameterInterfacePtr InInterface
) const

   MetasoundSource.h  

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

   MetasoundSource.h  

virtual void InitResources()

   MetasoundSource.h  

virtual bool IsLooping()

   MetasoundSource.h  

virtual bool IsOneShot()

   MetasoundSource.h  

virtual bool IsParameterValid ( const FAudioParameter& InParameter
) const

   MetasoundSource.h  

virtual bool IsPlayable()

   MetasoundSource.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   MetasoundSource.h  

virtual bool CanEditChange ( const FProperty* InProperty
) const

   MetasoundSource.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   MetasoundSource.h  

virtual EDataValidationResult IsDataValid ( FDataValidationContext& Context
) const

   MetasoundSource.h  

virtual void PostDuplicate ( EDuplicateMode::Type InDuplicateMode
)

   MetasoundSource.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& InEvent
)

   MetasoundSource.h  

virtual void PostEditUndo()

   MetasoundSource.h  

virtual void PostLoad()

   MetasoundSource.h  

virtual void PreDuplicate ( FObjectDuplicationParameters& DupParams
)

   MetasoundSource.h  

virtual void PreSave ( FObjectPreSaveContext InSaveContext
)

   MetasoundSource.h  

virtual void Serialize ( FArchive& Ar
)

   MetasoundSource.h  

Overridden from IAudioProxyDataFactory

Name Remarks Include Path Unreal Specifiers

virtual TSharedPtr< Audio::IProxyData > CreateProxyData ( const Audio::FProxyDataInitParams& InitParams
)

   MetasoundSource.h  

Overridden from FMetasoundAssetBase

Name Remarks Include Path Unreal Specifiers

virtual const TSet< FSoftObjectPath > & GetAsyncReferencedAssetClassPaths()

   MetasoundSource.h  

virtual FText GetDisplayName()

 Name to display in editors. MetasoundSource.h  

virtual UEdGraph * GetGraph ()

 Returns the graph associated with this Metasound. MetasoundSource.h  

virtual UEdGraph & GetGraphChecked()

   MetasoundSource.h  

virtual const UObject * GetOwningAsset ()

   MetasoundSource.h  

virtual UObject * GetOwningAsset ()

   MetasoundSource.h  

virtual const TSet< FString > & GetReferencedAssetClassKeys()

   MetasoundSource.h  

virtual TArray< FMetasoundAssetBase * > GetReferencedAssets()

   MetasoundSource.h  

virtual void MigrateEditorGraph ( FMetaSoundFrontendDocumentBuilder& OutBuilder
)

   MetasoundSource.h  

virtual void OnAsyncReferencedAssetsLoaded ( const TArray< FMetasoundAssetBase* >& InAsyncReferences
)

   MetasoundSource.h  

virtual void SetGraph ( UEdGraph* InGraph
)

 Sets the graph associated with this Metasound. MetasoundSource.h  
  MetasoundSource.h  

Overridden from IMetaSoundDocumentInterface

Name Remarks Include Path Unreal Specifiers

virtual bool ConformObjectToDocument()

   MetasoundSource.h  

virtual FTopLevelAssetPath GetAssetPathChecked()

   MetasoundSource.h  

virtual const UClass & GetBaseMetaSoundUClass()

   MetasoundSource.h  

virtual const UClass & GetBuilderUClass()

   MetasoundSource.h  

virtual const FMetasoundFrontendDocument & GetConstDocument()

   MetasoundSource.h  

virtual EMetasoundFrontendClassAccessFlags GetDefaultAccessFlags()

   MetasoundSource.h  

virtual bool IsActivelyBuilding()

   MetasoundSource.h  

Protected

Overridden from USoundBase

Name Remarks Include Path Unreal Specifiers

virtual bool GetAllDefaultParameters ( TArray< FAudioParameter >& OutParameters
) const

 Gets all the default parameters for this Asset. MetasoundSource.h  

Overridden from FMetasoundAssetBase

Name Remarks Include Path Unreal Specifiers

virtual is particularly problematic as in so the builder s caches are reset which can cause major editor performance regressions Metasound::Frontend::FDocumentAccessPtr GetDocumentAccessPtr()

   MetasoundSource.h  

virtual Metasound::Frontend::FConstDocumentAccessPtr GetDocumentConstAccessPtr()

   MetasoundSource.h  

virtual void SetReferencedAssets ( TSet< Metasound::Frontend::IMetaSoundAssetManager::FAssetRef >&& InAssetRefs
)

   MetasoundSource.h  

Static

Name Remarks Include Path Unreal Specifiers

static FRuntimeInput CreateRuntimeInput ( const Metasound::Frontend::IDataTypeRegistry& Registry,
const FMetasoundFrontendClassInput& Input,
bool bCreateUObjectProxies,
TArrayView< const FGuid > InPageOrder
)

   MetasoundSource.h  

static FName GetDocumentPropertyName()

 Returns document name (for editor purposes, and avoids making document public for edit while allowing editor to reference directly) MetasoundSource.h  

static Metasound::SourcePrivate::FParameterRouter & GetParameterRouter()

   MetasoundSource.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page