Skip to content

Switching scenes for Aitum Vertical plugin

WarmUpTill edited this page Jul 17, 2023 · 1 revision

This guide will explain how to switch scenes in the vertical scene dock of the "Aitum Vertical" OBS plugin.

The "Aitum Vertical" utilizes the OBS websocket API to enable external interaction with the plugin via websocket messages.
The supported functions can be found in their GitHub repository.

To switch scenes we will have to send the switch_scene vendor request to the OBS websocket server.

To send such a request we first have to create a new macro and add a new action of type websocket.

AddAction

Next configure the connection, by either adding a new connection or using an existing one.
In most cases a connection to the "localhost" address (meaning you want to change the scene in the same OBS instance the Advanced Scene Switch is running in) and usage of the port 4455 (default port OBS websocket communication) is desired.

Connection

Please make sure the "Use the obs-websocket protocol" checkbox is ticked or otherwise the message will be be ignored by OBS.

Once the connection is set up adjust the message type to be sent from Scene Switcher message to OBS websocket message.

SetMessageType

Finally set the message body to the following content, with Vertical Scene being replaced with the scene name you want to switch to:

{
    "op": 6,
    "d": {
        "requestType": "CallVendorRequest",
        "requestId": "someRandomId",
        "requestData": {
            "vendorName": "aitum-vertical-canvas",
            "requestType": "switch_scene",
            "requestData": {
                "scene": "Vertical Scene"
            }
        }
    }
}

Now everything is set up and the macro should switch to the desired vertical scene.

SetMessageBody

Example guides

Explanations

Clone this wiki locally