Video Webservice

Generate timelapse clip

Generate a timelapse

post/api/video/generateTimelapseClip

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/video/generateTimelapseClip
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

descriptionstring nullable

Description for the timelapse

deviceUuidsstring[] nullable

List of device facet UUIDs to include in the timelapse. UUIDs without a facet defined will default to facet v0

drawCameraDetailsboolean nullable

Whether to draw camera details on the video

drawTimestampboolean nullable

Whether to draw timestamps on the video

skipNightsboolean nullable

Whether to skip night time periods

skipWeekendsboolean nullable

Whether to skip weekend periods

startTimeinteger nullable

Start time in milliseconds for the timelapse

stopTimeinteger nullable

Stop time in milliseconds for the timelapse

titlestring nullable

Title for the timelapse

videoDurationinteger nullable

Duration in seconds for the output video

videoFormatstring nullable

Format for the output video

Example request

{
  "description": "Daily timelapse of security events",
  "deviceUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "drawCameraDetails": true,
  "drawTimestamp": true,
  "skipNights": true,
  "startTime": 1640995200000,
  "stopTime": 1640998800000,
  "title": "Daily Security Review",
  "videoDuration": 60,
  "videoFormat": "mp4"
}

Response

OK

clipUuidstring RUUID nullable

base 64 (url-safe) uuid string

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

No recorded changes to this operation across all 1 revision of this API.