Video Webservice

Splice V3

Send a request to create an arbitrary clip for multiple cameras

post/api/video/spliceV3

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/video/spliceV3
  • 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

alteredViewMapobject nullable

Map of device facet UUIDs to altered view configurations

audioIncludedboolean nullable

Whether to include audio in the clip

clipVisibility'PRIVATE' | 'ROLE_RESTRICTED' | 'ORG_WIDE'

Use accessSettings instead

descriptionstring nullable

Description for the spliced clip

deviceIntervalMapobject nullable

Optional map of device facet UUIDs to a list of time intervals (start/end millis) for multi-interval splicing. When provided and non-empty, the request is treated as multi-interval and the top-level startTimeMillis/durationSec are ignored. The sum of all interval durations across all devices is capped at 60 minutes, and each interval must be at least 1 second long.

deviceUuidsstring[] nullable

List of device facet UUIDs to splice video from

durationSecinteger nullable

Duration in seconds for the splice

integrationUploadMapobject nullable

Map of integration names to upload flags

saveToConsoleboolean nullable

Whether to save the clip to console

sendToSharedStorageboolean nullable

Whether to send to shared storage

sendToUserStorageboolean nullable

Whether to send to user storage

startTimeMillisinteger nullable

Start time in milliseconds for the splice

titlestring nullable

Title for the spliced clip

Example request

{
  "accessSettings": {
    "allowedRoles": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "allowedUsers": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  },
  "audioIncluded": true,
  "description": "Review of security incident from main entrance",
  "deviceUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "durationSec": 60,
  "saveToConsole": true,
  "startTimeMillis": 1640995200000,
  "title": "Security Incident Review"
}

Response

OK

clipUuidstring RUUID nullable

base 64 (url-safe) uuid string

clipUuidListstring[] nullable

List of UUIDs for created spliced clips

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",
  "clipUuidList": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ]
}

Changes

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