Reference Triggers Obsbot

OBSBOT triggers

Also on the Cuebot Docs site.

AI tracking locked/unlocked

Runs when AI tracking locks onto a subject or lets go of it.

Setting	What to put in
State	Choose Locked to react only when it locks on, Unlocked only when it lets go, or Any for both. Options: Any, Locked, Unlocked. Starts as: Any.

Variables you get

Variable	What it holds
%obsbot.aiLocked%	True when AI tracking is locked on a subject
%obsbot.deviceName%	The selected camera's name

Type id: obsbot.aiTrackingChanged

Camera slept or woke

Runs when the camera goes to sleep or wakes up.

Setting	What to put in
State	Choose Awake to react only when the camera wakes up, Asleep only when it goes to sleep, or Any for both. Options: Any, Awake, Asleep. Starts as: Any.

Variables you get

Variable	What it holds
%obsbot.awake%	True when the camera is awake
%obsbot.deviceName%	The selected camera's name

Type id: obsbot.sleepStateChanged

Connected

Runs when Cuebot starts talking to OBSBOT Center (the OBSBOT camera app) or to your OBSBOT camera.

Type id: obsbot.connected

Disconnected

Runs when Cuebot loses contact with OBSBOT Center or the camera.

Variables you get

Variable	What it holds
%reason%	A short text saying why contact was lost

Type id: obsbot.disconnected

Gimbal moved

Runs when the camera turns or tilts to a new position.

Variables you get

Variable	What it holds
%obsbot.pitch%	How far the camera is tilted up or down, in degrees
%obsbot.yaw%	How far the camera is turned left or right, in degrees
%obsbot.deviceName%	The selected camera's name

Type id: obsbot.gimbalMoved

Other OBSBOT message (advanced)

For experts: runs when OBSBOT sends a message that Cuebot does not turn into one of the other triggers. Useful for commands this app has no trigger for.

Setting	What to put in
Addresses	Only react to this message address, like "/OBSBOT/WebCam/General/SetZoom". Separate several with commas. Leave empty to react to every such message.

Variables you get

Variable	What it holds
%obsbot.address%	The message's address
%obsbot.arg0%	The first value in the message
%obsbot.arg1%	The second value
%obsbot.arg2%	The third value
%obsbot.args%	All the values as one list

Type id: obsbot.message

Selected camera changed

Runs when a different camera gets selected in OBSBOT Center. Only matters if you have more than one OBSBOT camera.

Variables you get

Variable	What it holds
%obsbot.deviceIndex%	Which camera is selected, counting from 0 (0 is the first camera)
%obsbot.deviceName%	The selected camera's name
%obsbot.deviceCount%	How many cameras are connected

Type id: obsbot.deviceChanged

Zoom changed

Runs when the camera's zoom or field of view changes, whether from Cuebot, OBSBOT Center or the camera itself.

Variables you get

Variable	What it holds
%obsbot.zoom%	The zoom, 0 to 100 percent
%obsbot.oldZoom%	The zoom before the change
%obsbot.fovDegrees%	The field of view, like "86°"
%obsbot.deviceName%	The selected camera's name

Type id: obsbot.zoomChanged