Reference
API reference
Everything here is generated from Studio's catalog when the site is built, so it always matches what Studio does. Catalog version {{gen:catalog-version}}.
| Actions | Every action, its parameters, result, live state, and its signature in each SDK |
| Events | Every event and its data |
| State topics | Every topic and its value |
| Shapes | Shapes used in several places, such as ChatRow |
| Effect settings | Every effect type's settings, for filter.set |
| Error codes | Every error code, and each SDK's class for it |
Reading an entry
Each action shows:
- Parameters, from the catalog's
paramslist: the parameter type, whether it's required, its range, unit, default and choices. - Result, from
result_schema. Fields marked always are in every result; optional ones may be left out; can be null ones may benull. - Live state, from
state: where a control finds the action's value, as a path into a topic. See Live state. - A request with the required parameters filled with placeholders, and the method's signature in each SDK.
- The JSON Schema itself, folded underneath.
Every action
Scenes 4
| Action | Name | Suits | Scope |
|---|---|---|---|
scene.switch | Switch scene | Key | control |
scene.next | Next scene | Key, Dial | control |
scene.previous | Previous scene | Key, Dial | control |
vertical.pin | Pin the vertical canvas | Key | control |
Layers 8
| Action | Name | Suits | Scope |
|---|---|---|---|
layer.visibility | Show or hide a layer | Key | control |
layer.restart | Restart a layer | Key | control |
layer.freeze_on_air | Freeze when its scene comes on air | Key | manage |
layer.copy_style | Copy a layer's style to another | Key | manage |
layer.opacity | Layer opacity | Dial, Key | control |
layer.clip | Clip to the layer below | Key | manage |
layer.framing | Apply a framing | Key | control |
layer.nudge | Nudge a layer | Key | control |
Effects 2
| Action | Name | Suits | Scope |
|---|---|---|---|
filter.toggle | Turn an effect on or off | Key | control |
filter.set | Set an effect's setting | Key, Dial | manage |
Audio 8
| Action | Name | Suits | Scope |
|---|---|---|---|
audio.mute | Mute | Key | control |
audio.volume | Volume | Dial, Key | control |
audio.monitor | Monitor | Key | control |
audio.monitor_when | Monitor when | Key | control |
audio.monitor_bus | Monitor bus | Key, Dial | control |
audio.monitor_send | Monitor send | Key, Dial | control |
audio.app_volume | App volume in Windows | Dial, Key | control |
audio.track | Audio track | Key | control |
VELoQ 12
| Action | Name | Suits | Scope |
|---|---|---|---|
veloq.visibility | What viewers get | Key | manage |
veloq.viewer_start | Where viewers start | Dial, Key | manage |
veloq.stem | Editor+ stem | Key | manage |
veloq.group | Put in a folder or send | Key | manage |
veloq.slider_order | Who gets a slider first | Key | manage |
veloq.transitions | Stinger sounds for viewers | Key | manage |
veloq.smart_defaults | Smart defaults | Key | manage |
veloq.create_group | New audio folder or send | Key | manage |
veloq.update_group | Change an audio folder or send | Key | manage |
veloq.delete_group | Delete an audio folder or send | Key | manage |
veloq.send_with | Send to Velora with | Key | broadcast |
veloq.sliders | Viewer sliders | Display | control |
Sources 15
| Action | Name | Suits | Scope |
|---|---|---|---|
source.copy_settings | Copy a source's settings to another | Key | manage |
source.record_separately | Record this source separately | Key | manage |
source.set | Set a source's setting | Key, Dial | manage |
source.trigger | Trigger a source's action | Key | control |
text.set | Set text | Key | manage |
source.remove_from_all_scenes | Remove a source from all scenes destructive | Key | manage |
source.delete_everywhere | Delete a source everywhere destructive | Key | manage |
source.merge | Merge duplicate sources destructive | Key | manage |
mirror.show | Point a Mirror | Key | control |
capture.targets | What a capture can show | Key | control |
capture.set | Switch what a capture shows | Key | control |
media.control | Media control | Key, Dial | control |
media.speed | Media speed | Key, Dial | control |
ndi.senders | NDI® senders | Display | control |
source.ndi_send | Send a source over NDI® | Key | manage |
Output 30
Stream info 1
| Action | Name | Suits | Scope |
|---|---|---|---|
streaminfo.apply | Set title and category | Key | broadcast |
Chat 6
| Action | Name | Suits | Scope |
|---|---|---|---|
chat.send | Send a chat message | Key | chat |
chat.mode | Chat mode | Key | chat |
chat.moderate | Ban or time out destructive | Key | chat |
chat.emotes | Emote picker | Key | chat |
chat.delete | Delete a message destructive | Key | chat |
chat.clear | Clear chat destructive | Key | chat |
Automations 3
| Action | Name | Suits | Scope |
|---|---|---|---|
automation.run | Run an automation | Key | control |
automation.enable | Turn an automation on or off | Key | manage |
variable.set | Set a variable | Key | control |
Avatars 1
| Action | Name | Suits | Scope |
|---|---|---|---|
avatar.lipsync | Avatar lip sync | Key | control |
Dynamic Sources 1
| Action | Name | Suits | Scope |
|---|---|---|---|
dynamic.set_variable | Set a Dynamic Sources variable | Key | manage |
Collections 1
| Action | Name | Suits | Scope |
|---|---|---|---|
collection.switch | Switch scene collection | Key | manage |
Transitions 6
| Action | Name | Suits | Scope |
|---|---|---|---|
transition.set | Set the transition | Key | control |
transition.wait | Wait until the transition finishes | Key | control |
scene.transition_override | Set a scene's transition | Key | manage |
studio.mode | Studio mode | Key | control |
scene.preview | Preview a scene | Key | control |
studio.take | Take | Key | control |
Graphics cards 2
| Action | Name | Suits | Scope |
|---|---|---|---|
gpu.draw_on | Draw scenes on | Key | manage |
gpu.encode_on | Encode on | Key | manage |
Network cards 1
| Action | Name | Suits | Scope |
|---|---|---|---|
network.stream_on | Stream on network card | Key | manage |
Updates 2
| Action | Name | Suits | Scope |
|---|---|---|---|
update.check | Check for updates | Key | manage |
update.install | Install update | Key | manage |
Advanced 1
| Action | Name | Suits | Scope |
|---|---|---|---|
raw.transaction | Raw request | Key | manage |

