Reference Script Functions Obsbot

OBSBOT script functions

Also on the Cuebot Docs site.

Functions for C# (Cb.Call) and Python (a cb method each, or cb.call). See Script functions for how to use them.

obsbot.connect

Starts connecting to OBSBOT Center. Cuebot keeps trying in the background until it works.

Gives back: true once connecting has started.

C#

var answer = await Cb.Call("obsbot.connect");

Python

answer = cb.obsbot_connect()

obsbot.disconnect

Disconnects Cuebot from OBSBOT Center.

Gives back: true when done.

C#

var answer = await Cb.Call("obsbot.disconnect");

Python

answer = cb.obsbot_disconnect()

obsbot.getState

Asks your OBSBOT camera for its current settings, like zoom and where it is pointing.

Gives back: Values named obsbot.deviceIndex, obsbot.deviceName, obsbot.awake, obsbot.zoom, obsbot.fov, obsbot.pitch, obsbot.yaw, obsbot.aiLocked, obsbot.autoFraming, obsbot.deviceCount and obsbot.preset1.exists / .name (and 2, 3).

C#

var answer = await Cb.Call("obsbot.getState");

Python

answer = cb.obsbot_get_state()

obsbot.isConnected

Checks whether Cuebot can reach your OBSBOT camera (through OBSBOT Center) right now.

Gives back: true while OBSBOT Center answers, otherwise false.

C#

var answer = await Cb.Call("obsbot.isConnected");

Python

answer = cb.obsbot_is_connected()

obsbot.send

Sends any raw OSC message to OBSBOT Center. For advanced users who know OBSBOT's OSC addresses.

Value	In Python	What to put in
address	address	The OSC address, like "/OBSBOT/WebCam/General/SetZoom". Needed.
args	args	Optional. A list of values to send with it, like [50].

Gives back: true when sent.

C#

var answer = await Cb.Call("obsbot.send", new { address = "/OBSBOT/WebCam/General/SetZoom", args = new object?[] { 50 } });

Python

answer = cb.obsbot_send(address="/OBSBOT/WebCam/General/SetZoom", args=[50])

obsbot.setGimbal

Points your OBSBOT camera in a direction. Numbers past the camera's limit are cut down to the limit.

Value	In Python	What to put in
pan	pan	Optional. Left/right in degrees, -129 to 129 (a Tail 2 reached directly: -159 to 159). Default 0 (straight ahead).
pitch	pitch	Optional. Up/down in degrees, -59 to 59 (a Tail 2 reached directly: -62 to 62). Default 0.
speed	speed	Optional. How fast it turns, 0 to 90. Default 50.
device	device	Optional. Which camera in OBSBOT Center, 1 to 4. Leave it out for the selected one.

Gives back: true when sent.

C#

var answer = await Cb.Call("obsbot.setGimbal", new { pan = 30, pitch = -10, speed = 40 });

Python

answer = cb.obsbot_set_gimbal(pan=30, pitch=-10, speed=40)

obsbot.setZoom

Zooms your OBSBOT camera in or out.

Value	In Python	What to put in
zoom	zoom	How far to zoom, 0 (all the way out) to 100 (all the way in).
device	device	Optional. Which camera in OBSBOT Center, 1 to 4. Leave it out for the selected one.

Gives back: true when sent.

C#

var answer = await Cb.Call("obsbot.setZoom", new { zoom = 50 });

Python

answer = cb.obsbot_set_zoom(zoom=50)

obsbot.triggerPreset

Moves your OBSBOT camera to one of its saved positions (presets).

Value	In Python	What to put in
preset	preset	Optional. Which preset, 1 to 3. Default 1.
device	device	Optional. Which camera in OBSBOT Center, 1 to 4. Leave it out for the selected one.

Gives back: true when sent.

C#

var answer = await Cb.Call("obsbot.triggerPreset", new { preset = 2 });

Python

answer = cb.obsbot_trigger_preset(preset=2)