Pular para o conteúdo principal

Kit audio

72 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​

Use audio to create, inspect and configure sound assets and routing (cues, attenuation, concurrency, classes, mixes, submixes, effect presets, dialogue), to edit SoundCue graphs, and to audition sounds or activate mixes during PIE. Use asset to import WAV files, component.set_audio to configure a component saved in a Blueprint, metasound for MetaSound graphs and sequencer for timed audio tracks.

Start here​

audio.list_assets {"folder":"/Game/Audio","kind":"all"}
audio.create_cue {"folder":"/Game/Audio","name":"SC_Footstep"}
audio.duplicate_sound {"source":"/Engine/EngineSounds/WhiteNoise","folder":"/Game/Audio","name":"SW_Noise"}
audio.cue_add_wave_player {"asset":"/Game/Audio/SC_Footstep","name":"Wave","wave":"/Game/Audio/SW_Noise"}
audio.cue_add_mixer {"asset":"/Game/Audio/SC_Footstep","name":"Mix"}
audio.cue_graph_connect {"asset":"/Game/Audio/SC_Footstep","node":"Mix","child":"Wave","pin":0}
audio.cue_graph_set_root {"asset":"/Game/Audio/SC_Footstep","node":"Mix"}
audio.cue_graph_audit {"asset":"/Game/Audio/SC_Footstep"}

Creation tools​

ToolCreates
audio.create_cueSoundCue with its editor graph (engine SoundCue factory)
audio.create_attenuation / create_concurrencySoundAttenuation / SoundConcurrency with engine defaults
audio.create_class / create_mix / create_submixSoundClass (no parent), SoundMix, SoundSubmix (no parent route)
audio.create_effect_presetany SoundEffectPreset subclass, e.g. SubmixEffectReverbPreset
audio.duplicate_soundan editable copy of any sound (engine waves included)
audio.dialogue_create_voice / dialogue_create_waveDialogueVoice / DialogueWave

All creation tools take a /Game folder and a bare name and refuse an existing path (E_CONFLICT).

Properties​

Get calls return property names in Unreal property-text form. Set calls take a list of {name, value}; nested struct members use a dotted path. Every name must be an existing, editable property of that asset class, otherwise the call fails with E_INVALID_ARG (nothing is skipped silently):

audio.set_cue {"asset":"/Game/Audio/SC_Footstep","properties":[{"name":"VolumeMultiplier","value":"0.8"}]}
audio.set_attenuation {"asset":"/Game/Audio/ATT_Footstep","properties":[{"name":"Attenuation.FalloffDistance","value":"2400"}]}
audio.set_concurrency {"asset":"/Game/Audio/SCON_Footstep","properties":[{"name":"Concurrency.MaxCount","value":"4"}]}
audio.set_class {"asset":"/Game/Audio/SCL_SFX","properties":[{"name":"Properties.Volume","value":"0.9"}]}
audio.wave_set_compression {"asset":"/Game/Audio/SW_Noise","properties":[{"name":"CompressionQuality","value":"40"}]}

Names valid on both 4.27 and 5.x: SoundBase Priority, SoundClassObject, AttenuationSettings; SoundWave bLooping, CompressionQuality, LoadingBehavior, SoundGroup; SoundSubmix bMuteWhenBackgrounded, OutputVolumeModulation (the float OutputVolume exists only on 4.27).

Routing and effects​

audio.set_submix_parent / audio.submix_set_parent keep the parent's child list in sync; an empty parent removes the route. Add a submix effect from a preset asset, then remove by index:

audio.create_effect_preset {"class":"SubmixEffectReverbPreset","folder":"/Game/Audio","name":"FX_Reverb"}
audio.submix_add_effect {"asset":"/Game/Audio/SMX_World","effect":"/Game/Audio/FX_Reverb"}
audio.sound_mix_add_adjuster {"asset":"/Game/Audio/MIX_Combat","soundClass":"/Game/Audio/SCL_SFX","volume":0.5}

Cue graphs​

Nodes are addressed by the name given when they were added (name, unique in the cue). cue_graph_connect refuses a pin beyond the node's maximum children (a wave player accepts none). cue_graph_remove removes the node from the cue; reconnect the parent afterwards.

PIE​

While PIE runs, audition any SoundBase; location is in centimetres. Playback returns a transient component path. audio.spawn_test_actor places an AmbientSound actor with a label; the component tools then accept that label instead of a path (an actor with several audio components needs the path):

audio.play_2d {"asset":"/Engine/EditorSounds/Notifications/CompileSuccess","volume":0.5}
audio.spawn_test_actor {"asset":"/Game/Audio/SC_Loop","label":"AudioTest","play":true}
audio.adjust_component_volume {"component":"AudioTest","duration":0.25,"volume":0.4}
audio.set_component_float_parameter {"component":"AudioTest","name":"Intensity","value":0.8}
audio.stop_component {"component":"AudioTest"}
audio.push_mix {"asset":"/Engine/EngineSounds/Duck_Normal_Attack_MixMod"}
audio.clear_mix_modifiers {"asset":"/Engine/EngineSounds/Duck_Normal_Attack_MixMod"}

Gotchas​

  • Engine content cannot be edited: duplicate it first (audio.duplicate_sound).
  • play_* returns started:false when the editor runs without an audio device; that is not an error.
  • Component paths die when the sound finishes or PIE stops; prefer a labelled test actor.
  • MetaSound graph authoring is not done through these property tools; use metasound.*.

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.

audio.adjust_component_volume (risco 0, requer PIE, smoke)​

Adjusts live PIE component volume over a duration without stopping it.

ArgumentoTipoDescrição
durationnumberFade duration in seconds, zero stops or applies immediately. Padrão 0.0.
volumenumberTarget volume multiplier, non-negative. Padrão 0.0.

Retorna: started, asset, component, playing, volume, pitch, message.

audio.clear_mix_modifiers (risco 0, requer PIE, smoke)​

Clears all SoundMix modifiers in the active PIE world.

Sem argumentos.

Retorna: started, asset, component, playing, volume, pitch, message.

audio.create_attenuation (risco 2, altera, smoke)​

Creates a SoundAttenuation asset with engine defaults.

ArgumentoTipoDescrição
folderstringobrigatório. Content folder under /Game.
namestringobrigatório. Bare asset name.

Retorna: audio, assets, warnings, message.

audio.create_class (risco 2, altera, smoke)​

Creates a SoundClass asset (no parent class).

ArgumentoTipoDescrição
folderstringobrigatório. Content folder under /Game.
namestringobrigatório. Bare asset name.

Retorna: audio, assets, warnings, message.

audio.create_concurrency (risco 2, altera, smoke)​

Creates a SoundConcurrency asset with engine defaults.

ArgumentoTipoDescrição
folderstringobrigatório. Content folder under /Game.
namestringobrigatório. Bare asset name.

Retorna: audio, assets, warnings, message.

audio.create_cue (risco 2, altera, smoke)​

Creates an empty SoundCue (with its editor graph) through the engine SoundCue factory.

ArgumentoTipoDescrição
folderstringobrigatório. Content folder under /Game.
namestringobrigatório. Bare asset name.

Retorna: audio, assets, warnings, message.

audio.create_effect_preset (risco 2, altera, smoke)​

Creates a sound effect preset asset of any SoundEffectPreset subclass (submix/source effects such as SubmixEffectReverbPreset).

ArgumentoTipoDescrição
classstringobrigatório. SoundEffectPreset subclass: class path or short name such as SubmixEffectReverbPreset.
folderstringobrigatório. Content folder under /Game.
namestringobrigatório. Bare asset name.

Retorna: audio, assets, warnings, message.

audio.create_mix (risco 2, altera, smoke)​

Creates an empty SoundMix asset.

ArgumentoTipoDescrição
folderstringobrigatório. Content folder under /Game.
namestringobrigatório. Bare asset name.

Retorna: audio, assets, warnings, message.

audio.create_submix (risco 2, altera, smoke)​

Creates a SoundSubmix asset without a parent route.

ArgumentoTipoDescrição
folderstringobrigatório. Content folder under /Game.
namestringobrigatório. Bare asset name.

Retorna: audio, assets, warnings, message.

audio.cue_add_attenuation (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestring
wavestring

Retorna: cue, root, nodes, warnings.

audio.cue_add_delay (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestring
wavestring

Retorna: cue, root, nodes, warnings.

audio.cue_add_loop (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestring
wavestring

Retorna: cue, root, nodes, warnings.

audio.cue_add_mixer (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestring
wavestring

Retorna: cue, root, nodes, warnings.

audio.cue_add_modulator (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestring
wavestring

Retorna: cue, root, nodes, warnings.

audio.cue_add_random (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestring
wavestring

Retorna: cue, root, nodes, warnings.

audio.cue_add_wave_player (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
namestring
wavestring

Retorna: cue, root, nodes, warnings.

audio.cue_graph_audit (risco 0, smoke)​

Sem descrição.

Sem argumentos.

Retorna: cue, root, nodes, warnings.

audio.cue_graph_connect (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
childstringobrigatório.
pinintegerPadrão 0.

Retorna: cue, root, nodes, warnings.

audio.cue_graph_disconnect (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
childstringobrigatório.
pinintegerPadrão 0.

Retorna: cue, root, nodes, warnings.

audio.cue_graph_get_root (risco 0, smoke)​

Sem descrição.

Sem argumentos.

Retorna: cue, root, nodes, warnings.

audio.cue_graph_list (risco 0, smoke)​

Sem descrição.

Sem argumentos.

Retorna: cue, root, nodes, warnings.

audio.cue_graph_remove (risco 3, altera, destrutivo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
nodestringobrigatório.

Retorna: cue, root, nodes, warnings.

audio.cue_graph_set_root (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
nodestringobrigatório.

Retorna: cue, root, nodes, warnings.

audio.dialogue_add_context_mapping (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
wavestringobrigatório.
speakerstringobrigatório.
targetsarray of string

Retorna: asset, gender, plurality, mappings.

audio.dialogue_create_voice (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
folderstringobrigatório.
namestringobrigatório.

Retorna: asset, gender, plurality, mappings.

audio.dialogue_create_wave (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
folderstringobrigatório.
namestringobrigatório.

Retorna: asset, gender, plurality, mappings.

audio.dialogue_get_voice (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
assetstringobrigatório. Audio asset path or unique name.

Retorna: asset, gender, plurality, mappings.

audio.dialogue_list_context_mappings (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
assetstringobrigatório. Audio asset path or unique name.

Retorna: asset, gender, plurality, mappings.

audio.dialogue_set_voice_gender_plurality (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
genderintegerPadrão 0.
pluralityintegerPadrão 0.

Retorna: asset, gender, plurality, mappings.

audio.duplicate_sound (risco 2, altera, smoke)​

Copies a sound asset (for example an engine SoundWave) into a project folder so it can be edited.

ArgumentoTipoDescrição
sourcestringobrigatório. Source SoundBase asset path, for example /Engine/EngineSounds/WhiteNoise.
folderstringobrigatório. Destination content folder under /Game.
namestringobrigatório. Bare destination asset name.

Retorna: audio, assets, warnings, message.

audio.fade_component (risco 0, requer PIE, smoke)​

Fades a live PIE audio component toward a non-negative volume.

ArgumentoTipoDescrição
durationnumberFade duration in seconds, zero stops or applies immediately. Padrão 0.0.
volumenumberTarget volume multiplier, non-negative. Padrão 0.0.

Retorna: started, asset, component, playing, volume, pitch, message.

audio.get_attenuation (risco 0, smoke)​

Returns attenuation settings, including distance, spatialization, occlusion and submix-send fields present in this engine.

Sem argumentos.

Retorna: audio, assets, warnings, message.

audio.get_class (risco 0, smoke)​

Returns public SoundClass properties and child class references.

Sem argumentos.

Retorna: audio, assets, warnings, message.

audio.get_concurrency (risco 0, smoke)​

Returns max-count, owner-limit, resolution and timing fields of a SoundConcurrency asset.

Sem argumentos.

Retorna: audio, assets, warnings, message.

audio.get_cue (risco 0, smoke)​

Returns SoundCue base multipliers, attenuation/concurrency references and node count.

Sem argumentos.

Retorna: audio, assets, warnings, message.

audio.get_mix (risco 0, smoke)​

Returns SoundMix EQ, timing and class-adjuster properties.

Sem argumentos.

Retorna: audio, assets, warnings, message.

audio.get_sound (risco 0, smoke)​

Returns sound asset identity, duration and portable playback properties.

ArgumentoTipoDescrição
assetstringobrigatório. Audio asset path or unique name.

Retorna: audio, assets, warnings, message.

audio.get_submix (risco 0, smoke)​

Returns SoundSubmix parent, children and public routing/effect properties.

Sem argumentos.

Retorna: audio, assets, warnings, message.

audio.list_assets (risco 0, smoke)​

Lists project audio assets by family: sound, cue, attenuation, concurrency, class, mix, submix, or all.

ArgumentoTipoDescrição
folderstringContent root to scan; defaults to /Game. Padrão TEXT("/Game").
nameContainsstringOptional case-insensitive asset-name fragment.
recursivebooleanInclude subfolders. Padrão true.
kindstringAsset family: all, sound, cue, attenuation, concurrency, class, mix, or submix. Padrão TEXT("all").

Retorna: audio, assets, warnings, message.

audio.list_sounds (risco 0, smoke)​

Lists SoundBase-derived project assets with class and duration.

ArgumentoTipoDescrição
folderstringContent root to scan; defaults to /Game. Padrão TEXT("/Game").
nameContainsstringOptional case-insensitive asset-name fragment.
recursivebooleanInclude subfolders. Padrão true.
kindstringAsset family: all, sound, cue, attenuation, concurrency, class, mix, or submix. Padrão TEXT("all").

Retorna: audio, assets, warnings, message.

audio.play_2d (risco 0, requer PIE, smoke)​

Starts a non-spatial 2D sound in PIE and returns its runtime component when one is created.

ArgumentoTipoDescrição
volumenumberVolume multiplier, non-negative. Padrão 1.0.
pitchnumberPitch multiplier, greater than zero. Padrão 1.0.
startTimenumberOffset in seconds from the start. Padrão 0.0.
location{x,y,z}World position in centimetres for audio.play_at_location.
attenuationstringOptional SoundAttenuation asset for audio.play_at_location.
concurrencystringOptional SoundConcurrency asset.

Retorna: started, asset, component, playing, volume, pitch, message.

audio.play_at_location (risco 0, requer PIE, smoke)​

Starts a spatial sound at a centimetre world position in PIE.

ArgumentoTipoDescrição
volumenumberVolume multiplier, non-negative. Padrão 1.0.
pitchnumberPitch multiplier, greater than zero. Padrão 1.0.
startTimenumberOffset in seconds from the start. Padrão 0.0.
location{x,y,z}World position in centimetres for audio.play_at_location.
attenuationstringOptional SoundAttenuation asset for audio.play_at_location.
concurrencystringOptional SoundConcurrency asset.

Retorna: started, asset, component, playing, volume, pitch, message.

audio.pop_mix (risco 0, requer PIE, smoke)​

Pops a SoundMix modifier in the active PIE world.

Sem argumentos.

Retorna: started, asset, component, playing, volume, pitch, message.

audio.push_mix (risco 0, requer PIE, smoke)​

Pushes a SoundMix modifier in the active PIE world.

Sem argumentos.

Retorna: started, asset, component, playing, volume, pitch, message.

audio.set_attenuation (risco 2, altera, smoke)​

Updates public attenuation settings using Unreal property text; version-specific fields become warnings.

Sem argumentos.

Retorna: audio, assets, warnings, message.

audio.set_base_mix (risco 0, requer PIE, smoke)​

Sets the active PIE world's base SoundMix; an empty asset clears it.

Sem argumentos.

Retorna: started, asset, component, playing, volume, pitch, message.

audio.set_class (risco 2, altera, smoke)​

Updates public SoundClass fields using Unreal property text.

Sem argumentos.

Retorna: audio, assets, warnings, message.

audio.set_component_bool_parameter (risco 0, requer PIE, smoke)​

Sets a boolean parameter on a live SoundCue or MetaSound component.

ArgumentoTipoDescrição
namestringobrigatório. SoundCue or MetaSound parameter name.
valuebooleanParameter value. Padrão false.

Retorna: started, asset, component, playing, volume, pitch, message.

audio.set_component_float_parameter (risco 0, requer PIE, smoke)​

Sets a float parameter on a live SoundCue or MetaSound component.

ArgumentoTipoDescrição
namestringobrigatório. SoundCue or MetaSound parameter name.
valuenumberParameter value. Padrão 0.0.

Retorna: started, asset, component, playing, volume, pitch, message.

audio.set_concurrency (risco 2, altera, smoke)​

Updates public concurrency settings using Unreal property text.

Sem argumentos.

Retorna: audio, assets, warnings, message.

audio.set_cue (risco 2, altera, smoke)​

Updates public SoundCue properties such as VolumeMultiplier, PitchMultiplier or bOverrideAttenuation.

Sem argumentos.

Retorna: audio, assets, warnings, message.

audio.set_mix (risco 2, altera, smoke)​

Updates public SoundMix fields using Unreal property text.

Sem argumentos.

Retorna: audio, assets, warnings, message.

audio.set_sound (risco 2, altera, smoke)​

Updates safe public SoundBase/SoundWave properties with property text.

ArgumentoTipoDescrição
propertiesarray of UeaAudioPropertyobrigatório. Public, editable properties to update. Unknown, non-editable and engine-version-specific properties are reported as warnings.

Retorna: audio, assets, warnings, message.

audio.set_submix (risco 2, altera, smoke)​

Updates public SoundSubmix fields using Unreal property text.

Sem argumentos.

Retorna: audio, assets, warnings, message.

audio.set_submix_parent (risco 2, altera, smoke)​

Changes a SoundSubmix parent route and preserves the engine-maintained child list.

ArgumentoTipoDescrição
parentstringSoundSubmixBase path to use as parent; empty removes the existing parent.

Retorna: audio, assets, warnings, message.

audio.sound_mix_add_adjuster (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
soundClassstringobrigatório.
volumenumberPadrão 1.
pitchnumberPadrão 1.
lowPassnumberPadrão 20000.
childrenbooleanPadrão false.

Retorna: asset, effects, children, adjusters.

audio.sound_mix_list_adjusters (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
assetstringobrigatório. Audio asset path or unique name.

Retorna: asset, effects, children, adjusters.

audio.spawn_test_actor (risco 0, requer PIE, smoke)​

Spawns an AmbientSound actor in the PIE world (label, sound, location) without starting it; its AudioComponent can then be driven by the component tools through the actor label.

ArgumentoTipoDescrição
labelstringActor label used later as the component reference. Padrão TEXT("AudioSmokeActor").
location{x,y,z}World position in centimetres.
playbooleanStart playing right away. Padrão false.

Retorna: started, asset, component, playing, volume, pitch, message.

audio.stop_component (risco 0, requer PIE, smoke)​

Stops a live PIE audio component (path returned by a playback call, or the label of an actor that owns one).

ArgumentoTipoDescrição
componentstringobrigatório. Runtime component object path returned by audio.play_2d, audio.play_at_location or audio.spawn_test_actor, or the label of a PIE actor that owns an AudioComponent.

Retorna: started, asset, component, playing, volume, pitch, message.

audio.submix_add_effect (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
effectstringobrigatório.

Retorna: asset, effects, children, adjusters.

audio.submix_clear_effects (risco 5, altera, destrutivo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
assetstringobrigatório. Audio asset path or unique name.

Retorna: asset, effects, children, adjusters.

audio.submix_list_children (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
assetstringobrigatório. Audio asset path or unique name.

Retorna: asset, effects, children, adjusters.

audio.submix_list_effects (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
assetstringobrigatório. Audio asset path or unique name.

Retorna: asset, effects, children, adjusters.

audio.submix_remove_effect (risco 3, altera, destrutivo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
indexintegerPadrão 0.

Retorna: asset, effects, children, adjusters.

audio.submix_set_parent (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
parentstringSoundSubmixBase path to use as parent; empty removes the existing parent.

Retorna: asset, effects, children, adjusters.

audio.wave_audit (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
assetstringobrigatório. Audio asset path or unique name.

Retorna: audio, assets, warnings, message.

audio.wave_get_cooking (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
assetstringobrigatório. Audio asset path or unique name.

Retorna: audio, assets, warnings, message.

audio.wave_get_format (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
assetstringobrigatório. Audio asset path or unique name.

Retorna: audio, assets, warnings, message.

audio.wave_info (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
assetstringobrigatório. Audio asset path or unique name.

Retorna: audio, assets, warnings, message.

audio.wave_set_compression (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
propertiesarray of UeaAudioPropertyobrigatório. Public, editable properties to update. Unknown, non-editable and engine-version-specific properties are reported as warnings.

Retorna: audio, assets, warnings, message.

audio.wave_set_playback (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
propertiesarray of UeaAudioPropertyobrigatório. Public, editable properties to update. Unknown, non-editable and engine-version-specific properties are reported as warnings.

Retorna: audio, assets, warnings, message.

audio.wave_set_streaming (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
propertiesarray of UeaAudioPropertyobrigatório. Public, editable properties to update. Unknown, non-editable and engine-version-specific properties are reported as warnings.

Retorna: audio, assets, warnings, message.