Managed Streams API · Dashboard
Mixers & graphics
Combine inputs, playlists and graphics into one program with scenes, layers, audio and transitions.
Base URL: https://api.hubfly.space. Use a Dashboard bearer token authorized for the project. Replace :projectId in each path with the Dashboard project ID. JSON routes use Content-Type: application/json.
Stream servers live in a project of type managed; other projects return 409 MANAGED_PROJECT_REQUIRED. Replace :instanceId with the stream server ID from the instance list. Each endpoint lists the permission it needs; a token scoped to the stream permissions must hold that exact permission.
How to use these endpoints
- Upload images, SVG templates, HTML bundles or fonts as graphics (at most 5 MiB each).
- Create a mixer with a canvas, an output bitrate, its sources and scenes. Each scene lists layers (position, size, crop, z-order, opacity) and audio (gain, mute).
- Feed the mixer into a channel (
source: {type: "mixer"}), then switch scenes live withmixer.sceneor update template variables withgraphics.set. - Updates take the resource's current
revision; a stale one returns409 STREAM_REVISION_CONFLICT. A mixer program bills 1.5 × its output as processing.
Update a lower-third's variables (send the graphic's current revision)
curl -X PUT "https://api.hubfly.space/api/v1/projects/$PROJECT_ID/managed/instances/$INSTANCE_ID/stream/graphics/$GRAPHIC_ID/update" \
-H "Authorization: Bearer $HUBFLY_TOKEN" \
-H "Content-Type: application/json" \
-d '{"revision":'"$REVISION"',"variables":{"name":"Aline Uwase","title":"Head of Product"}}'The response uses the standard Dashboard envelope: ok, data, and meta on success. On failure, use the returned error code and message to decide whether to correct the request or retry. The exact schema and response codes for each operation are below.
Endpoint reference
Dashboard endpoints (9)
These JSON routes are served by the Hubfly space Dashboard API and use Dashboard project authorization.
GETList graphicsDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/graphics
List the server's graphics (images, SVGs, HTML bundles and fonts used by mixers and slates) with their kind, sha256, size, content type and template variables.
- Requires
stream:read.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string", "enum": [ "image", "svg", "html", "font" ] }, "sha256": { "type": "string" }, "bytes": { "type": "number" }, "contentType": { "type": "string" }, "variables": { "type": "object", "additionalProperties": { "type": "string" } }, "uploadedAt": { "type": "string", "description": "Date string", "nullable": true }, "revision": { "type": "number" }, "createdByUserId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "name", "kind", "sha256", "bytes", "contentType", "variables", "uploadedAt", "revision", "createdByUserId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": [ { "id": "string", "name": "string", "kind": "image", "sha256": "string", "bytes": 0, "contentType": "string", "variables": null, "uploadedAt": "string", "revision": 0, "createdByUserId": "string", "createdAt": "string", "updatedAt": "string" } ], "meta": { "requestId": "string", "timestamp": "string" } }
POSTUpload a graphicDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/graphics/upload
Upload a logo, slate, SVG or HTML template, or font as base64 dataBase64. The Dashboard checks the file and forwards it to the stream node, which keeps the only copy; to replace a graphic, upload a new one.
- Requires
stream:admin. - At most 5 MiB decoded. Content types per
kind:imagetakesimage/png,image/jpegorimage/webp;svgtakesimage/svg+xml;htmltakesapplication/zipwithindex.htmlat its root;fonttakesfont/ttforfont/otf. - A file whose bytes do not match
contentTypereturns422 STREAM_INVALID(codegraphic_kind); a file the node refuses as too large returns413 STREAM_TOO_LARGE. - A server holds up to 200 graphics, 500 MiB in total.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
name | string | Yes |
kind | image | svg | html | font | Yes |
contentType | string | Yes |
dataBase64 | string | Yes |
Complete request schema
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"image",
"svg",
"html",
"font"
]
},
"contentType": {
"type": "string"
},
"dataBase64": {
"type": "string"
}
},
"required": [
"name",
"kind",
"contentType",
"dataBase64"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "graphic": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string", "enum": [ "image", "svg", "html", "font" ] }, "sha256": { "type": "string" }, "bytes": { "type": "number" }, "contentType": { "type": "string" }, "variables": { "type": "object", "additionalProperties": { "type": "string" } }, "uploadedAt": { "type": "string", "description": "Date string", "nullable": true }, "revision": { "type": "number" }, "createdByUserId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "name", "kind", "sha256", "bytes", "contentType", "variables", "uploadedAt", "revision", "createdByUserId", "createdAt", "updatedAt" ], "additionalProperties": false }, "sync": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "applied" ] }, "generation": { "type": "number" }, "error": { "type": "string", "nullable": true }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "code", "message" ], "additionalProperties": false } } }, "required": [ "status", "generation", "error", "warnings" ], "additionalProperties": false } }, "required": [ "graphic", "sync" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "graphic": { "id": "string", "name": "string", "kind": "image", "sha256": "string", "bytes": 0, "contentType": "string", "variables": null, "uploadedAt": "string", "revision": 0, "createdByUserId": "string", "createdAt": "string", "updatedAt": "string" }, "sync": { "status": "pending", "generation": 0, "error": "string", "warnings": [ { "path": "string", "code": "string", "message": "string" } ] } }, "meta": { "requestId": "string", "timestamp": "string" } }
DELETEDelete a graphicDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/graphics/:graphicId/delete
Delete a graphic; the node removes the file once it runs a configuration without it.
- Requires
stream:admin. - Refused with
409 STREAM_IN_USEwhile a mixer, channel slate or the offline slate still uses the graphic; the error lists thereferrers.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
graphicId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "deleted": { "const": true, "type": "boolean" }, "sync": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "applied" ] }, "generation": { "type": "number" }, "error": { "type": "string", "nullable": true }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "code", "message" ], "additionalProperties": false } } }, "required": [ "status", "generation", "error", "warnings" ], "additionalProperties": false } }, "required": [ "deleted", "sync" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "deleted": true, "sync": { "status": "pending", "generation": 0, "error": "string", "warnings": [ { "path": "string", "code": "string", "message": "string" } ] } }, "meta": { "requestId": "string", "timestamp": "string" } }
PUTUpdate a graphicDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/graphics/:graphicId/update
Rename a graphic or replace the template variables of an SVG or HTML graphic. For a one-off change during a live show, use graphics.set in the control call.
- Requires
stream:admin. - Send
revisionequal to the graphic's currentrevision; if it changed meanwhile you get409 STREAM_REVISION_CONFLICT. - Up to 64 variables with string values of at most 1 KiB.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
graphicId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
revision | number | Yes |
name | string | No |
variables | object | No |
Complete request schema
{
"type": "object",
"properties": {
"revision": {
"type": "number"
},
"name": {
"type": "string"
},
"variables": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"revision"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "graphic": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string", "enum": [ "image", "svg", "html", "font" ] }, "sha256": { "type": "string" }, "bytes": { "type": "number" }, "contentType": { "type": "string" }, "variables": { "type": "object", "additionalProperties": { "type": "string" } }, "uploadedAt": { "type": "string", "description": "Date string", "nullable": true }, "revision": { "type": "number" }, "createdByUserId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "name", "kind", "sha256", "bytes", "contentType", "variables", "uploadedAt", "revision", "createdByUserId", "createdAt", "updatedAt" ], "additionalProperties": false }, "sync": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "applied" ] }, "generation": { "type": "number" }, "error": { "type": "string", "nullable": true }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "code", "message" ], "additionalProperties": false } } }, "required": [ "status", "generation", "error", "warnings" ], "additionalProperties": false } }, "required": [ "graphic", "sync" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "graphic": { "id": "string", "name": "string", "kind": "image", "sha256": "string", "bytes": 0, "contentType": "string", "variables": null, "uploadedAt": "string", "revision": 0, "createdByUserId": "string", "createdAt": "string", "updatedAt": "string" }, "sync": { "status": "pending", "generation": 0, "error": "string", "warnings": [ { "path": "string", "code": "string", "message": "string" } ] } }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTCreate a mixerDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/mixers/create
Create a mixer that combines sources (inputs, playlists, images, SVG and HTML graphics, text, clocks and colors) into one program, arranged in scenes of layers with an audio mix. preset (1080p30 by default, 1080p60, 720p30 or vertical) fills the canvas and output; channels then play the mixer as their source.
- Requires
stream:admin. - A running mixer needs 1.5 × its output's billed Mbps of processing, plus 1.0 per visible HTML layer. Outputs beyond the server's processing cap stay
rejectedandsync.warningsreportsprocessing_over_cap. - The canvas is 160×90 to 3840×2160 with even sizes and 1–60 fps; a server holds up to 5 mixers.
- Unknown sources, invalid layers or scenes and cycles return
422 STREAM_INVALIDwithdetails; a duplicate name returns409 STREAM_NAME_TAKEN.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
output | object | No |
canvas | object | No |
sources | object | object | object | object | object | object | object | object[] | No |
scenes | object[] | No |
defaultScene | string | No |
transition | object | No |
name | string | Yes |
enabled | boolean | No |
preset | vertical | 1080p30 | 1080p60 | 720p30 | No |
Complete request schema
{
"type": "object",
"properties": {
"output": {
"type": "object",
"properties": {
"codec": {
"const": "h264",
"type": "string"
},
"videoBitrateKbps": {
"type": "number"
},
"audioBitrateKbps": {
"type": "number"
}
},
"required": [
"codec",
"videoBitrateKbps",
"audioBitrateKbps"
],
"additionalProperties": false
},
"canvas": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"fps": {
"type": "number"
},
"background": {
"type": "string"
}
},
"required": [
"width",
"height",
"fps",
"background"
],
"additionalProperties": false
},
"sources": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "input",
"type": "string"
},
"ref": {
"type": "string"
}
},
"required": [
"id",
"type",
"ref"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "playlist",
"type": "string"
},
"ref": {
"type": "string"
}
},
"required": [
"id",
"type",
"ref"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "image",
"type": "string"
},
"ref": {
"type": "string"
}
},
"required": [
"id",
"type",
"ref"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "svg",
"type": "string"
},
"ref": {
"type": "string"
}
},
"required": [
"id",
"type",
"ref"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "html",
"type": "string"
},
"ref": {
"type": "string"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"id",
"type",
"ref"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "text",
"type": "string"
},
"text": {
"type": "string"
},
"font": {
"type": "string"
},
"size": {
"type": "number"
},
"color": {
"type": "string"
},
"background": {
"type": "string"
}
},
"required": [
"id",
"type",
"text"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "clock",
"type": "string"
},
"format": {
"type": "string"
},
"timezone": {
"type": "string",
"nullable": true
},
"font": {
"type": "string"
},
"size": {
"type": "number"
},
"color": {
"type": "string"
},
"background": {
"type": "string"
}
},
"required": [
"id",
"type",
"format"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "color",
"type": "string"
},
"color": {
"type": "string"
}
},
"required": [
"id",
"type",
"color"
],
"additionalProperties": false
}
]
}
},
"scenes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"layers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"w": {
"type": "number"
},
"h": {
"type": "number"
},
"crop": {
"type": "object",
"properties": {
"l": {
"type": "number"
},
"t": {
"type": "number"
},
"r": {
"type": "number"
},
"b": {
"type": "number"
}
},
"required": [
"l",
"t",
"r",
"b"
],
"additionalProperties": false
},
"z": {
"type": "number"
},
"opacity": {
"type": "number"
},
"visible": {
"type": "boolean"
}
},
"required": [
"source",
"x",
"y",
"w",
"h",
"crop",
"z",
"opacity",
"visible"
],
"additionalProperties": false
}
},
"audio": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"gainDb": {
"type": "number"
},
"muted": {
"type": "boolean"
}
},
"required": [
"source",
"gainDb",
"muted"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"layers",
"audio"
],
"additionalProperties": false
}
},
"defaultScene": {
"type": "string"
},
"transition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"cut",
"fade"
]
},
"durationMs": {
"type": "number"
}
},
"required": [
"type",
"durationMs"
],
"additionalProperties": false
},
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"preset": {
"type": "string",
"enum": [
"vertical",
"1080p30",
"1080p60",
"720p30"
]
}
},
"required": [
"name"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "mixer": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "canvas": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "background": { "type": "string" } }, "required": [ "width", "height", "fps", "background" ], "additionalProperties": false }, "output": { "type": "object", "properties": { "codec": { "const": "h264", "type": "string" }, "videoBitrateKbps": { "type": "number" }, "audioBitrateKbps": { "type": "number" } }, "required": [ "codec", "videoBitrateKbps", "audioBitrateKbps" ], "additionalProperties": false }, "sources": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "input", "type": "string" }, "ref": { "type": "string" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "playlist", "type": "string" }, "ref": { "type": "string" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "image", "type": "string" }, "ref": { "type": "string" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "svg", "type": "string" }, "ref": { "type": "string" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "html", "type": "string" }, "ref": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "text", "type": "string" }, "text": { "type": "string" }, "font": { "type": "string" }, "size": { "type": "number" }, "color": { "type": "string" }, "background": { "type": "string" } }, "required": [ "id", "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "clock", "type": "string" }, "format": { "type": "string" }, "timezone": { "type": "string", "nullable": true }, "font": { "type": "string" }, "size": { "type": "number" }, "color": { "type": "string" }, "background": { "type": "string" } }, "required": [ "id", "type", "format" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "color", "type": "string" }, "color": { "type": "string" } }, "required": [ "id", "type", "color" ], "additionalProperties": false } ] } }, "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "layers": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" }, "crop": { "type": "object", "properties": { "l": { "type": "number" }, "t": { "type": "number" }, "r": { "type": "number" }, "b": { "type": "number" } }, "required": [ "l", "t", "r", "b" ], "additionalProperties": false }, "z": { "type": "number" }, "opacity": { "type": "number" }, "visible": { "type": "boolean" } }, "required": [ "source", "x", "y", "w", "h", "crop", "z", "opacity", "visible" ], "additionalProperties": false } }, "audio": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "gainDb": { "type": "number" }, "muted": { "type": "boolean" } }, "required": [ "source", "gainDb", "muted" ], "additionalProperties": false } } }, "required": [ "id", "name", "layers", "audio" ], "additionalProperties": false } }, "defaultScene": { "type": "string" }, "transition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "cut", "fade" ] }, "durationMs": { "type": "number" } }, "required": [ "type", "durationMs" ], "additionalProperties": false }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "revision": { "type": "number" }, "processingMbps": { "type": "number" } }, "required": [ "id", "name", "enabled", "canvas", "output", "sources", "scenes", "defaultScene", "transition", "createdAt", "updatedAt", "revision", "processingMbps" ], "additionalProperties": false }, "sync": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "applied" ] }, "generation": { "type": "number" }, "error": { "type": "string", "nullable": true }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "code", "message" ], "additionalProperties": false } } }, "required": [ "status", "generation", "error", "warnings" ], "additionalProperties": false } }, "required": [ "mixer", "sync" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "mixer": { "id": "string", "name": "string", "enabled": true, "canvas": { "width": 0, "height": 0, "fps": 0, "background": "string" }, "output": { "codec": "string", "videoBitrateKbps": 0, "audioBitrateKbps": 0 }, "sources": [ null ], "scenes": [ { "id": "string", "name": "string", "layers": [ { "source": "string", "x": 0, "y": 0, "w": 0, "h": 0, "crop": { "l": 0, "t": 0, "r": 0, "b": 0 }, "z": 0, "opacity": 0, "visible": true } ], "audio": [ { "source": "string", "gainDb": 0, "muted": true } ] } ], "defaultScene": "string", "transition": { "type": "cut", "durationMs": 0 }, "createdAt": "string", "updatedAt": "string", "revision": 0, "processingMbps": 0 }, "sync": { "status": "pending", "generation": 0, "error": "string", "warnings": [ { "path": "string", "code": "string", "message": "string" } ] } }, "meta": { "requestId": "string", "timestamp": "string" } }
GETList mixersDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/mixers
List the server's mixers, its cloud production switchers: canvas, output encoding, sources, scenes of layers and audio levels, default scene, transition and processingMbps, the processing a mixer needs while it runs.
- Requires
stream:read.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "canvas": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "background": { "type": "string" } }, "required": [ "width", "height", "fps", "background" ], "additionalProperties": false }, "output": { "type": "object", "properties": { "codec": { "const": "h264", "type": "string" }, "videoBitrateKbps": { "type": "number" }, "audioBitrateKbps": { "type": "number" } }, "required": [ "codec", "videoBitrateKbps", "audioBitrateKbps" ], "additionalProperties": false }, "sources": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "input", "type": "string" }, "ref": { "type": "string" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "playlist", "type": "string" }, "ref": { "type": "string" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "image", "type": "string" }, "ref": { "type": "string" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "svg", "type": "string" }, "ref": { "type": "string" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "html", "type": "string" }, "ref": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "text", "type": "string" }, "text": { "type": "string" }, "font": { "type": "string" }, "size": { "type": "number" }, "color": { "type": "string" }, "background": { "type": "string" } }, "required": [ "id", "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "clock", "type": "string" }, "format": { "type": "string" }, "timezone": { "type": "string", "nullable": true }, "font": { "type": "string" }, "size": { "type": "number" }, "color": { "type": "string" }, "background": { "type": "string" } }, "required": [ "id", "type", "format" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "color", "type": "string" }, "color": { "type": "string" } }, "required": [ "id", "type", "color" ], "additionalProperties": false } ] } }, "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "layers": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" }, "crop": { "type": "object", "properties": { "l": { "type": "number" }, "t": { "type": "number" }, "r": { "type": "number" }, "b": { "type": "number" } }, "required": [ "l", "t", "r", "b" ], "additionalProperties": false }, "z": { "type": "number" }, "opacity": { "type": "number" }, "visible": { "type": "boolean" } }, "required": [ "source", "x", "y", "w", "h", "crop", "z", "opacity", "visible" ], "additionalProperties": false } }, "audio": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "gainDb": { "type": "number" }, "muted": { "type": "boolean" } }, "required": [ "source", "gainDb", "muted" ], "additionalProperties": false } } }, "required": [ "id", "name", "layers", "audio" ], "additionalProperties": false } }, "defaultScene": { "type": "string" }, "transition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "cut", "fade" ] }, "durationMs": { "type": "number" } }, "required": [ "type", "durationMs" ], "additionalProperties": false }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "revision": { "type": "number" }, "processingMbps": { "type": "number" } }, "required": [ "id", "name", "enabled", "canvas", "output", "sources", "scenes", "defaultScene", "transition", "createdAt", "updatedAt", "revision", "processingMbps" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": [ { "id": "string", "name": "string", "enabled": true, "canvas": { "width": 0, "height": 0, "fps": 0, "background": "string" }, "output": { "codec": "string", "videoBitrateKbps": 0, "audioBitrateKbps": 0 }, "sources": [ null ], "scenes": [ { "id": "string", "name": "string", "layers": [ { "source": "string", "x": 0, "y": 0, "w": 0, "h": 0, "crop": { "l": 0, "t": 0, "r": 0, "b": 0 }, "z": 0, "opacity": 0, "visible": true } ], "audio": [ { "source": "string", "gainDb": 0, "muted": true } ] } ], "defaultScene": "string", "transition": { "type": "cut", "durationMs": 0 }, "createdAt": "string", "updatedAt": "string", "revision": 0, "processingMbps": 0 } ], "meta": { "requestId": "string", "timestamp": "string" } }
DELETEDelete a mixerDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/mixers/:mixerId/delete
Delete a mixer and its scenes.
- Requires
stream:admin. - Refused with
409 STREAM_IN_USEwhile a channel or schedule still uses the mixer; the error lists thereferrers.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
mixerId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "deleted": { "const": true, "type": "boolean" }, "sync": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "applied" ] }, "generation": { "type": "number" }, "error": { "type": "string", "nullable": true }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "code", "message" ], "additionalProperties": false } } }, "required": [ "status", "generation", "error", "warnings" ], "additionalProperties": false } }, "required": [ "deleted", "sync" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "deleted": true, "sync": { "status": "pending", "generation": 0, "error": "string", "warnings": [ { "path": "string", "code": "string", "message": "string" } ] } }, "meta": { "requestId": "string", "timestamp": "string" } }
GETRead a mixerDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/mixers/:mixerId
Return one mixer's full configuration with its revision and processingMbps. Pass revision back when you update the mixer.
- Requires
stream:read.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
mixerId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "canvas": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "background": { "type": "string" } }, "required": [ "width", "height", "fps", "background" ], "additionalProperties": false }, "output": { "type": "object", "properties": { "codec": { "const": "h264", "type": "string" }, "videoBitrateKbps": { "type": "number" }, "audioBitrateKbps": { "type": "number" } }, "required": [ "codec", "videoBitrateKbps", "audioBitrateKbps" ], "additionalProperties": false }, "sources": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "input", "type": "string" }, "ref": { "type": "string" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "playlist", "type": "string" }, "ref": { "type": "string" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "image", "type": "string" }, "ref": { "type": "string" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "svg", "type": "string" }, "ref": { "type": "string" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "html", "type": "string" }, "ref": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "text", "type": "string" }, "text": { "type": "string" }, "font": { "type": "string" }, "size": { "type": "number" }, "color": { "type": "string" }, "background": { "type": "string" } }, "required": [ "id", "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "clock", "type": "string" }, "format": { "type": "string" }, "timezone": { "type": "string", "nullable": true }, "font": { "type": "string" }, "size": { "type": "number" }, "color": { "type": "string" }, "background": { "type": "string" } }, "required": [ "id", "type", "format" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "color", "type": "string" }, "color": { "type": "string" } }, "required": [ "id", "type", "color" ], "additionalProperties": false } ] } }, "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "layers": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" }, "crop": { "type": "object", "properties": { "l": { "type": "number" }, "t": { "type": "number" }, "r": { "type": "number" }, "b": { "type": "number" } }, "required": [ "l", "t", "r", "b" ], "additionalProperties": false }, "z": { "type": "number" }, "opacity": { "type": "number" }, "visible": { "type": "boolean" } }, "required": [ "source", "x", "y", "w", "h", "crop", "z", "opacity", "visible" ], "additionalProperties": false } }, "audio": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "gainDb": { "type": "number" }, "muted": { "type": "boolean" } }, "required": [ "source", "gainDb", "muted" ], "additionalProperties": false } } }, "required": [ "id", "name", "layers", "audio" ], "additionalProperties": false } }, "defaultScene": { "type": "string" }, "transition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "cut", "fade" ] }, "durationMs": { "type": "number" } }, "required": [ "type", "durationMs" ], "additionalProperties": false }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "revision": { "type": "number" }, "processingMbps": { "type": "number" } }, "required": [ "id", "name", "enabled", "canvas", "output", "sources", "scenes", "defaultScene", "transition", "createdAt", "updatedAt", "revision", "processingMbps" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "id": "string", "name": "string", "enabled": true, "canvas": { "width": 0, "height": 0, "fps": 0, "background": "string" }, "output": { "codec": "string", "videoBitrateKbps": 0, "audioBitrateKbps": 0 }, "sources": [ null ], "scenes": [ { "id": "string", "name": "string", "layers": [ { "source": "string", "x": 0, "y": 0, "w": 0, "h": 0, "crop": { "l": 0, "t": 0, "r": 0, "b": 0 }, "z": 0, "opacity": 0, "visible": true } ], "audio": [ { "source": "string", "gainDb": 0, "muted": true } ] } ], "defaultScene": "string", "transition": { "type": "cut", "durationMs": 0 }, "createdAt": "string", "updatedAt": "string", "revision": 0, "processingMbps": 0 }, "meta": { "requestId": "string", "timestamp": "string" } }
PUTUpdate a mixerDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/mixers/:mixerId/update
Change a mixer's name, enabled state, canvas, output, sources, scenes, default scene or transition. Omitted fields keep their value, objects merge one level deep and arrays such as sources and scenes replace the stored list. To switch scenes live, use mixer.scene in the control call instead.
- Requires
stream:admin. - Send
revisionequal to the mixer's currentrevision; if it changed meanwhile you get409 STREAM_REVISION_CONFLICT. - Invalid configuration returns
422 STREAM_INVALIDwithdetails.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
mixerId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
output | object | No |
canvas | object | No |
sources | object | object | object | object | object | object | object | object[] | No |
scenes | object[] | No |
defaultScene | string | No |
transition | object | No |
name | string | No |
enabled | boolean | No |
revision | number | Yes |
Complete request schema
{
"type": "object",
"properties": {
"output": {
"type": "object",
"properties": {
"codec": {
"const": "h264",
"type": "string"
},
"videoBitrateKbps": {
"type": "number"
},
"audioBitrateKbps": {
"type": "number"
}
},
"required": [
"codec",
"videoBitrateKbps",
"audioBitrateKbps"
],
"additionalProperties": false
},
"canvas": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"fps": {
"type": "number"
},
"background": {
"type": "string"
}
},
"required": [
"width",
"height",
"fps",
"background"
],
"additionalProperties": false
},
"sources": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "input",
"type": "string"
},
"ref": {
"type": "string"
}
},
"required": [
"id",
"type",
"ref"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "playlist",
"type": "string"
},
"ref": {
"type": "string"
}
},
"required": [
"id",
"type",
"ref"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "image",
"type": "string"
},
"ref": {
"type": "string"
}
},
"required": [
"id",
"type",
"ref"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "svg",
"type": "string"
},
"ref": {
"type": "string"
}
},
"required": [
"id",
"type",
"ref"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "html",
"type": "string"
},
"ref": {
"type": "string"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"id",
"type",
"ref"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "text",
"type": "string"
},
"text": {
"type": "string"
},
"font": {
"type": "string"
},
"size": {
"type": "number"
},
"color": {
"type": "string"
},
"background": {
"type": "string"
}
},
"required": [
"id",
"type",
"text"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "clock",
"type": "string"
},
"format": {
"type": "string"
},
"timezone": {
"type": "string",
"nullable": true
},
"font": {
"type": "string"
},
"size": {
"type": "number"
},
"color": {
"type": "string"
},
"background": {
"type": "string"
}
},
"required": [
"id",
"type",
"format"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "color",
"type": "string"
},
"color": {
"type": "string"
}
},
"required": [
"id",
"type",
"color"
],
"additionalProperties": false
}
]
}
},
"scenes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"layers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"w": {
"type": "number"
},
"h": {
"type": "number"
},
"crop": {
"type": "object",
"properties": {
"l": {
"type": "number"
},
"t": {
"type": "number"
},
"r": {
"type": "number"
},
"b": {
"type": "number"
}
},
"required": [
"l",
"t",
"r",
"b"
],
"additionalProperties": false
},
"z": {
"type": "number"
},
"opacity": {
"type": "number"
},
"visible": {
"type": "boolean"
}
},
"required": [
"source",
"x",
"y",
"w",
"h",
"crop",
"z",
"opacity",
"visible"
],
"additionalProperties": false
}
},
"audio": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"gainDb": {
"type": "number"
},
"muted": {
"type": "boolean"
}
},
"required": [
"source",
"gainDb",
"muted"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"layers",
"audio"
],
"additionalProperties": false
}
},
"defaultScene": {
"type": "string"
},
"transition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"cut",
"fade"
]
},
"durationMs": {
"type": "number"
}
},
"required": [
"type",
"durationMs"
],
"additionalProperties": false
},
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"revision": {
"type": "number"
}
},
"required": [
"revision"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "mixer": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "canvas": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "background": { "type": "string" } }, "required": [ "width", "height", "fps", "background" ], "additionalProperties": false }, "output": { "type": "object", "properties": { "codec": { "const": "h264", "type": "string" }, "videoBitrateKbps": { "type": "number" }, "audioBitrateKbps": { "type": "number" } }, "required": [ "codec", "videoBitrateKbps", "audioBitrateKbps" ], "additionalProperties": false }, "sources": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "input", "type": "string" }, "ref": { "type": "string" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "playlist", "type": "string" }, "ref": { "type": "string" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "image", "type": "string" }, "ref": { "type": "string" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "svg", "type": "string" }, "ref": { "type": "string" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "html", "type": "string" }, "ref": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" } }, "required": [ "id", "type", "ref" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "text", "type": "string" }, "text": { "type": "string" }, "font": { "type": "string" }, "size": { "type": "number" }, "color": { "type": "string" }, "background": { "type": "string" } }, "required": [ "id", "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "clock", "type": "string" }, "format": { "type": "string" }, "timezone": { "type": "string", "nullable": true }, "font": { "type": "string" }, "size": { "type": "number" }, "color": { "type": "string" }, "background": { "type": "string" } }, "required": [ "id", "type", "format" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "const": "color", "type": "string" }, "color": { "type": "string" } }, "required": [ "id", "type", "color" ], "additionalProperties": false } ] } }, "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "layers": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" }, "crop": { "type": "object", "properties": { "l": { "type": "number" }, "t": { "type": "number" }, "r": { "type": "number" }, "b": { "type": "number" } }, "required": [ "l", "t", "r", "b" ], "additionalProperties": false }, "z": { "type": "number" }, "opacity": { "type": "number" }, "visible": { "type": "boolean" } }, "required": [ "source", "x", "y", "w", "h", "crop", "z", "opacity", "visible" ], "additionalProperties": false } }, "audio": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "gainDb": { "type": "number" }, "muted": { "type": "boolean" } }, "required": [ "source", "gainDb", "muted" ], "additionalProperties": false } } }, "required": [ "id", "name", "layers", "audio" ], "additionalProperties": false } }, "defaultScene": { "type": "string" }, "transition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "cut", "fade" ] }, "durationMs": { "type": "number" } }, "required": [ "type", "durationMs" ], "additionalProperties": false }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "revision": { "type": "number" }, "processingMbps": { "type": "number" } }, "required": [ "id", "name", "enabled", "canvas", "output", "sources", "scenes", "defaultScene", "transition", "createdAt", "updatedAt", "revision", "processingMbps" ], "additionalProperties": false }, "sync": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "applied" ] }, "generation": { "type": "number" }, "error": { "type": "string", "nullable": true }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "code", "message" ], "additionalProperties": false } } }, "required": [ "status", "generation", "error", "warnings" ], "additionalProperties": false } }, "required": [ "mixer", "sync" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "mixer": { "id": "string", "name": "string", "enabled": true, "canvas": { "width": 0, "height": 0, "fps": 0, "background": "string" }, "output": { "codec": "string", "videoBitrateKbps": 0, "audioBitrateKbps": 0 }, "sources": [ null ], "scenes": [ { "id": "string", "name": "string", "layers": [ { "source": "string", "x": 0, "y": 0, "w": 0, "h": 0, "crop": { "l": 0, "t": 0, "r": 0, "b": 0 }, "z": 0, "opacity": 0, "visible": true } ], "audio": [ { "source": "string", "gainDb": 0, "muted": true } ] } ], "defaultScene": "string", "transition": { "type": "cut", "durationMs": 0 }, "createdAt": "string", "updatedAt": "string", "revision": 0, "processingMbps": 0 }, "sync": { "status": "pending", "generation": 0, "error": "string", "warnings": [ { "path": "string", "code": "string", "message": "string" } ] } }, "meta": { "requestId": "string", "timestamp": "string" } }