Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
Overlays

Change an overlay

Updates overlay settings

patch/streaming/streams/{stream_id}/overlays/{overlay_id}

Path parameters

stream_idinteger required

Stream ID

overlay_idinteger required

Overlay ID

Request body

urlstring

Valid http/https URL to an HTML page/widget

widthinteger

Width of the widget

heightinteger

Height of the widget

xinteger

Coordinate of left upper corner

yinteger

Coordinate of left upper corner

stretchboolean

Switch of auto scaling the widget. Must not be used as "true" simultaneously with the coordinate installation method (w, h, x, y).

Example request

{
  "url": "http://domain.com/myoverlay_new_3.html",
  "width": null,
  "height": null,
  "x": null,
  "y": null,
  "stretch": true
}

Response

Successful

urlstring required

Valid http/https URL to an HTML page/widget

widthinteger

Width of the widget

heightinteger

Height of the widget

xinteger

Coordinate of left upper corner

yinteger

Coordinate of left upper corner

stretchboolean

Switch of auto scaling the widget. Must not be used as "true" simultaneously with the coordinate installation method (w, h, x, y).

idinteger required

ID of the overlay

stream_idinteger required

ID of a stream to which it is attached

created_atstring required

Datetime of creation in ISO 8601

updated_atstring required

Datetime of last update in ISO 8601

Example response

{
  "id": 1,
  "stream_id": 12345,
  "url": "http://domain.com/myoverlay1.html",
  "width": 120,
  "height": 40,
  "x": 30,
  "y": 30,
  "stretch": false,
  "created_at": "2023-09-20T00:01:01.000Z",
  "updated_at": "2023-10-01T12:01:01.000Z"
}