Create shared video wall

Share an unprotected video wall

POST /api/camera/createSharedVideoWall

Create shared video wall

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/camera/createSharedVideoWall \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "expirationTimeSecs": 86400,
  "invertSchedule": false,
  "password": "mypassword123",
  "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "videoWallUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "vodEnabled": true
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "sharedLiveVideoStreamUrl": "https://share.rhombussystems.com/videowall/abc123",
  "sharedLiveVideoStreamUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · 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.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request to create a shared video wall.

expirationTimeSecs · integer<int32> | null

Expiration time in seconds

Example:

86400

invertSchedule · boolean | null

Whether to invert the schedule

Example:

false

password · string | null

Password to protect the shared video wall

Example:

"mypassword123"

scheduleUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

videoWallUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

vodEnabled · boolean | null

Whether to enable video on demand

Example:

true

Response

200 - application/json

OK

Response containing the created shared video wall information.

error · boolean | null

errorMsg · string | null

sharedLiveVideoStreamUrl · string | null

URL for accessing the shared video wall

Example:

"https://share.rhombussystems.com/videowall/abc123"

sharedLiveVideoStreamUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

warningMsg · string | null