Camera Webservice

Create protected shared live video stream

Share a password protected live video stream for a camera

post/api/camera/createProtectedSharedLiveVideoStream

Request

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

audioGatewayUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

cameraUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

expirationTimeSecsinteger nullable

Add an expiration date for accessing the stream in seconds

includeAudioboolean nullable

Camera must be associated with an audio gateway to have audio

invertScheduleboolean nullable

If given a schedule UUID, will hide the stream during the schedule instead and show it otherwise

namestring nullable

If not provided, will be named 'Unnamed'

passwordstring nullable

Add a password to allow access to your shared stream

scheduleUuidstring RUUID nullable

base 64 (url-safe) uuid string

ssoProtectedboolean nullable

Org must have SSO setup to use SSO protected streams

streamType'USER' | 'ALARM_MONITORING' | 'DICE' | 'LUMEO' | 'INFORMACAST' | 'RAPIDSOS' | 'UNKNOWN'
vodEnabledboolean nullable

Enables recording of live footage to a VOD

Example request

{
  "audioGatewayUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "expirationTimeSecs": 86400,
  "name": "Front Door Live Stream",
  "password": "mypassword123",
  "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "vodEnabled": true
}

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

M3U8 URL for the shared live video stream

sharedLiveVideoStreamUrlstring nullable

URL for the shared live video stream

sharedLiveVideoStreamUuidstring RUUID nullable

base 64 (url-safe) uuid string

warningMsgstring nullable

Example response

{
  "sharedLiveM3U8StreamUrl": "https://example.com/live/m3u8/stream",
  "sharedLiveVideoStreamUrl": "https://example.com/live/video/stream",
  "sharedLiveVideoStreamUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

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