UMetaSoundEditorSubsystem

The subsystem in charge of editor MetaSound functionality

API > API/Plugins > API/Plugins/MetasoundEditor

The subsystem in charge of editor MetaSound functionality

   
Name UMetaSoundEditorSubsystem
Type class
Header File /Engine/Plugins/Runtime/Metasound/Source/MetasoundEditor/Public/MetasoundEditorSubsystem.h
Include Path #include "MetasoundEditorSubsystem.h"

Syntax

UCLASS (MinimalAPI, Meta=(DisplayName="MetaSound Editor Subsystem"))  
class UMetaSoundEditorSubsystem : public UEditorSubsystem

Inheritance Hierarchy

Structs

Name Remarks
FInitAssetArgs  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
EditorToolbarExtenders TArray< TSharedRef< FExtender > > Editor Toolbar Extenders. MetasoundEditorSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UMetaSoundEditorBuilderListener * AddBuilderDelegateListener ( UMetaSoundBuilderBase* InBuilder,
EMetaSoundBuilderResult& OutResult
)

 Add a builder listener for a builder which is used to add and remove custom editor builder delegates. MetasoundEditorSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder|Editor"
  • Meta=(ExpandEnumAsExecs="OutResult")

bool BindMemberMetadata ( FMetaSoundFrontendDocumentBuilder& Builder,
UMetasoundEditorGraphMember& InMember,
TSubclassOf< UMetasoundEditorGraphMemberDefaultLiteral > LiteralClass,
UMetasoundEditorGraphMemberDefaultLiteral* TemplateObject
)

 Binds literal editor Metadata to the given member. MetasoundEditorSubsystem.h  

TScriptInterface< IMetaSoundDocumentInterface > BuildToAsset ( UMetaSoundBuilderBase* InBuilder,
const FString& Author,
const FString& AssetName,
const FString& PackagePath,
EMetaSoundBuilderResult& OutResult,
const USoundWave* TemplateSoundWave
)

 Build the given builder to a MetaSound asset MetasoundEditorSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder|Editor"
  • Meta=(WorldContext="Parent", ExpandEnumAsExecs="OutResult")

UMetasoundEditorGraphMemberDefaultLiteral * CreateMemberMetadata ( FMetaSoundFrontendDocumentBuilder& Builder,
FName InMemberName,
TSubclassOf< UMetasoundEditorGraphMemberDefaultLiteral > LiteralClass
) const

   MetasoundEditorSubsystem.h  

UMetaSoundBuilderBase * FindOrBeginBuilding ( TScriptInterface< IMetaSoundDocumentInterface > MetaSound,
EMetaSoundBuilderResult& OutResult
) const

 Returns a builder for the given MetaSound asset. MetasoundEditorSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder|Editor"
  • Meta=(DisplayName="Find Or Begin Building MetaSound Asset", ExpandEnumAsExecs="OutResult")

UMetaSoundFrontendMemberMetadata * FindOrCreateGraphInputMetadata ( UMetaSoundBuilderBase* InBuilder,
FName InputName,
EMetaSoundBuilderResult& OutResult
)

 Find graph input metadata (which includes editor only range information for floats) for a given input. If the metadata does not exist, create it. MetasoundEditorSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder"
  • Meta=(ExpandEnumAsExecs="OutResult")

FName GetBuildPage ( UMetaSoundBuilderBase* Builder
) const

 Get the build page. MetasoundEditorSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder|Editor"

const FString GetDefaultAuthor()

 Get the default author for a MetaSound asset. MetasoundEditorSubsystem.h  

TSubclassOf< UMetasoundEditorGraphMemberDefaultLiteral > GetLiteralClassForType ( FName TypeName
) const

 Returns the corresponding literal class for a given type. MetasoundEditorSubsystem.h  

const TArray< TSharedRef< FExtender > > & GetToolbarExtenders()

 Returns all currently toolbar extenders registered to be displayed within the MetaSound Asset Editor. MetasoundEditorSubsystem.h  

void InitAsset ( UObject& InNewMetaSound,
UObject* InReferencedMetaSound,
const bool bClearDocument
)

   MetasoundEditorSubsystem.h  

void InitAsset ( UObject& InNewMetaSound,
FInitAssetArgs InitAssetArgs
)

 Initialize the UObject asset with optional initialization arguments to be applied. MetasoundEditorSubsystem.h  

bool IsPageAuditionPlatformCookTarget ( const FGuid& InPageID
) const

   MetasoundEditorSubsystem.h  

bool IsPageAuditionPlatformCookTarget ( FName InPageName
) const

 Returns whether or not a page with the given name both exists and is set as a valid, cooked target for the currently set audition platform in editor. MetasoundEditorSubsystem.h  

void RegisterGraphWithFrontend ( UObject& InMetaSound,
bool bInForceViewSynchronization
) const

 Wraps RegisterGraphWithFrontend logic in Frontend with any additional logic required to refresh editor & respective editor object state. MetasoundEditorSubsystem.h  

void RegisterToolbarExtender ( TSharedRef< FExtender > InExtender
)

 Register toolbar extender that will be displayed in the MetaSound Asset Editor. MetasoundEditorSubsystem.h  

void SetBuildPage ( UMetaSoundBuilderBase* Builder,
FName PageName,
EMetaSoundBuilderResult& OutResult
) const

 If the given page name is implemented on the provided builder, sets the build page. MetasoundEditorSubsystem.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="Audio|MetaSound|Builder|Editor"
  • Meta=(ExpandEnumAsExecs="OutResult")

void SetFocusedPage ( UMetaSoundBuilderBase* Builder,
FName PageName,
bool bOpenEditor,
EMetaSoundBuilderResult& OutResult
) const

 If the given page name is implemented on the provided builder, sets the focused (and build) page of the provided builder to the associated page and sets the audition page to the provided name. MetasoundEditorSubsystem.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="Audio|MetaSound|Builder|Editor"
  • Meta=(ExpandEnumAsExecs="OutResult")

bool SetFocusedPage ( UMetaSoundBuilderBase& Builder,
const FGuid& InPageID,
bool bOpenEditor,
bool bPostTransaction
) const

 If the given PageID is implemented on the provided builder, sets the focused page of the provided builder to the associated page and sets the audition target page to the provided ID. MetasoundEditorSubsystem.h  

void SetNodeLocation ( UMetaSoundBuilderBase* InBuilder,
const FMetaSoundNodeHandle& InNode,
const FVector2D& InLocation,
EMetaSoundBuilderResult& OutResult
)

 Sets the visual location to InLocation of a given node InNode of a given builder's document. MetasoundEditorSubsystem.h
  • BlueprintCallable
  • Category="Audio|MetaSound|Builder|Editor"
  • Meta=(ExpandEnumAsExecs="OutResult")

void SetSoundWaveSettingsFromTemplate ( USoundWave& NewMetasound,
const USoundWave& TemplateSoundWave
) const

 Copy over sound wave settings such as attenuation, modulation, and sound class from the template sound wave to the MetaSound. MetasoundEditorSubsystem.h  

bool UnregisterToolbarExtender ( TSharedRef< FExtender > InExtender
)

 Unregisters toolbar extender that is displayed in the MetaSound Asset Editor. MetasoundEditorSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static UMetaSoundEditorSubsystem & GetChecked()

   MetasoundEditorSubsystem.h  

static const UMetaSoundEditorSubsystem & GetConstChecked()

   MetasoundEditorSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page