Skip to main content
POST
/
api
/
camera
/
createSharedLiveVideoStream
Create shared live video stream
curl --request POST \
  --url https://api2.rhombussystems.com/api/camera/createSharedLiveVideoStream \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "audioGatewayUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "expirationTimeSecs": 86400,
  "includeAudio": false,
  "invertSchedule": false,
  "name": "Front Door Live Stream",
  "password": "mypassword123",
  "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "ssoProtected": false,
  "streamType": "USER",
  "vodEnabled": true
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "sharedLiveM3U8StreamUrl": "https://example.com/live/m3u8/stream",
  "sharedLiveVideoStreamUrl": "https://example.com/live/video/stream",
  "sharedLiveVideoStreamUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request to create a shared live video stream for a camera.

​
audioGatewayUuid
string<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

​
cameraUuid
string<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

​
expirationTimeSecs
integer<int32> | null

Add an expiration date for accessing the stream in seconds

Example:

86400

​
includeAudio
boolean | null

Camera must be associated with an audio gateway to have audio

Example:

false

​
invertSchedule
boolean | null

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

Example:

false

​
name
string | null

If not provided, will be named 'Unnamed'

Example:

"Front Door Live Stream"

​
password
string | null

Add a password to allow access to your shared stream

Example:

"mypassword123"

​
scheduleUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
ssoProtected
boolean | null

Org must have SSO setup to use SSO protected streams

Example:

false

​
streamType
enum<string>
Available options:
USER,
ALARM_MONITORING,
DICE,
LUMEO,
INFORMACAST,
RAPIDSOS,
UNKNOWN
​
vodEnabled
boolean | null

Enables recording of live footage to a VOD

Example:

true

Response

200 - application/json

OK

Response containing the created shared live video stream information.

​
error
boolean | null
​
errorMsg
string | null
​
sharedLiveM3U8StreamUrl
string | null

M3U8 URL for the shared live video stream

Example:

"https://example.com/live/m3u8/stream"

​
sharedLiveVideoStreamUrl
string | null

URL for the shared live video stream

Example:

"https://example.com/live/video/stream"

​
sharedLiveVideoStreamUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
warningMsg
string | null