OGraf Server API - Get | Pixotope Help Center

Renderer Status

DataHub Get requests addressed to OGrafServer. Set RespondTo to the service that should receive the reply.

RendererStatus [GET]

RendererStatus

Returns the current status of all renderers as an Update named RendererStatus, sent to the service named in RespondTo. The same status is also broadcast whenever it changes.

No parameters — message is always {}.

Value

Renderers	object	Renderer status entries keyed by routing ID.
Renderers.*.routingId	string	Renderer routing ID.
Renderers.*.rendererId optional	string	Renderer ID.
Renderers.*.name	string	Renderer name.
Renderers.*.supportsRestore	boolean\|null	Whether the renderer supports restoring its layers, or null if unknown.
Renderers.*.connected	boolean	Whether the renderer is currently connected.
Renderers.*.connectedAtUnixMs	number	Connection time in Unix milliseconds.
Renderers.*.updatedAtUnixMs	number	Last status update in Unix milliseconds.
Renderers.*.disconnectedAtUnixMs optional	number	Disconnection time in Unix milliseconds, if disconnected.
Renderers.*.layers	object[]	Layers reported by the renderer, with the loaded graphic, current step and last action of each.

Example - Get renderer status

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "OGrafServer",
  "Name": "RendererStatus",
  "RespondTo": "MyController"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "MyController",
  "Source": "OGrafServer",
  "Name": "RendererStatus"
}

JSON

{
  "Value": {
    "Renderers": {
      "vio-1": {
        "routingId": "vio-1",
        "rendererId": "renderer-vio-1",
        "name": "Program renderer",
        "supportsRestore": true,
        "connected": true,
        "connectedAtUnixMs": 1791378000000,
        "updatedAtUnixMs": 1791378000100,
        "layers": [
          {
            "layer": 1,
            "layerId": "layer-1",
            "graphicInstanceId": "lower-third-1",
            "graphicId": "lower-third",
            "graphicName": "Lower third",
            "currentStep": 1,
            "lastAction": "play",
            "lastActionAt": "2026-10-07T13:00:00.100Z"
          }
        ]
      }
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=OGrafServer&Name=RendererStatus

Copy and paste into a browser to run - ⚠️ Executes immediately