playlist-play
Control audio for every connected client: play or stop a playlist or one of its sounds, step to the next / previous track, or play a one-off audio file (src) — everywhere, or heard around a point on the scene when x, y and radius are given. action preload with src loads a file on every client ahead of time. Requires bridge module 8.19.0+. EXAMPLES: {"playlistId":"p1"} · {"action":"stop","playlistId":"p1"} · {"src":"sounds/thunder.ogg","volume":0.8}
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "playlist-play"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| x | No | Positional one-off sound: scene pixels | |
| y | No | Positional one-off sound: scene pixels | |
| src | No | Audio file path (from file-list) for a one-off sound | |
| loop | No | One-off sound everywhere: repeat it | |
| action | No | Default play | |
| radius | No | Positional one-off sound: audible radius in scene distance units (feet) | |
| volume | No | One-off sound, 0–1 | |
| sceneId | No | Positional one-off sound: scene (default: the viewed one) | |
| soundId | No | Sound of that playlist (from playlist-list) — play / stop just this sound | |
| playlistId | No | Playlist ID (from playlist-list) |