Pular para o conteúdo principal

Kit metasound

23 ferramentas. Gerado a partir do código-fonte do plugin; não edite manualmente.

As descrições das ferramentas e dos argumentos são exibidas em inglês porque espelham o schema das ferramentas (o mesmo texto que o agente recebe em tools/list).

Guia​

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.*.

Ferramentas​

Legenda. risco 0 = somente leitura, 1 = operação inofensiva do editor, 2 = altera asset, 3 = apaga/substitui asset, 4 = projeto/config/build, 5 = potencialmente destrutivo (chamadas acima de MaxAutoRisk exigem "_confirm": true). altera = roda numa transação (edit.undo reverte). requer PIE / requer mundo = recusado sem sessão PIE / sem nível aberto. requer plugin = indisponível quando o plugin está desativado. dryRun = aceita o argumento dryRun. smoke = coberto por edit.self_test.

metasound.add_input (risco 2, altera, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestringobrigatório. Graph member name.
dataTypestringMetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Padrão TEXT("Float").
valuestringDefault scalar literal represented as text. Padrão TEXT("0").

Retorna: metaSound, result, message.

metasound.add_interface (risco 2, altera, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
interfacestringobrigatório. Registered MetaSound interface name.

Retorna: metaSound, result, message.

metasound.add_output (risco 2, altera, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestringobrigatório. Graph member name.
dataTypestringMetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Padrão TEXT("Float").
valuestringDefault scalar literal represented as text. Padrão TEXT("0").

Retorna: metaSound, result, message.

metasound.add_variable (risco 2, altera, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestringobrigatório. Graph member name.
dataTypestringMetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Padrão TEXT("Float").
valuestringDefault scalar literal represented as text. Padrão TEXT("0").

Retorna: metaSound, result, message.

metasound.build_transient (risco 2, altera, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
assetstringExisting MetaSound asset path when overwriting a document.

Retorna: metaSound, result, message.

metasound.create_patch_builder (risco 2, altera, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
builderstringobrigatório. Builder name, unique in Epic's MetaSound Builder Subsystem.

Retorna: metaSound, result, message.

metasound.create_source_builder (risco 2, altera, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
builderstringobrigatório. Builder name, unique in Epic's MetaSound Builder Subsystem.

Retorna: metaSound, result, message.

metasound.get_builder (risco 0, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
builderstringobrigatório. Builder name, unique in Epic's MetaSound Builder Subsystem.

Retorna: metaSound, result, message.

metasound.has_interface (risco 0, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
interfacestringobrigatório. Registered MetaSound interface name.

Retorna: metaSound, result, message.

metasound.list_inputs (risco 0, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
builderstringobrigatório. Builder name, unique in Epic's MetaSound Builder Subsystem.

Retorna: names, count, message.

metasound.list_outputs (risco 0, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
builderstringobrigatório. Builder name, unique in Epic's MetaSound Builder Subsystem.

Retorna: names, count, message.

metasound.remove_builder (risco 3, altera, destrutivo, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
builderstringobrigatório. Builder name, unique in Epic's MetaSound Builder Subsystem.

Retorna: metaSound, result, message.

metasound.remove_input (risco 3, altera, destrutivo, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestringobrigatório. Graph member name.
dataTypestringMetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Padrão TEXT("Float").
valuestringDefault scalar literal represented as text. Padrão TEXT("0").

Retorna: metaSound, result, message.

metasound.remove_interface (risco 3, altera, destrutivo, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
interfacestringobrigatório. Registered MetaSound interface name.

Retorna: metaSound, result, message.

metasound.remove_output (risco 3, altera, destrutivo, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestringobrigatório. Graph member name.
dataTypestringMetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Padrão TEXT("Float").
valuestringDefault scalar literal represented as text. Padrão TEXT("0").

Retorna: metaSound, result, message.

metasound.remove_variable (risco 3, altera, destrutivo, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestringobrigatório. Graph member name.
dataTypestringMetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Padrão TEXT("Float").
valuestringDefault scalar literal represented as text. Padrão TEXT("0").

Retorna: metaSound, result, message.

metasound.rename_input (risco 2, altera, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
newNamestringobrigatório. Replacement graph member name.

Retorna: metaSound, result, message.

metasound.rename_output (risco 2, altera, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
newNamestringobrigatório. Replacement graph member name.

Retorna: metaSound, result, message.

metasound.reset_input_defaults (risco 2, altera, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestringobrigatório. Graph member name.
dataTypestringMetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Padrão TEXT("Float").
valuestringDefault scalar literal represented as text. Padrão TEXT("0").

Retorna: metaSound, result, message.

metasound.set_input_default (risco 2, altera, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestringobrigatório. Graph member name.
dataTypestringMetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Padrão TEXT("Float").
valuestringDefault scalar literal represented as text. Padrão TEXT("0").

Retorna: metaSound, result, message.

metasound.set_input_type (risco 2, altera, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestringobrigatório. Graph member name.
dataTypestringMetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Padrão TEXT("Float").
valuestringDefault scalar literal represented as text. Padrão TEXT("0").

Retorna: metaSound, result, message.

metasound.set_output_type (risco 2, altera, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestringobrigatório. Graph member name.
dataTypestringMetaSound data type, such as Float, Int32, Bool, String, Audio, or Trigger. Padrão TEXT("Float").
valuestringDefault scalar literal represented as text. Padrão TEXT("0").

Retorna: metaSound, result, message.

metasound.validate_builder (risco 0, UE 5.8+, requer plugin MetaSound, smoke)​

Sem descrição.

ArgumentoTipoDescrição
builderstringobrigatório. Builder name, unique in Epic's MetaSound Builder Subsystem.

Retorna: metaSound, result, message.