Video Webservice

Get exact frame URI

Generate URL to get an exact frame with optional crop from a camera. The URL is served by the media relay the camera is connected to right now, so use it promptly. The response always has HTTP status 200; check the status field, and only treat the frame as retrievable when it is AVAILABLE.

post/api/video/getExactFrameUri

Request

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

cameraUuidstring DeviceFacetUuid nullable required

RUUID with optional appended facet information

downscaleFactorinteger nullable

Ratio to shrink the image pixels by

jpgQualityinteger nullable

Adjust quality of image compression

permyriadCropHeightinteger nullable

Precise ratio to crop the height by. Capped at 10000, which is 100.00% of the image

permyriadCropWidthinteger nullable

Precise ratio to crop the width by. Capped at 10000, which is 100.00% of the image

permyriadCropXinteger nullable

Proportional location to start horizontal crop at. Where 10000 is 100.00% of, or the end of the image

permyriadCropYinteger nullable

Proportional location to start vertical crop at. Where 10000 is 100.00% of, or the end of the image

timestampMsinteger nullable required

Timestamp in epoch milliseconds

Example request

{
  "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
}

Response

OK

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
frameUristring nullable

URI to access the exact frame

responseMessagestring nullable

Response message from the frame generation

status'AVAILABLE' | 'FUTURE_TIMESTAMP' | 'CAMERA_DELETED' | 'CAMERA_STATE_UNAVAILABLE' | 'CAMERA_NOT_CONNECTED' | 'MEDIA_STORAGE_DEVICE_NOT_CONNECTED' | 'NOT_RECORDING_AT_TIMESTAMP' | 'NO_FOOTAGE_AT_TIMESTAMP' | 'MEDIA_ADDRESS_UNAVAILABLE' | 'FRAME_RETRIEVAL_FAILED'

Outcome of an exact frame request. AVAILABLE is the only value under which a frame URI or frame data is returned; every other value explains why the frame cannot be served.

warningMsgstring nullable

Example response

{
  "frameUri": "https://example.com/frame/12345.jpg",
  "responseMessage": "Frame generated successfully"
}

Changes

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