unreal.MetaSoundBuilderSubsystem

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

Bases: EngineSubsystem

The subsystem in charge of tracking MetaSound builders

C++ Source:

• Plugin: Metasound

• Module: MetasoundEngine

• File: MetasoundBuilderSubsystem.h

create_bool_array_meta_sound_literal(value) -> (MetasoundFrontendLiteral, data_type=Name)

Create Bool Array Meta Sound Literal

Parameters:

value (Array[bool]) –

Returns:

data_type (Name):

Return type:

Name

create_bool_meta_sound_literal(value) -> (MetasoundFrontendLiteral, data_type=Name)

Create Bool Meta Sound Literal

Parameters:

value (bool) –

Returns:

data_type (Name):

Return type:

Name

create_float_array_meta_sound_literal(value) -> (MetasoundFrontendLiteral, data_type=Name)

Create Float Array Meta Sound Literal

Parameters:

value (Array[float]) –

Returns:

data_type (Name):

Return type:

Name

create_float_meta_sound_literal(value) -> (MetasoundFrontendLiteral, data_type=Name)

Create Float Meta Sound Literal

Parameters:

value (float) –

Returns:

data_type (Name):

Return type:

Name

create_int_array_meta_sound_literal(value) -> (MetasoundFrontendLiteral, data_type=Name)

Create Int Array Meta Sound Literal

Parameters:

value (Array[int32]) –

Returns:

data_type (Name):

Return type:

Name

create_int_meta_sound_literal(value) -> (MetasoundFrontendLiteral, data_type=Name)

Create Int Meta Sound Literal

Parameters:

value (int32) –

Returns:

data_type (Name):

Return type:

Name

create_meta_sound_literal_from_param(param) → MetasoundFrontendLiteral

Create Meta Sound Literal from Param

Parameters:

param (AudioParameter) –

Return type:

MetasoundFrontendLiteral

create_object_array_meta_sound_literal(value) → MetasoundFrontendLiteral

Create Object Array Meta Sound Literal

Parameters:

value (Array[Object]) –

Return type:

MetasoundFrontendLiteral

create_object_meta_sound_literal(value) → MetasoundFrontendLiteral

Create Object Meta Sound Literal

Parameters:

value (Object) –

Return type:

MetasoundFrontendLiteral

create_patch_builder(builder_name) -> (MetaSoundPatchBuilder, out_result=MetaSoundBuilderResult)

Create Patch Builder

Parameters:

builder_name (Name) –

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

create_patch_preset_builder(builder_name, referenced_patch_class) -> (MetaSoundPatchBuilder, out_result=MetaSoundBuilderResult)

Create Patch Preset Builder

Parameters:

• builder_name (Name) –

• referenced_patch_class (MetaSoundDocumentInterface) –

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

create_source_builder(builder_name, output_format=MetaSoundOutputAudioFormat.MONO, is_one_shot=True) -> (MetaSoundSourceBuilder, on_play_node_output=MetaSoundBuilderNodeOutputHandle, on_finished_node_input=MetaSoundBuilderNodeInputHandle, audio_out_node_inputs=Array[MetaSoundBuilderNodeInputHandle], out_result=MetaSoundBuilderResult)

Create Source Builder

Parameters:

• builder_name (Name) –

• output_format (MetaSoundOutputAudioFormat) –

• is_one_shot (bool) –

Returns:

on_play_node_output (MetaSoundBuilderNodeOutputHandle):

on_finished_node_input (MetaSoundBuilderNodeInputHandle):

audio_out_node_inputs (Array[MetaSoundBuilderNodeInputHandle]):

out_result (MetaSoundBuilderResult):

Return type:

tuple

create_source_preset_builder(builder_name, referenced_source_class) -> (MetaSoundSourceBuilder, out_result=MetaSoundBuilderResult)

Create Source Preset Builder

Parameters:

• builder_name (Name) –

• referenced_source_class (MetaSoundDocumentInterface) –

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

create_string_array_meta_sound_literal(value) -> (MetasoundFrontendLiteral, data_type=Name)

Create String Array Meta Sound Literal

Parameters:

value (Array[str]) –

Returns:

data_type (Name):

Return type:

Name

create_string_meta_sound_literal(value) -> (MetasoundFrontendLiteral, data_type=Name)

Create String Meta Sound Literal

Parameters:

value (str) –

Returns:

data_type (Name):

Return type:

Name

find_builder(builder_name) → MetaSoundBuilderBase

Returns the builder manually registered with the MetaSound Builder Subsystem with the provided custom name (if previously registered)

Parameters:

builder_name (Name) –

Return type:

MetaSoundBuilderBase

find_builder_of_document(meta_sound) → MetaSoundBuilderBase

Returns the builder associated with the given MetaSound (if one exists, transient or asset).

Parameters:

meta_sound (MetaSoundDocumentInterface) –

Return type:

MetaSoundBuilderBase

find_patch_builder(builder_name) → MetaSoundPatchBuilder

Returns the patch builder manually registered with the MetaSound Builder Subsystem with the provided custom name (if previously registered)

Parameters:

builder_name (Name) –

Return type:

MetaSoundPatchBuilder

find_source_builder(builder_name) → MetaSoundSourceBuilder

Returns the source builder manually registered with the MetaSound Builder Subsystem with the provided custom name (if previously registered)

Parameters:

builder_name (Name) –

Return type:

MetaSoundSourceBuilder

is_interface_registered(interface_name) → bool

Is Interface Registered

Parameters:

interface_name (Name) –

Return type:

bool

register_builder(builder_name, builder) → None

Adds builder to subsystem’s registry to make it persistent and easily accessible by multiple systems or Blueprints

Parameters:

• builder_name (Name) –

• builder (MetaSoundBuilderBase) –

register_patch_builder(builder_name, builder) → None

Adds builder to subsystem’s registry to make it persistent and easily accessible by multiple systems or Blueprints

Parameters:

• builder_name (Name) –

• builder (MetaSoundPatchBuilder) –

register_source_builder(builder_name, builder) → None

Adds builder to subsystem’s registry to make it persistent and easily accessible by multiple systems or Blueprints

Parameters:

• builder_name (Name) –

• builder (MetaSoundSourceBuilder) –

unregister_builder(builder_name) → bool

Unregister Builder

Parameters:

builder_name (Name) –

Return type:

bool

unregister_patch_builder(builder_name) → bool

Unregister Patch Builder

Parameters:

builder_name (Name) –

Return type:

bool

unregister_source_builder(builder_name) → bool

Unregister Source Builder

Parameters:

builder_name (Name) –

Return type:

bool