editor.sound.getInfo
Returns detailed information about a sound asset (type-specific fields vary).
| Name | Type | Required | Description |
asset_path | string | Yes | Sound asset path |
Returns (common)
| Field | Type | Description |
asset_name | string | Asset name |
asset_path | string | Asset path |
asset_type | string | Asset type (SoundCue, SoundWave, SoundClass, SoundSubmix) |
Additional fields for SoundCue
| Field | Type | Description |
duration | number | Duration in seconds |
volume_multiplier | number | Volume multiplier |
pitch_multiplier | number | Pitch multiplier |
max_distance | number | Max audible distance |
num_nodes | number | Number of cue graph nodes |
Additional fields for SoundWave
| Field | Type | Description |
duration | number | Duration in seconds |
num_channels | number | Number of audio channels |
sample_rate | number | Sample rate in Hz |
is_looping | bool | Whether sound loops |
is_streaming | bool | Whether sound streams |
compression_type | string | Compression type |
Additional fields for SoundClass
| Field | Type | Description |
volume | number | Volume |
pitch | number | Pitch |
is_ui_sound | bool | Whether it's a UI sound |
always_play | bool | Whether it always plays |
parent_class | string | Parent class name (if any) |
num_children | number | Number of child classes |
Example Request
{ "jsonrpc": "2.0", "id": 1, "method": "editor.sound.getInfo", "params": { "asset_path": "/Game/Sounds/SC_Explosion" } }
editor.sound.getSoundClasses
Returns all available sound classes.
No parameters.
Returns
| Field | Type | Description |
sound_classes | array | Each: {class_name, asset_path, parent_class} |
count | number | Number of sound classes |
Example Request
{ "jsonrpc": "2.0", "id": 1, "method": "editor.sound.getSoundClasses" }
editor.sound.getSubmixes
Returns all available sound submixes.
No parameters.
Returns
| Field | Type | Description |
submixes | array | Each: {submix_name, asset_path, parent_submix} |
count | number | Number of submixes |
Example Request
{ "jsonrpc": "2.0", "id": 1, "method": "editor.sound.getSubmixes" }
editor.sound.getCueNodes
Returns all nodes in a sound cue graph.
| Name | Type | Required | Description |
asset_path | string | Yes | SoundCue asset path |
Returns
| Field | Type | Description |
nodes | array | Each: {node_name, node_class, max_child_nodes, num_children, connections} |
count | number | Number of nodes |
Example Request
{ "jsonrpc": "2.0", "id": 1, "method": "editor.sound.getCueNodes", "params": { "asset_path": "/Game/Sounds/SC_Explosion" } }
editor.sound.getWaveInfo
Returns detailed information about a SoundWave asset.
| Name | Type | Required | Description |
asset_path | string | Yes | SoundWave asset path |
Returns
| Field | Type | Description |
asset_name | string | Asset name |
asset_path | string | Asset path |
sample_rate | number | Sample rate in Hz |
num_channels | number | Number of channels |
duration | number | Duration in seconds |
compression_type | string | Compression type |
is_looping | bool | Whether sound loops |
is_streaming | bool | Whether sound streams |
volume | number | Volume |
pitch | number | Pitch |
subtitle_text | string | Subtitle text |
sound_class | string | Assigned sound class (if any) |
Example Request
{ "jsonrpc": "2.0", "id": 1, "method": "editor.sound.getWaveInfo", "params": { "asset_path": "/Game/Sounds/SW_Gunshot" } }
editor.sound.setSoundClass
Assigns a sound class to a sound asset.
| Name | Type | Required | Description |
asset_path | string | Yes | Sound asset path |
sound_class_path | string | Yes | SoundClass asset path to assign |
Returns
| Field | Type | Description |
success | bool | Whether sound class was assigned |
Example Request
{
"jsonrpc": "2.0", "id": 1, "method": "editor.sound.setSoundClass",
"params": { "asset_path": "/Game/Sounds/SW_Gunshot", "sound_class_path": "/Game/Audio/SC_SFX" }
}
editor.sound.getAttenuation
Returns attenuation settings for a SoundCue or SoundAttenuation asset.
| Name | Type | Required | Description |
asset_path | string | Yes | Path to a SoundCue or SoundAttenuation asset |
Returns
| Field | Type | Description |
has_attenuation | bool | Whether attenuation is configured |
source | string | "SoundAttenuation", "CueOverride", or "AttenuationAsset" |
attenuate | bool | Whether attenuation is enabled |
falloff_distance | number | Falloff distance |
db_attenuation_at_max | number | dB attenuation at max distance |
distance_algorithm | string | Distance algorithm enum value |
attenuation_asset | string | Linked attenuation asset path (if source is AttenuationAsset) |
Example Request
{ "jsonrpc": "2.0", "id": 1, "method": "editor.sound.getAttenuation", "params": { "asset_path": "/Game/Sounds/SC_Explosion" } }
editor.sound.getConcurrency
Returns concurrency settings for a sound asset.
| Name | Type | Required | Description |
asset_path | string | Yes | Sound asset path |
Returns
| Field | Type | Description |
has_override | bool | Whether concurrency is overridden |
max_count | number | Max concurrent instances (if overridden) |
concurrency_set | array | Paths of assigned USoundConcurrency assets |
Example Request
{ "jsonrpc": "2.0", "id": 1, "method": "editor.sound.getConcurrency", "params": { "asset_path": "/Game/Sounds/SC_Explosion" } }
editor.sound.getDialogueWave
Returns details about a DialogueWave asset.
| Name | Type | Required | Description |
asset_path | string | Yes | DialogueWave asset path |
Returns
| Field | Type | Description |
asset_name | string | Asset name |
spoken_text | string | Localized spoken text |
is_mature | bool | Whether content is mature |
num_contexts | number | Number of dialogue contexts |
Example Request
{ "jsonrpc": "2.0", "id": 1, "method": "editor.sound.getDialogueWave", "params": { "asset_path": "/Game/Dialogue/DW_Greeting" } }
editor.sound.getSoundProperties
Returns playback properties for a SoundCue.
| Name | Type | Required | Description |
asset_path | string | Yes | SoundCue asset path |
Returns
| Field | Type | Description |
volume_multiplier | number | Volume multiplier |
pitch_multiplier | number | Pitch multiplier |
duration | number | Duration in seconds |
max_distance | number | Max audible distance |
subtitle_priority | number | Subtitle priority |
override_attenuation | bool | Whether attenuation is overridden |
Example Request
{ "jsonrpc": "2.0", "id": 1, "method": "editor.sound.getSoundProperties", "params": { "asset_path": "/Game/Sounds/SC_Explosion" } }
editor.sound.getAttenuationAssets
Lists all SoundAttenuation assets in the project.
| Name | Type | Required | Description |
path_filter | string | No | Filter results to paths containing this string |
Returns
| Field | Type | Description |
assets | array | Each: {name, path} |
count | number | Number of attenuation assets |
Example Request
{ "jsonrpc": "2.0", "id": 1, "method": "editor.sound.getAttenuationAssets" }
editor.sound.setAttenuation
Sets or clears the attenuation asset on a sound asset.
| Name | Type | Required | Description |
asset_path | string | Yes | Sound asset path |
attenuation_asset | string | No | SoundAttenuation asset path (empty to clear) |
Returns
| Field | Type | Description |
success | bool | Whether attenuation was set |
Example Request
{ "jsonrpc": "2.0", "id": 1, "method": "editor.sound.setAttenuation", "params": { "asset_path": "/Game/Sounds/SC_Explosion", "attenuation_asset": "/Game/Audio/SA_Default" } }
editor.sound.setConcurrency
Adds a concurrency asset to or clears the concurrency set on a sound asset.
| Name | Type | Required | Description |
asset_path | string | Yes | Sound asset path |
concurrency_asset | string | No | SoundConcurrency asset path (empty to clear all) |
Returns
| Field | Type | Description |
success | bool | Whether concurrency was set |
Example Request
{ "jsonrpc": "2.0", "id": 1, "method": "editor.sound.setConcurrency", "params": { "asset_path": "/Game/Sounds/SC_Explosion", "concurrency_asset": "/Game/Audio/Concurrency_SFX" } }
editor.sound.setSoundProperties
Sets playback properties on a SoundCue (volume, pitch).
| Name | Type | Required | Description |
asset_path | string | Yes | SoundCue asset path |
volume_multiplier | number | No | Volume multiplier |
pitch_multiplier | number | No | Pitch multiplier |
Returns
| Field | Type | Description |
success | bool | Whether properties were set |
volume_multiplier | number | Current volume multiplier |
pitch_multiplier | number | Current pitch multiplier |
Example Request
{ "jsonrpc": "2.0", "id": 1, "method": "editor.sound.setSoundProperties", "params": { "asset_path": "/Game/Sounds/SC_Explosion", "volume_multiplier": 0.8, "pitch_multiplier": 1.2 } }