unreal.MetaSoundBuilderSubsystem¶
- class unreal.MetaSoundBuilderSubsystem(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
EngineSubsystemThe 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
- create_bool_meta_sound_literal(value) -> (MetasoundFrontendLiteral, data_type=Name)¶
Create Bool Meta Sound Literal
- create_float_array_meta_sound_literal(value) -> (MetasoundFrontendLiteral, data_type=Name)¶
Create Float Array Meta Sound Literal
- create_float_meta_sound_literal(value) -> (MetasoundFrontendLiteral, data_type=Name)¶
Create Float Meta Sound Literal
- create_int_array_meta_sound_literal(value) -> (MetasoundFrontendLiteral, data_type=Name)¶
Create Int Array Meta Sound Literal
- create_int_meta_sound_literal(value) -> (MetasoundFrontendLiteral, data_type=Name)¶
Create Int Meta Sound Literal
- Parameters:
value (int32)
- Returns:
data_type (Name):
- Return type:
- create_meta_sound_literal_from_param(param) MetasoundFrontendLiteral¶
Create Meta Sound Literal from Param
- Parameters:
param (AudioParameter)
- Return type:
- create_object_array_meta_sound_literal(value) MetasoundFrontendLiteral¶
Create Object Array Meta Sound Literal
- Parameters:
- Return type:
- create_object_meta_sound_literal(value) MetasoundFrontendLiteral¶
Create Object Meta Sound Literal
- Parameters:
value (Object)
- Return type:
- create_patch_builder(builder_name) -> (MetaSoundPatchBuilder, out_result=MetaSoundBuilderResult)¶
Create Patch Builder
- Parameters:
builder_name (Name)
- Returns:
out_result (MetaSoundBuilderResult):
- Return type:
- create_patch_preset_builder(builder_name, referenced_patch_class) -> (MetaSoundPatchBuilder, out_result=MetaSoundBuilderResult)¶
Creates a builder that acts on a generated, transient preset MetaSound UObject. Fails if Referenced MetaSound is not a UMetaSoundPatch.
- Parameters:
builder_name (Name)
referenced_patch_class (MetaSoundDocumentInterface)
- Returns:
out_result (MetaSoundBuilderResult):
- Return type:
- 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)¶
Creates a builder that acts on a generated, transient preset MetaSound UObject. Fails if Referenced MetaSound is not a UMetaSoundSource.
- Parameters:
builder_name (Name)
referenced_source_class (MetaSoundDocumentInterface)
- Returns:
out_result (MetaSoundBuilderResult):
- Return type:
- create_string_array_meta_sound_literal(value) -> (MetasoundFrontendLiteral, data_type=Name)¶
Create String Array Meta Sound Literal
- create_string_meta_sound_literal(value) -> (MetasoundFrontendLiteral, data_type=Name)¶
Create String Meta Sound Literal
- 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:
- 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:
- find_parent_builder_of_preset(meta_sound_preset, follow_preset_chain=True) MetaSoundBuilderBase¶
Returns the builder associated with the given MetaSound preset’s parent. If bFollowPresetChain is true, continues traversing up the preset chain to return the highest non-preset ancestor. Returns nullptr if the given MetaSound is not a preset, or if the parent builder is not yet registered.
- Parameters:
meta_sound_preset (MetaSoundDocumentInterface)
follow_preset_chain (bool)
- Return type:
- 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:
- 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:
- 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)
- set_target_page(page_name) bool¶
Sets the targeted page for all MetaSound graph & input default to resolve against. If target page is not implemented (or cooked in a runtime build) for the active platform, uses order of cooked pages(see ‘Page Settings’ for order) falling back to lower index - ordered page implemented in MetaSound asset. If no fallback is found, uses default graph/input default.