OBS WebSocket icon

OBS WebSocket

Control OBS Studio via WebSocket

General → Get Studio Mode Status

AI-generated

Summary

Retrieve whether Studio Mode is enabled in OBS Studio.

Inputs

None.

Output shape

a single object containing a boolean property 'studioModeEnabled' indicating if Studio Mode is active

No inputs are required for this operation. The output provides the current Studio Mode status as a boolean value under the key 'studioModeEnabled'. In case of connection errors, an error is thrown.

Examples

Example 1: Check if Studio Mode is currently enabled in OBS to conditionally trigger other workflow actions.

Configure the OBS WebSocket node with resource set to 'General' and operation set to 'Get Studio Mode Status' without additional parameters.

Discussion