1. Epic GamesDeveloper
  3. UMetaSoundSettings

UMetaSoundSettings

API > API/Plugins > API/Plugins/MetasoundEngine

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

Syntax

UCLASS (MinimalAPI, Config=MetaSound, defaultconfig, Meta=(DisplayName="MetaSounds"))  
class UMetaSoundSettings : public UDeveloperSettings

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AutoUpdateAssetDenylist TArray< FDefaultMetaSoundAssetAutoUpdateSettings > List of MetaSound assets whose node references should not be AutoUpdated. MetasoundSettings.h
  • EditAnywhere
  • Config
  • Category=AutoUpdate
  • Meta=(DisplayName="Asset DenyList", EditCondition="bAutoUpdateEnabled")
AutoUpdateDenylist TArray< FMetasoundFrontendClassName > List of native MetaSound classes whose node references should not be AutoUpdated. MetasoundSettings.h
  • EditAnywhere
  • Config
  • Category=AutoUpdate
  • Meta=(DisplayName="DenyList", EditCondition="bAutoUpdateEnabled")
bAutoUpdateEnabled bool If true, AutoUpdate is enabled, increasing load times. MetasoundSettings.h
  • EditAnywhere
  • Config
  • Category=AutoUpdate
bAutoUpdateLogWarningOnDroppedConnection bool If true, warnings will be logged if updating a node results in existing connections being discarded. MetasoundSettings.h
  • EditAnywhere
  • Config
  • Category=AutoUpdate
  • Meta=(DisplayName="Log Warning on Dropped Connection", EditCondition="bAutoUpdateEnabled")
DenyListCacheChangeID int32   MetasoundSettings.h
  • Transient
DirectoriesToRegister TArray< FDirectoryPath > Directories to scan & automatically register MetaSound post initial asset scan on engine start-up. MetasoundSettings.h
  • EditAnywhere
  • Config
  • Category=Registration
  • Meta=(RelativePath, LongPackageName)

Protected

Name Type Remarks Include Path Unreal Specifiers
bWarnAccessBeforeInit bool   MetasoundSettings.h  
CookPlatformTargetCritSec FCriticalSection   MetasoundSettings.h  
CookPlatformTargetPage FName   MetasoundSettings.h  
CookPlatformTargetPageIDs TArray< FGuid >   MetasoundSettings.h  
DefaultPageSettings FMetaSoundPageSettings Default page settings to be used in editor and if no other page settings are targeted or defined. MetasoundSettings.h
  • EditAnywhere
  • Config
  • Category="Pages (Experimental)"
OnDefaultRenamed Metasound::Engine::FOnSettingsDefaultConformed   MetasoundSettings.h  
OnPageSettingsUpdated Metasound::Engine::FOnPageSettingsUpdated   MetasoundSettings.h  
PageSettings TArray< FMetaSoundPageSettings > Array of possible page settings that can be added to a MetaSound object. MetasoundSettings.h
  • EditAnywhere
  • Config
  • Category="Pages (Experimental)"
QualitySettings TArray< FMetaSoundQualitySettings > Array of possible quality settings for Metasounds to chose from MetasoundSettings.h
  • EditAnywhere
  • Config
  • Category=Quality
TargetPageName FName Page Name to target when attempting to execute MetaSound. MetasoundSettings.h
  • EditAnywhere
  • Config
  • Category="Pages (Experimental)"
  • Meta=(GetOptions="MetasoundEngine.MetaSoundSettings.GetPageNames")
TargetPageNameOverride TOptional< FName > Target page override to use set from code/script (supercedes serialized 'TargetPageName' field). MetasoundSettings.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

const FMetaSoundPageSettings * FindPageSettings ( const FGuid& InPageID
) const

 Returns the page settings with the unique ID given. MetasoundSettings.h  
Returns the page settings with the provided name. MetasoundSettings.h  
Returns the quality settings with the provided name. MetasoundSettings.h  

const FMetaSoundQualitySettings * FindQualitySettings ( const FGuid& InQualityID
) const

 Returns the quality settings with the unique ID given. MetasoundSettings.h  

TArray< FName > GetAllPlatformNamesImplementingTargets()

 Returns superset of page platforms (and groups) that define page target(s). MetasoundSettings.h  

TArray< FGuid > GetCookedTargetPageIDs ( FName PlatformName
) const

 Returns PageIDs to be cooked to the given platform/platform group. MetasoundSettings.h  

const FMetaSoundPageSettings & GetDefaultPageSettings()

   MetasoundSettings.h  

Metasound::Engine::FOnSettingsDefaultConformed & GetOnDefaultRenamedDelegate()

   MetasoundSettings.h  

Metasound::Engine::FOnPageSettingsUpdated & GetOnPageSettingsUpdatedDelegate()

   MetasoundSettings.h  

const TArray< FMetaSoundPageSettings > & GetProjectPageSettings()

 Returns the project-specific page settings (does not include the required default settings). MetasoundSettings.h  

const TArray< FMetaSoundQualitySettings > & GetQualitySettings()

   MetasoundSettings.h  

const FMetaSoundPageSettings & GetTargetPageSettings()

 Returns the currently targeted page settings. MetasoundSettings.h  

void IterateCookedTargetPageIDs ( FName PlatformName,
TFunctionRef< void(const FGuid&)> Iter
) const

 Iterates PageIDs cooked to the given platform/platform group. MetasoundSettings.h  

void IteratePageSettings ( TFunctionRef< void(const FMetaSoundPageSettings&)> Iter,
bool bReverse
) const

 Iterates possible page settings in order (including the default page settings, which is always last). MetasoundSettings.h  

bool SetTargetPage ( FName PageName
)

 Sets the target page to the given name. MetasoundSettings.h  

Overridden from UDeveloperSettings

Name Remarks Include Path Unreal Specifiers

virtual FName GetCategoryName()

   MetasoundSettings.h  

Static

Name Remarks Include Path Unreal Specifiers

static TArray< FName > GetPageNames ()

 Returns an array of page names. MetasoundSettings.h  

static FName GetPageSettingPropertyName()

   MetasoundSettings.h  
Returns an array of quality setting names. MetasoundSettings.h  

static FName GetQualitySettingPropertyName()

   MetasoundSettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page