Streams

Each camera contains a number of sensors of different types. Each sensor (or combination of multiple sensors) provides an image stream which can be consumed directly as video stream, or fed as input into a neural network. Our API exposes operations through which these streams can be consumed or manipulated. Each stream is addresses either by its sensor name - or by its combined name - .

Depth API

Some camera models containing multiple image sensors, support a feature called Stereo Depth. This feature combines data from two image sensors at a time, to calculate the depth of the image in front of it. The result is a single image stream. The image will consist of depth data calculated by the camera, lighter areas will contain objects that are closer to the camera while darker areas will contain objects further away. This stream is configurable the same way as a single sensor.

Depth stream and the respective sensors it uses cannot be both active at the same time. E.g. if stream DEPTH_B_C is active, then streams CAM_B and CAM_C will be inactive and vice versa.

API Reference

List All Streams

get

/cameras/{mxid}/streams/

Path parameters

mxidMxidrequired

Pattern: [A-Z0-9]+

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://robopipe-1.local/cameras/{mxid}/streams/'

200

404

422

200

No body

Successful Response

Activate Stream

post

/cameras/{mxid}/streams/{stream_name}//

Path parameters

stream_nameStream Namerequired

Pattern: CAM_[A-H]|DEPTH_[A-H]_[A-H]

mxidMxidrequired

Pattern: [A-Z0-9]+

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://robopipe-1.local/cameras/{mxid}/streams/{stream_name}/'

201

404

422

201

No body

Successful Response

Deactivate Stream

delete

/cameras/{mxid}/streams/{stream_name}//

Path parameters

stream_nameStream Namerequired

Pattern: CAM_[A-H]|DEPTH_[A-H]_[A-H]

mxidMxidrequired

Pattern: [A-Z0-9]+

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://robopipe-1.local/cameras/{mxid}/streams/{stream_name}/'

202

404

422

202

No body

Successful Response

Get Stream Config

get

/cameras/{mxid}/streams/{stream_name}/config

Path parameters

stream_nameStream Namerequired

Pattern: CAM_[A-H]|DEPTH_[A-H]_[A-H]

mxidMxidrequired

Pattern: [A-Z0-9]+

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://robopipe-1.local/cameras/{mxid}/streams/{stream_name}/config'

200

404

422

200

{
  "fps": 1,
  "resolution": [],
  "still_size": [],
  "preview_size": [],
  "video_size": []
}

Successful Response

Update Stream Config

post

/cameras/{mxid}/streams/{stream_name}/config

Path parameters

stream_nameStream Namerequired

Pattern: CAM_[A-H]|DEPTH_[A-H]_[A-H]

mxidMxidrequired

Pattern: [A-Z0-9]+

Body

Config

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://robopipe-1.local/cameras/{mxid}/streams/{stream_name}/config' \
  --header 'Content-Type: application/json' \
  --data '{"fps":1,"resolution":[],"still_size":[],"preview_size":[],"video_size":[]}'

200

404

422

200

{
  "fps": 1,
  "resolution": [],
  "still_size": [],
  "preview_size": [],
  "video_size": []
}

Successful Response

Get Stream Control

get

/cameras/{mxid}/streams/{stream_name}/control

Path parameters

stream_nameStream Namerequired

Pattern: CAM_[A-H]|DEPTH_[A-H]_[A-H]

mxidMxidrequired

Pattern: [A-Z0-9]+

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://robopipe-1.local/cameras/{mxid}/streams/{stream_name}/control'

200

404

422

200

{
  "exposure_time": 1,
  "sensitivity_iso": 1,
  "auto_exposure_enable": true,
  "auto_exposure_compensation": 1,
  "auto_exposure_limit": 1,
  "auto_exposure_lock": true,
  "contrast": 1,
  "brightness": 1,
  "saturation": 1,
  "chroma_denoise": 1,
  "luma_denoise": 1,
  "auto_whitebalance_lock": true,
  "auto_whitebalance_mode": "AUTO",
  "manual_whitebalance": 1,
  "focus": {
    "auto_focus_mode": "CONTINUOUS_VIDEO",
    "auto_focus_trigger": false,
    "lens_position": 0
  }
}

Successful Response

Update Stream Control

post

/cameras/{mxid}/streams/{stream_name}/control

Path parameters

stream_nameStream Namerequired

Pattern: CAM_[A-H]|DEPTH_[A-H]_[A-H]

mxidMxidrequired

Pattern: [A-Z0-9]+

Body

exposure_timeExposure Time

Exposure time in microseconds. Ignored if auto_exposure_enable is set to true. Value must be between 1 and 33000

sensitivity_isoSensitivity Iso

Value must be between 100 and 5000

auto_exposure_enableAuto Exposure Enable

auto_exposure_compensationAuto Exposure Compensation

Value must be between -9 and 9

auto_exposure_limitAuto Exposure Limit

Maximum exposure time limit for auto-exposure in microseconds

auto_exposure_lockAuto Exposure Lock

contrastContrast

Value must be between -10 and 10

brightnessBrightness

Value must be between -10 and 10

saturationSaturation

Value must be between -10 and 10

chroma_denoiseChroma Denoise

Value must be between 0 and 4

luma_denoiseLuma Denoise

Value must be between 0 and 4

auto_whitebalance_lockAuto Whitebalance Lock

auto_whitebalance_modeAutoWhiteBalanceMode

Options: AUTO, CLOUDY_DAYLIGHT, DAYLIGHT, FLUORESCENT, INCANDESCENT, OFF, SHADE, TWILIGHT, WARM_FLUORESCENT

manual_whitebalanceManual Whitebalance

Value must be between 1000 and 12000

focusany of

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://robopipe-1.local/cameras/{mxid}/streams/{stream_name}/control' \
  --header 'Content-Type: application/json' \
  --data '{"auto_whitebalance_mode":"AUTO","focus":{"auto_focus_mode":"CONTINUOUS_VIDEO","auto_focus_trigger":false,"lens_position":0}}'

200

404

422

200

{
  "exposure_time": 1,
  "sensitivity_iso": 1,
  "auto_exposure_enable": true,
  "auto_exposure_compensation": 1,
  "auto_exposure_limit": 1,
  "auto_exposure_lock": true,
  "contrast": 1,
  "brightness": 1,
  "saturation": 1,
  "chroma_denoise": 1,
  "luma_denoise": 1,
  "auto_whitebalance_lock": true,
  "auto_whitebalance_mode": "AUTO",
  "manual_whitebalance": 1,
  "focus": {
    "auto_focus_mode": "CONTINUOUS_VIDEO",
    "auto_focus_trigger": false,
    "lens_position": 0
  }
}

Successful Response

Capture Still Image

get

/cameras/{mxid}/streams/{stream_name}/still

Path parameters

stream_nameStream Namerequired

Pattern: CAM_[A-H]|DEPTH_[A-H]_[A-H]

mxidMxidrequired

Pattern: [A-Z0-9]+

Query parameters

formatFormat

Responses

image/*

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://robopipe-1.local/cameras/{mxid}/streams/{stream_name}/still'

200

404

422

200

text

Image bytes in the selected format