Skip to content

LivePreviewResponse

Field Type Required Description and constraints
sessionId string (uuid) Yes
streamId string (uuid) Yes
streamRevision integer Yes minimum 1.0
protocol "mjpeg" No default "mjpeg"
streamUrl string Yes
credential string Yes minimum length 64. maximum length 1024
credentialExpiresAt string (date-time) Yes

Additional properties are rejected by this schema.

{
"properties": {
"sessionId": {
"type": "string",
"format": "uuid",
"title": "Sessionid"
},
"streamId": {
"type": "string",
"format": "uuid",
"title": "Streamid"
},
"streamRevision": {
"type": "integer",
"minimum": 1.0,
"title": "Streamrevision"
},
"protocol": {
"type": "string",
"const": "mjpeg",
"title": "Protocol",
"default": "mjpeg"
},
"streamUrl": {
"type": "string",
"title": "Streamurl"
},
"credential": {
"type": "string",
"maxLength": 1024,
"minLength": 64,
"title": "Credential"
},
"credentialExpiresAt": {
"type": "string",
"format": "date-time",
"title": "Credentialexpiresat"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"sessionId",
"streamId",
"streamRevision",
"streamUrl",
"credential",
"credentialExpiresAt"
],
"title": "LivePreviewResponse"
}
Image preview