metasound kit
23 tools. Generated from the plugin source; do not edit by hand.
Guide
metasound.* is available on UE 5.8 when the MetaSound plugin is enabled. Start with metasound.create_source_builder or metasound.create_patch_builder, add graph members and interfaces, inspect the document, then build or overwrite a caller-owned MetaSound. Use the builder name consistently: builders are persistent only through Epic's builder subsystem, not through an MCP-side cache.
Use typed literal tools/arguments for Bool, Float, Int32 and String. An input's data type must agree with its default and with the port it connects to. A successful connection is not graph validation: call metasound.validate_builder or build the document; the compiler catches cycles and interface incompatibilities.
Graph members are edited in place: metasound.rename_input / rename_output (name → newName), set_input_type / set_output_type (dataType such as Float or Int32), set_input_default (typed literal) and reset_input_defaults. Interfaces are addressed by their registered name, for example UE.Source.OneShot (declared by a one-shot source builder): check with metasound.has_interface, then remove_interface / add_interface.
Pages are editor-only. Runtime component parameter calls require a live UMetaSoundComponent in a world and report editor-state errors when no suitable component exists. Ordinary SoundWave/SoundCue playback belongs to audio.*.
Tools
Legend. risk 0 = read-only, 1 = harmless editor op, 2 = modifies asset, 3 = deletes/replaces asset, 4 = project/config/build op, 5 = potentially destructive (calls above
MaxAutoRiskneed"_confirm": true). mutates = runs in a transaction (edit.undo reverts). requires PIE / requires world = refused without a PIE session / an open level. requires plugin = unavailable while the plugin is disabled. dryRun = honours thedryRunargument. smoke = covered byedit.self_test.
metasound.add_input (risk 2, mutates, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
name | string | required. Graph member name. |
dataType | string | MetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Default TEXT("Float"). |
value | string | Default scalar literal represented as text. Default TEXT("0"). |
Returns: metaSound, result, message.
metasound.add_interface (risk 2, mutates, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
interface | string | required. Registered MetaSound interface name. |
Returns: metaSound, result, message.
metasound.add_output (risk 2, mutates, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
name | string | required. Graph member name. |
dataType | string | MetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Default TEXT("Float"). |
value | string | Default scalar literal represented as text. Default TEXT("0"). |
Returns: metaSound, result, message.
metasound.add_variable (risk 2, mutates, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
name | string | required. Graph member name. |
dataType | string | MetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Default TEXT("Float"). |
value | string | Default scalar literal represented as text. Default TEXT("0"). |
Returns: metaSound, result, message.
metasound.build_transient (risk 2, mutates, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
asset | string | Existing MetaSound asset path when overwriting a document. |
Returns: metaSound, result, message.
metasound.create_patch_builder (risk 2, mutates, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
builder | string | required. Builder name, unique in Epic's MetaSound Builder Subsystem. |
Returns: metaSound, result, message.
metasound.create_source_builder (risk 2, mutates, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
builder | string | required. Builder name, unique in Epic's MetaSound Builder Subsystem. |
Returns: metaSound, result, message.
metasound.get_builder (risk 0, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
builder | string | required. Builder name, unique in Epic's MetaSound Builder Subsystem. |
Returns: metaSound, result, message.
metasound.has_interface (risk 0, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
interface | string | required. Registered MetaSound interface name. |
Returns: metaSound, result, message.
metasound.list_inputs (risk 0, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
builder | string | required. Builder name, unique in Epic's MetaSound Builder Subsystem. |
Returns: names, count, message.
metasound.list_outputs (risk 0, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
builder | string | required. Builder name, unique in Epic's MetaSound Builder Subsystem. |
Returns: names, count, message.
metasound.remove_builder (risk 3, mutates, destructive, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
builder | string | required. Builder name, unique in Epic's MetaSound Builder Subsystem. |
Returns: metaSound, result, message.
metasound.remove_input (risk 3, mutates, destructive, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
name | string | required. Graph member name. |
dataType | string | MetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Default TEXT("Float"). |
value | string | Default scalar literal represented as text. Default TEXT("0"). |
Returns: metaSound, result, message.
metasound.remove_interface (risk 3, mutates, destructive, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
interface | string | required. Registered MetaSound interface name. |
Returns: metaSound, result, message.
metasound.remove_output (risk 3, mutates, destructive, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
name | string | required. Graph member name. |
dataType | string | MetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Default TEXT("Float"). |
value | string | Default scalar literal represented as text. Default TEXT("0"). |
Returns: metaSound, result, message.
metasound.remove_variable (risk 3, mutates, destructive, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
name | string | required. Graph member name. |
dataType | string | MetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Default TEXT("Float"). |
value | string | Default scalar literal represented as text. Default TEXT("0"). |
Returns: metaSound, result, message.
metasound.rename_input (risk 2, mutates, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
newName | string | required. Replacement graph member name. |
Returns: metaSound, result, message.
metasound.rename_output (risk 2, mutates, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
newName | string | required. Replacement graph member name. |
Returns: metaSound, result, message.
metasound.reset_input_defaults (risk 2, mutates, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
name | string | required. Graph member name. |
dataType | string | MetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Default TEXT("Float"). |
value | string | Default scalar literal represented as text. Default TEXT("0"). |
Returns: metaSound, result, message.
metasound.set_input_default (risk 2, mutates, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
name | string | required. Graph member name. |
dataType | string | MetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Default TEXT("Float"). |
value | string | Default scalar literal represented as text. Default TEXT("0"). |
Returns: metaSound, result, message.
metasound.set_input_type (risk 2, mutates, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
name | string | required. Graph member name. |
dataType | string | MetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Default TEXT("Float"). |
value | string | Default scalar literal represented as text. Default TEXT("0"). |
Returns: metaSound, result, message.
metasound.set_output_type (risk 2, mutates, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
name | string | required. Graph member name. |
dataType | string | MetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Default TEXT("Float"). |
value | string | Default scalar literal represented as text. Default TEXT("0"). |
Returns: metaSound, result, message.
metasound.validate_builder (risk 0, UE 5.8+, requires plugin MetaSound, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
builder | string | required. Builder name, unique in Epic's MetaSound Builder Subsystem. |
Returns: metaSound, result, message.