Camera

API for communication with ZBOS by Zora Robotics.

Channels

zbos/camera/picture/get

publish

Get picture

Channel tags
  • Camera

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

Examples of payload
{
  "key": "ABCxyz"
}

zbos/camera/picture/event

subscribe

event: Get picture

Channel tags
  • Camera

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"

zbos/camera/stream/start

publish

Start the camera stream of the selected camera.

Channel tags
  • Camera

Message StreamStartRequest
Payload

Name

Type

Description

Accepted values

cameraId

string

Camera id

Any

extras

object

Any

Examples of payload
{
  "cameraId": "string",
  "extras": {}
}

zbos/camera/stream/stop

publish

Stop camera stream

Channel tags
  • Camera

Message VideoOptions
Payload

Name

Type

Description

Accepted values

requestId

string

Any

cameraId

string

camera id

Any

Examples of payload
{
  "requestId": "string",
  "cameraId": "string"
}

zbos/camera/stream/stop/event

subscribe

Camera stream has stopped

Channel tags
  • Camera

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/camera/stream/init

publish

Initialize camera stream

Send by the robot to start the webrtc handshake

Channel tags
  • Camera

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/camera/stream/offer

WebRTC Session Description

publish

Handsake offer for camera stream

Channel tags
  • Camera

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"

zbos/camera/stream/answer

WebRTC Session Description

subscribe

Handsake answer for camera stream

Channel tags
  • Camera

Message StreamAnswer
Payload

Name

Type

Description

Accepted values

type

object

  • OFFER

  • PRANSWER

  • ANSWER

type.name

string

Any

type.ordinal

integer

Any

sdp

string

Any

Examples of payload
{
  "type": "ANSWER",
  "sdp": "string"
}

zbos/camera/stream/candidate/core

WebRTC Session Description

subscribe

RTC ICE Candidate Core

Channel tags
  • Camera

Message Candidate
Payload

Name

Type

Description

Accepted values

cameraId

string

camera id

Any

type

string

Always returns "candidate"

Any

label

integer

sdpMLineIndex

Any

id

string

sdpMid

Any

candidate

string

Any

Examples of payload
{
  "cameraId": "string",
  "type": "string",
  "label": 5,
  "id": "string",
  "candidate": "string"
}

zbos/camera/stream/candidate/control

subscribe

RTC ICE Candidate Control

Channel tags
  • Camera

Message Candidate
Payload

Name

Type

Description

Accepted values

cameraId

string

camera id

Any

type

string

Always returns "candidate"

Any

label

integer

sdpMLineIndex

Any

id

string

sdpMid

Any

candidate

string

Any

Examples of payload
{
  "cameraId": "string",
  "type": "string",
  "label": 5,
  "id": "string",
  "candidate": "string"
}

zbos/camera/stream/twoway/request

publish

Request two way camera stream

Channel tags
  • Camera

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/camera/preview/resume

publish

Resume camera preview

Channel tags
  • Camera

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/camera/preview/pause

publish

Pause camera preview

Channel tags
  • Camera

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/camera/error

publish

Camera error

Channel tags
  • Camera

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/camera/qr/scan/start

publish

Start QR Scanning

Start a QR code scan using the camera.

Channel tags
  • Camera

Message QrScanStartRequest
Payload

Name

Type

Description

Accepted values

scan_id

string

Unique ID that will be used in related topics.

Any

scan_timeout

integer

Timeout in seconds after which the scan should automatically be stopped. Pass 0 to not have a timeout. 0 is also the default when no value was passed.

Any

Examples of payload
{
  "scan_id": "abc",
  "scan_timeout": 60
}
{
  "scan_id": "xyz",
  "scan_timeout": 0
}

zbos/camera/qr/scan/stop

publish

Stop QR Scanning

Stop a QR code scan using the camera.

Channel tags
  • Camera

Message QrScanStopRequest
Payload

Name

Type

Description

Accepted values

scan_id

string

Unique ID that should be the same as the one used in the start request.

Any

Examples of payload
{
  "scan_id": "abc"
}

zbos/camera/qr/scan/stopped/event

subscribe

Event: Stopped QR scanning

This event is published when a QR scan has stopped, either manually or due to a timeout.

Channel tags
  • Camera

Message QrScanStoppedEvent
Payload

Name

Type

Description

Accepted values

scan_id

string

Unique ID that will be the same as the one used in the start request.

Any

Examples of payload
{
  "scan_id": "abc"
}

zbos/camera/qr/result/event

subscribe

QR Result Event

This event is published every time a QR code is decoded while a scan is active.

Channel tags
  • Camera

Message QrResultEvent
Payload

Name

Type

Description

Accepted values

content

string

Any

Examples of payload
{
  "content": "QR Code Content"
}