OBSBOT sub-actions¶
AI tracking lock (Tiny)¶
Locks AI tracking onto the subject now in view, or lets go again. For Tiny cameras.
| Setting | What to put in |
|---|---|
| State | Lock keeps following the current subject. Unlock lets the camera choose again. Toggle flips the current state. Options: Lock, Unlock, Toggle. Starts as: Toggle. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Variables it adds
| Variable | What it holds |
|---|---|
%obsbot.aiLocked% |
True when tracking is locked now |
Type id: obsbot.aiLock
Get camera state¶
Reads the camera's current zoom, angle, AI lock and more into variables you can use in later steps.
Variables it adds
| 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.awake% |
True when the camera is awake |
%obsbot.zoom% |
The zoom, 0 to 100 percent |
%obsbot.fovDegrees% |
The field of view, like "86°" |
%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.aiLocked% |
True when AI tracking is locked on a subject |
%obsbot.deviceCount% |
How many cameras are connected |
%obsbot.fov% |
The field of view as a number (0 is 86°, 1 is 78°, 2 is 65°) |
%obsbot.isConnected% |
True when Cuebot is connected to OBSBOT Center |
Type id: obsbot.getState
Go to preset position¶
Moves the camera to one of its three saved positions (presets).
| Setting | What to put in |
|---|---|
| Preset | Which saved position to go to: 1, 2 or 3. Options: 1, 2, 3. Starts as: 1. |
| Camera series | Your camera model family: Tiny or Tail. Auto works it out from the camera's name or from the OBSBOT card's setting. Pick one yourself if Auto guesses wrong. Options: Auto, Tiny, Tail. Starts as: Auto. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.triggerPreset
Lock pan / tilt axis (Tail 2)¶
Locks the Tail 2 so it cannot turn left-right (Pan) or up-down (Tilt), or lets it move again.
| Setting | What to put in |
|---|---|
| Axis | Pan is left and right. Tilt is up and down. Options: Pan, Tilt. Starts as: Pan. |
| State | Lock stops it from moving that way. Unlock lets it move again. Options: Lock, Unlock. Starts as: Lock. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.setAxisLock
Move gimbal¶
Turns or tilts the camera in a direction, like moving it by hand. Choose Stop to stop it.
| Setting | What to put in |
|---|---|
| Direction | Which way to move. Choose Stop to stop all movement. Options: Up, Down, Left, Right, Stop. Starts as: Up. |
| Speed (1-100) | How fast to move, from 1 (slow) to 100 (fast). Starts as: 50. |
| Duration (ms, optional) | How long to move, in milliseconds (1000 is one second). Leave empty to keep moving until you run a Stop step. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.moveGimbal
Recording¶
Starts or stops a recording made by the camera or by OBSBOT Center.
| Setting | What to put in |
|---|---|
| Recording | PC recording and High-fps recording are made on your computer. Camera recording is made by the camera itself and only works on a Tail camera. Options: PC recording, High-fps recording, Camera recording (Tail). Starts as: PC recording. |
| State | Start begins recording, Stop ends it. Options: Start, Stop. Starts as: Start. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.recording
Reset gimbal¶
Turns the camera back to its centre position.
| Setting | What to put in |
|---|---|
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.resetGimbal
Select camera¶
Picks which OBSBOT camera the next steps control. Only needed if you have more than one camera.
| Setting | What to put in |
|---|---|
| Camera | The camera number, from 1 to 4, in the order OBSBOT Center lists them. Starts as: 1. |
Type id: obsbot.selectDevice
Send OSC message (advanced)¶
For experts: sends your own OSC message (a short control message that OBSBOT understands). Use it for camera features the other steps do not cover.
| Setting | What to put in |
|---|---|
| Address | The message address, like /OBSBOT/WebCam/General/SetZoom. See OBSBOT's own OSC list for the addresses. |
| Arguments | The values for the message, separated by spaces or commas, like "50". Whole numbers, decimals, true/false and words are all fine. Leave empty if it needs none. |
Type id: obsbot.sendOsc
Set AI mode¶
Chooses what the camera's AI follows, like the whole body or just the face.
| Setting | What to put in |
|---|---|
| AI mode | A mode number. For Tiny 2: 0 off, 1 normal, 2 upper body, 3 close-up, 4 headless, 5 lower body, 6 desk, 7 whiteboard, 8 hand, 9 group. Other models use other numbers. Starts as: 1. |
| Camera series | Your camera model family: Tiny or Tail. Auto works it out from the camera's name or from the OBSBOT card's setting. Pick one yourself if Auto guesses wrong. Options: Auto, Tiny, Tail. Starts as: Auto. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.setAiMode
Set auto framing (Meet)¶
Makes the camera crop and follow people on its own. For OBSBOT Meet cameras.
| Setting | What to put in |
|---|---|
| Auto framing | Disable turns it off. Single follows one person. Group fits everyone in the picture. Options: Disable, Single, Group. Starts as: Single. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.setAutoFraming
Set field of view¶
Changes how wide the camera sees (its field of view). A bigger angle shows more of the room.
| Setting | What to put in |
|---|---|
| Field of view | The angle: 86° (widest), 78° or 65° (narrowest). Options: 86°, 78°, 65°. Starts as: 86°. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.setView
Set gimbal position¶
Turns the camera to an exact left-right and up-down angle.
| Setting | What to put in |
|---|---|
| Pan (°, -129..129) | How far to turn left or right, in degrees. 0 is the middle, minus is left. About -129 to 129; a Tail 2 connected straight to Cuebot allows -159 to 159. Starts as: 0. |
| Pitch (°, -59..59) | How far to tilt up or down, in degrees. 0 is level. About -59 to 59; a Tail 2 connected straight to Cuebot allows -62 to 62. Starts as: 0. |
| Speed (0-90) | How fast to turn, from 0 to 90. Starts as: 50. |
| Send decimals | Tick to send angles with decimals, like 12.5, instead of whole degrees. Works only through OBSBOT Center. Starts as: False. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.setGimbalPosition
Set image setting¶
Changes one picture setting of the camera, such as focus, exposure or white balance (the colour warmth).
| Setting | What to put in |
|---|---|
| Setting | Which picture setting to change. Options: Auto focus, Manual focus, Tail focus mode, Auto exposure, Exposure compensation, Shutter speed, ISO, Auto white balance, Color temperature, White balance shift, Red/blue gain. Starts as: Auto exposure. |
| Value | The new value. Auto settings: 1 is auto, 0 is manual. Manual focus: 0-100. Exposure compensation: -30 to 30. ISO: 100-6400. Color temperature: 2000-10000. Shutter speed: like 100 for 1/100. |
| Second value | Only for Tail focus mode, White balance shift and Red/blue gain, which need two numbers. Leave empty for the others. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.setImage
Set mirror¶
Flips the picture left to right, like a mirror.
| Setting | What to put in |
|---|---|
| Mirror | On flips the picture. Off shows it the normal way round. Options: On, Off. Starts as: On. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.setMirror
Set tracking mode (Tiny)¶
Chooses how a Tiny camera follows you: Headroom keeps space above your head, Standard follows you, Motion follows movement.
| Setting | What to put in |
|---|---|
| Tracking mode | Headroom, Standard or Motion. Tiny 2, Tiny 2 Lite and Tiny SE only have Standard and Motion. Options: Headroom, Standard, Motion. Starts as: Standard. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.setTrackingMode
Set tracking speed¶
Sets how quickly the camera follows you.
| Setting | What to put in |
|---|---|
| Speed | A number. Tiny 3 and Tail Air: 0 slow, 1 standard, 2 fast. Tail 2: 0 to 5, from very lazy to automatic. For one axis on a Tail 2: 1 to 10. Starts as: 1. |
| Axis | Both changes everything at once. Pan is left-right and Tilt is up-down; picking one is only for the Tail 2. Options: Both, Pan, Tilt. Starts as: Both. |
| Camera series | Your camera model family: Tiny or Tail. Auto works it out from the camera's name or from the OBSBOT card's setting. Pick one yourself if Auto guesses wrong. Options: Auto, Tiny, Tail. Starts as: Auto. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.setTrackingSpeed
Set virtual background (Meet)¶
Changes the background behind you without a green screen. For OBSBOT Meet cameras.
| Setting | What to put in |
|---|---|
| Background | Disable shows your real room. Blur blurs what is behind you. Green screen and Replacement are the camera's other background modes; set their look in OBSBOT Center. Options: Disable, Blur, Green screen, Replacement. Starts as: Blur. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.setVirtualBackground
Set zoom¶
Zooms the camera to a set amount.
| Setting | What to put in |
|---|---|
| Zoom (0-100) | How far to zoom, from 0 (widest) to 100 (closest). Starts as: 0. |
| Speed (optional, 0-11) | How fast to zoom, 0 to 11 (higher is faster, 0 is the normal speed). Leave empty to jump straight there. Only newer cameras support it. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.setZoom
Standard mode (Meet)¶
Switches an OBSBOT Meet camera to its standard mode.
| Setting | What to put in |
|---|---|
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.standardMode
Take snapshot¶
Takes a still photo with the camera.
| Setting | What to put in |
|---|---|
| Snapshot | PC snapshot is taken on your computer. Camera snapshot is taken by the camera itself and only works on a Tail camera. Options: PC snapshot, Camera snapshot (Tail). Starts as: PC snapshot. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.snapshot
Wake / sleep camera¶
Wakes the camera up or puts it to sleep. Handy to switch the camera off when you end your stream.
| Setting | What to put in |
|---|---|
| State | Wake wakes it, Sleep puts it to sleep, Toggle flips the current state. Options: Wake, Sleep, Toggle. Starts as: Toggle. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Variables it adds
| Variable | What it holds |
|---|---|
%obsbot.awake% |
True when the camera is awake now |
Type id: obsbot.wakeSleep
Zoom to maximum / minimum¶
Zooms the camera all the way in or all the way out.
| Setting | What to put in |
|---|---|
| Zoom | Max zooms all the way in. Min zooms all the way out. Options: Max, Min. Starts as: Max. |
| Camera | Which camera, from 1 to 4, in the order OBSBOT Center lists them. Leave empty to use the camera that is selected in OBSBOT Center. |
Type id: obsbot.zoomLimit