unreal.MetaSoundEditorSubsystem

class unreal.MetaSoundEditorSubsystem(outer: Object | None = None, name: Name | str = 'None')

Bases: EditorSubsystem

The subsystem in charge of editor MetaSound functionality

C++ Source:

  • Plugin: Metasound

  • Module: MetasoundEditor

  • File: MetasoundEditorSubsystem.h

add_builder_delegate_listener(builder) -> (MetaSoundEditorBuilderListener, out_result=MetaSoundBuilderResult)

Add a builder listener for a builder which is used to add and remove custom editor builder delegates.

Parameters:

builder (MetaSoundBuilderBase)

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

build_to_asset(builder, author, asset_name, package_path, template_sound_wave=None) -> (MetaSoundDocumentInterface, out_result=MetaSoundBuilderResult)

Build the given builder to a MetaSound asset

Parameters:

  • builder (MetaSoundBuilderBase)

  • author (str) – Sets the author on the given builder’s document.

  • asset_name (str) – Name of the asset to build.

  • package_path (str) – Path of package to build asset to.

  • template_sound_wave (SoundWave) – SoundWave settings such as attenuation, modulation, and sound class will be copied from the optional TemplateSoundWave. For preset builders, TemplateSoundWave will override the template values from the referenced asset.

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

find_or_begin_building(meta_sound) -> (MetaSoundBuilderBase, out_result=MetaSoundBuilderResult)

Returns a builder for the given MetaSound asset. Returns null if provided a transient MetaSound. For finding builders for transient MetaSounds, use the UMetaSoundBuilderSubsystem’s API (FindPatchBuilder, FindSourceBuilder, FindBuilderByName etc.)

Parameters:

meta_sound (MetaSoundDocumentInterface)

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

find_or_create_graph_input_metadata(builder, input_name) -> (MetaSoundFrontendMemberMetadata, out_result=MetaSoundBuilderResult)

Find graph input metadata (which includes editor only range information for floats) for a given input. If the metadata does not exist, create it.

Parameters:
Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

set_focused_page(builder, page_name, open_editor) → MetaSoundBuilderResult

If the given page name is implemented on the provided builder, sets the focused page of the provided builder to the associated page and sets the audition page to the provided name. If the given builder has an asset editor open, optionally opens or brings that editor’s associated PageID into user focus.

Parameters:
Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

set_node_location(builder, node, location) → MetaSoundBuilderResult

Sets the visual location to InLocation of a given node InNode of a given builder’s document.

Parameters:
Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult