Video / OBS / OBS - Websocket
Interface with OBS Studio through the websocket plugin
< Back to drivers listFrequently 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
Changes the scene
- Scene Name: Select which scene to trigger
Transition To Program
Triggers a transition from preview to program
Change Transition
Changes the transition
- Transition Name: Select which transition to trigger
Set Transition Duration
Changes the transition duration
- Duration (ms): Duration is set in milliseconds
Source Volume
Changes the source volume
- Source Name: The name of the source to change the volume
Source Toggle Mute
Toggles the source mute state
- Source Name: The name of the source to toggle mute
Toggle Streaming
Toggles the streaming state
Toggle Recording
Toggles the recording state
Toggle Studio Mode
Toggles the studio mode state
Toggle Replay Buffer
Toggles the Replay Buffer state
Save Replay Buffer
Saves the Replay Buffer
Change Profile
Changes the Profile
- Profile Name: Select which Profile to trigger
Get Scene
Returns the current scene. If Studio Mode is active, gets the preview scene. If not, gets the program output.
Get Program Scene
Returns the current scene in the Program output
Get Preview Scene
Returns the current scene in Preview
Set Program Scene
Sets the program output scene
- Scene Name: The name of the Scene
Set Preview Scene
Sets the preview scene
- Scene Name: The name of the Scene
Set Streaming
Sets the streaming state
- Enabled: True enables streaming and false disables streaming
Set Recording
Sets the recording state
- Enabled: True enables recording and false disables recording
Set Studio Mode
Sets the Studio Mode state
- Enabled: True enables Studio Mode and false disables Studio Mode
Set Replay Buffer
Sets the Replay Buffer state
- Enabled: True enables Replay Buffer and false disables Replay Buffer
Is Streaming
Returns true if OBS is streaming
Is Recording
Returns true if OBS is recording
Is Studio Mode Enabled
Returns true if OBS is in Studio Mode
Get Current Transition
Gets the name of the current transition
Get Current Transition Duration
Gets the current duration of the transition
Get Source Volume
Gets the normalized volume level of a source (0 to 1)
- Source Name: The name of the source
Is Source Muted
True if a source is muted
- Source Name: The name of the source
Get Stream Total Time
Returns the total stream time
Get Stream Kbit/s
Returns the current stream kbit/s rate
Get Stream byte/s
Returns the current stream byte/s rate
Get Stream FPS
Returns the current stream FPS rate
Get Stream Strain
Returns the current stream strain rate
Get Stream Dropped Frames
Returns the current stream dropped frames
Get Stream Total Frames
Returns the current stream total frames