Skip to main content
POST
/
api
/
camera
/
getMediaUris
Get camera media URIs
curl --request POST \
  --url https://api2.rhombussystems.com/api/camera/getMediaUris \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "lanCheckUrls": [
    "<string>"
  ],
  "lanLiveH264Uris": [
    "<string>"
  ],
  "lanLiveM3u8Uris": [
    "<string>"
  ],
  "lanLiveMpdUris": [
    "<string>"
  ],
  "lanLiveOpusUris": [
    "<string>"
  ],
  "lanVodM3u8UrisTemplates": [
    "<string>"
  ],
  "lanVodMpdUrisTemplates": [
    "<string>"
  ],
  "wanLiveH264Uri": "rtsp://camera.example.com/live",
  "wanLiveM3u8Uri": "https://camera.example.com/live.m3u8",
  "wanLiveMpdUri": "https://camera.example.com/live.mpd",
  "wanLiveOpusUri": "<string>",
  "wanVodH264UriTemplate": "https://camera.example.com/vod/{timestamp}.h264",
  "wanVodM3u8UriTemplate": "https://camera.example.com/vod/{timestamp}.m3u8",
  "wanVodMpdUriTemplate": "https://camera.example.com/vod/{timestamp}.mpd",
  "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 get media URIs for a camera device.

cameraUuid
string<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

Response

200 - application/json

OK

Response containing media URIs for camera streaming and playback.

error
boolean | null
errorMsg
string | null
lanCheckUrls
(string | null)[] | null

List of LAN check URLs to verify device availability

List of LAN check URLs to verify device availability

lanLiveH264Uris
(string | null)[] | null

List of LAN H.264 live streaming URIs

List of LAN H.264 live streaming URIs

lanLiveM3u8Uris
(string | null)[] | null

List of LAN M3U8 live streaming URIs

List of LAN M3U8 live streaming URIs

lanLiveMpdUris
(string | null)[] | null

List of LAN MPD live streaming URIs

List of LAN MPD live streaming URIs

lanLiveOpusUris
(string | null)[] | null

List of LAN URIs for live Opus audio streams

List of LAN URIs for live Opus audio streams

lanVodM3u8UrisTemplates
(string | null)[] | null

List of LAN M3U8 VOD URI templates

List of LAN M3U8 VOD URI templates

lanVodMpdUrisTemplates
(string | null)[] | null

List of LAN MPD VOD URI templates

List of LAN MPD VOD URI templates

wanLiveH264Uri
string | null

WAN H.264 live streaming URI

Example:

"rtsp://camera.example.com/live"

wanLiveM3u8Uri
string | null

WAN M3U8 live streaming URI

Example:

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

wanLiveMpdUri
string | null

WAN MPD live streaming URI

Example:

"https://camera.example.com/live.mpd"

wanLiveOpusUri
string | null

WAN URI for live Opus audio stream

wanVodH264UriTemplate
string | null

WAN H.264 VOD URI template

Example:

"https://camera.example.com/vod/{timestamp}.h264"

wanVodM3u8UriTemplate
string | null

WAN M3U8 VOD URI template

Example:

"https://camera.example.com/vod/{timestamp}.m3u8"

wanVodMpdUriTemplate
string | null

WAN MPD VOD URI template

Example:

"https://camera.example.com/vod/{timestamp}.mpd"

warningMsg
string | null