Skip to main content
RAW WS BATCH REQUEST
● Settings: Execution Type, Halt on failure, Requests Array
● No On/Off States
● Supported in Multi-Actions

Description

Send a raw websocket batch request compliant with the OBS Websockets protocol

Settings

  • Execution Type - Defines how requests are processed, typically SerialRealtime
  • Halt on failure - Whether to halt processing requests after one fails
  • Requests Array - JSON with a properly formatted array of request objects, as expected by the OBS Websockets protocol

States

Default

Configuring a batch request​

This is an advanced action that allows you to send a raw websocket batch request as defined by the OBS Websockets protocol. A batch request is a group of requests that are sent together to OBS, and processed there normally in a serial way.

The Requests Array field requires valid JSON with a properly formatted array of request objects, as expected by the OBS Websockets protocol

Examples​

  • Set the current scene to Funny Face, wait 15s and set the scene to Chatting:
[   
  {
    "requestType": "SetCurrentProgramScene",
    "requestData": {"sceneName": "Funny Face"}
  },
  {
    "requestType": "Sleep",
    "requestData": {"sleepMillis": 15000}
  },
  {
    "requestType": "SetCurrentProgramScene",
    "requestData": {"sceneName": "Funny Face"}
  }
]
  • Set Fade as the current transition, wait 100ms and trigger a Studio Mode transition:
[   
  {
    "requestType": "SetCurrentSceneTransition",
    "requestData": {"transitionName": "Fade"}
  },
  {
    "requestType": "Sleep",
    "requestData": {"sleepMillis": 100}
  },
  {
    "requestType": "TriggerStudioModeTransition"
  }
]