OBS Module

Full OBS Studio control — scenes, sources, audio, streaming, recording, and more.

The OBS module connects OBS Studio to Rawtoh via the OBS WebSocket protocol. It gives you full control over your scenes, sources, audio, streaming, and recording — all from your automations.

Events

The OBS module emits events for everything that happens in OBS Studio. Use these as triggers to react automatically.

Scenes

Event	Description
`scene.current_changed`	Active scene changed
`scene.preview_changed`	Preview scene changed (studio mode)
`scene.created`	New scene created
`scene.removed`	Scene removed

Streaming & recording

Event	Description
`stream.state_changed`	Streaming started / stopped
`record.state_changed`	Recording started / stopped
`replay_buffer.saved`	Replay buffer saved
`virtualcam.state_changed`	Virtual camera toggled

Sources & inputs

Event	Description
`input.mute_state_changed`	Source muted / unmuted
`input.volume_changed`	Source volume changed
`scene_item.enable_state_changed`	Source visibility toggled
`scene_transition.started`	Scene transition started
`media_input.playback_started`	Media started playing
`media_input.playback_ended`	Media finished playing

What you can do

Call these methods from your actions to control OBS:

Scenes

scene.set_current — switch to a scene
scene.get_list — get all scenes
scene.create / scene.remove

Sources & inputs

scene_item.set_enabled — show or hide a source
input.set_mute / input.toggle_mute — mute/unmute
input.set_volume — change volume
input.set_settings — change source settings (text, URL, etc.)
scene_item.set_transform — move, resize, or rotate a source

Streaming & recording

stream.start / stream.stop / stream.toggle
record.start / record.stop / record.toggle
replay_buffer.save — save the replay buffer

Filters & transitions

filter.set_enabled — enable/disable a filter
filter.set_settings — change filter settings
transition.set_current — change the active transition
transition.trigger — trigger a transition manually

Other

general.trigger_hotkey_by_name — trigger any OBS hotkey
source.get_screenshot — take a screenshot of a source
virtualcam.start / virtualcam.stop

Example automations

Raid on Twitch → switch to welcome scene, show a raid alert source
Stream goes live → post go-live notification in Discord, start recording
Board button clicked → switch to BRB scene, mute mic
Song changes on Spotify → update a text source with the current track name
Chat command → toggle a filter on the webcam, trigger a hotkey