Video

Introduction

Access Token

Access tokens are the secret passwords that gives access to your resources through the APIs. You can create an API token from the Cloud as described in the introduction.
Make sure to keep your tokens secret and to not publish them publicly to prevent any security breach.

API in use

The Cloud API centralizes all your teams, workspaces, devices, applications, logs and telemetries. hub.stereolabs.com/api/v1

List recorded videos

List the videos recorded on a device.
  • :workspaceId integer
    Id of the workspace containing the devices.
  • :deviceNameOrId integer
    Id or url-encoded name of the targeted device.
  • start
    end     timestamp
    The time range to lookup for recordings on the device, with start < end.
    Provided in milliseconds UTC EPOCH UNIX timestamp 1567419371229 or ISO8601 datetime string 2019-09-02T11:21:11,229+02:00.
  • step integer
    The maximum duration of a single video in minutes. Minimum and default values are 10 minutes and maximum is 6 hours (360 minutes).
  • videos array
    List of available videos on the device, within the requested time range.
  • videos.thumbnail string
    Filename of the thumbnail image corresponding to this video.
  • videos.start
    videos.end     timestamp
    The time range (start time and end time) of this video. The maximum duration is controlled by the step, but smaller durations can be returned.
    • /workspaces/:workspaceId/devices/:deviceNameOrId/video 
    curl -s \
  -H "Content-Type:application/json" \
  -H "Authorization:Bearer ${access_token}" \
 https://hub.stereolabs.com/api/v1/workspaces/:workspaceId/devices/:deviceNameOrId/video \
  -G  \
  -d 'start=1584612300193' \
  -d 'start=1584912180425' \
  -d 'step=10'
    HTTP/1.1 200 OK
{ 
  "videos": [
    {
      "thumbnail": "2020-03-19_10-05-00AM_SN10025452.jpg",
      "start": 1584612300193,
      "end": 1584612600207
    },
    {
      "thumbnail": "2020-03-19_10-10-00AM_SN10025452.jpg",
      "start": 1584612600207,
      "end": 1584613200213
    },
    ...
  ]
}

    Download recorded videos

    Download a video matching the provided time range from a device. Recorded videos are available in MP4 and SVO file formats. An SVO file can be used with the ZED SDK to simulate a live ZED camera from a recording.
  • :workspaceId integer
    Id of the workspace containing the devices.
  • :deviceNameOrId integer
    Id or url-encoded name of the targeted device.
  • start
    end     timestamp
    The time range (start time and end time) of the video to download (1 hour maximum, with start < end).

    Provided in milliseconds UTC EPOCH UNIX timestamp 1567419371229 or ISO8601 datetime string 2019-09-02T11:21:11,229+02:00 (url-encoded).
  • output string
    optional The desired filename of the downloaded video.If not provided, an auto-generated filename will be used.
  • type string
    optional The desired video format between mp4 and svo. SVO are only available with recordings from a ZED camera.
  • SN integer
    optional The serial number of the desired video. If not provided, the video will be composed of chunks from different recordings.

    For devices with an edge newer than 0.64.
    • /workspaces/:workspaceId/devices/:deviceNameOrId/video/download 
    curl -s \
  -H "Content-Type:application/json" \
  -H "Authorization:Bearer ${access_token}" \
 https://hub.stereolabs.com/api/v1/workspaces/:workspaceId/devices/:deviceNameOrId/video/download \
  -G  \
  -d 'start=2019-09-02T11:20:00,000%2B02:00' \
  -d 'end=2019-09-02T11:30:00,000%2B02:00' \
  -d 'output=video_sequence' \
  -d 'type=mp4' \
  -d 'SN=25990291'
    HTTP/1.1 200 OK
video_sequence.mp4 file download

    Purge all recordings

    All the recorded videos will be purged from the device.
  • :workspaceId integer
    Id of the workspace containing the devices.
  • :deviceNameOrId integer
    Id or url-encoded name of the targeted device.
    • /workspaces/:workspaceId/devices/:deviceNameOrId/video 
    curl -s \
  -H "Content-Type:application/json" \
  -H "Authorization:Bearer ${access_token}" \
  -X POST \
 https://hub.stereolabs.com/api/v1/workspaces/:workspaceId/devices/:deviceNameOrId/video
    HTTP/1.1 200 OK
{}

    Delete recorded videos

    The recorded video between two timestamps will be deleted from the device.
  • :workspaceId integer
    Id of the workspace containing the devices.
  • :deviceNameOrId integer
    Id or url-encoded name of the targeted device.
  • start
    end     timestamp
    The time range (start time and end time) of the video to delete.
    Provided in milliseconds UTC EPOCH UNIX timestamp 1567419371229 or ISO8601 datetime string 2019-09-02T11:21:11,229+02:00 (url-encoded).
    • /workspaces/:workspaceId/devices/:deviceNameOrId/video 
    curl -s \
  -H "Content-Type:application/json" \
  -H "Authorization:Bearer ${access_token}" \
  -X DELETE \
 https://hub.stereolabs.com/api/v1/workspaces/:workspaceId/devices/:deviceNameOrId/video \
  -G  \
  -d 'start=2019-09-02T11:20:00,000%2B02:00' \
  -d 'end=2019-09-02T11:30:00,000%2B02:00'
    HTTP/1.1 200 OK
{}