unreal.MetaSoundSourceBuilder

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

Bases: MetaSoundBuilderBase

Builder in charge of building a MetaSound Source

C++ Source:

  • Plugin: Metasound

  • Module: MetasoundEngine

  • File: MetasoundBuilderSubsystem.h

Editor Properties: (see get_editor_property/set_editor_property)

  • is_attached (bool): [Read-Write] deprecated: 5.4 - All source builders now operate on an underlying document source document that is also used to audition.

audition(parent, audio_component, on_create_generator, live_updates_enabled=False) → None

Audition

Parameters:
build(parent, options) → MetaSoundDocumentInterface

Build

Parameters:
Return type:

MetaSoundDocumentInterface

get_live_updates_enabled() → bool

Returns whether or not live updates are both globally enabled (via cvar) and are enabled on this builder’s last built sound, which may or may not still be playing.

Return type:

bool

set_block_rate_override(block_rate) → None

Sets the MetaSound’s BlockRate override

Parameters:

block_rate (float) –

set_format(output_format) → MetaSoundBuilderResult

Sets the output audio format of the source

Parameters:

output_format (MetaSoundOutputAudioFormat) –

Returns:

out_result (MetaSoundBuilderResult):

Return type:

MetaSoundBuilderResult

set_quality(quality) → None

Sets the MetaSound’s Quality level

Parameters:

quality (Name) –

set_sample_rate_override(sample_rate) → None

Sets the MetaSound’s SampleRate override

Parameters:

sample_rate (int32) –