Documentation - RD/ShowCockpit

Control & Integration Made Easy

Driver Documentation for v2.23.0

This page contains documentation of the available drivers.

Video / OBS / OBS - Websocket

Interface with OBS Studio through the websocket plugin

< Back to drivers list

    Frequently Asked Questions (FAQs)


Which plugin is needed in OBS for the driver to work?

You will need "obs-websocket", which can be found in this OBS resources page

    Element Options


IP Address

The IP address of the system running OBS

Port

Port

Password

Password

    Functions


Scene   Button LUA Script

Changes the scene
  • Scene Name: Select which scene to trigger

Transition To Program   Button LUA Script

Triggers a transition from preview to program

Change Transition   Button LUA Script

Changes the transition
  • Transition Name: Select which transition to trigger

Set Transition Duration   Button LUA Script

Changes the transition duration
  • Duration (ms): Duration is set in milliseconds

Source Volume   Fader LUA Script

Changes the source volume
  • Source Name: The name of the source to change the volume

Source Toggle Mute   Button LUA Script

Toggles the source mute state
  • Source Name: The name of the source to toggle mute

Toggle Streaming   Button LUA Script

Toggles the streaming state

Toggle Recording   Button LUA Script

Toggles the recording state

Toggle Studio Mode   Button LUA Script

Toggles the studio mode state

Toggle Replay Buffer   Button LUA Script

Toggles the Replay Buffer state

Save Replay Buffer   Button LUA Script

Saves the Replay Buffer

Change Profile   Button LUA Script

Changes the Profile
  • Profile Name: Select which Profile to trigger

Get Scene   LUA Script

Returns the current scene. If Studio Mode is active, gets the preview scene. If not, gets the program output.

Get Program Scene   LUA Script

Returns the current scene in the Program output

Get Preview Scene   LUA Script

Returns the current scene in Preview

Set Program Scene   LUA Script

Sets the program output scene
  • Scene Name: The name of the Scene

Set Preview Scene   LUA Script

Sets the preview scene
  • Scene Name: The name of the Scene

Set Streaming   LUA Script

Sets the streaming state
  • Enabled: True enables streaming and false disables streaming

Set Recording   LUA Script

Sets the recording state
  • Enabled: True enables recording and false disables recording

Set Studio Mode   LUA Script

Sets the Studio Mode state
  • Enabled: True enables Studio Mode and false disables Studio Mode

Set Replay Buffer   LUA Script

Sets the Replay Buffer state
  • Enabled: True enables Replay Buffer and false disables Replay Buffer

Is Streaming   LUA Script

Returns true if OBS is streaming

Is Recording   LUA Script

Returns true if OBS is recording

Is Studio Mode Enabled   LUA Script

Returns true if OBS is in Studio Mode

Get Current Transition   LUA Script

Gets the name of the current transition

Get Current Transition Duration   LUA Script

Gets the current duration of the transition

Get Source Volume   LUA Script

Gets the normalized volume level of a source (0 to 1)
  • Source Name: The name of the source

Is Source Muted   LUA Script

True if a source is muted
  • Source Name: The name of the source

Get Stream Total Time   LUA Script

Returns the total stream time

Get Stream Kbit/s   LUA Script

Returns the current stream kbit/s rate

Get Stream byte/s   LUA Script

Returns the current stream byte/s rate

Get Stream FPS   LUA Script

Returns the current stream FPS rate

Get Stream Strain   LUA Script

Returns the current stream strain rate

Get Stream Dropped Frames   LUA Script

Returns the current stream dropped frames

Get Stream Total Frames   LUA Script

Returns the current stream total frames