Output Commands

All of the commands found here are related to the output of your project, allowing you to configure specific streaming destinations or specific types of output.

getOutputDevice

get

Get the current video format settings.

Responses

200

successful operation

application/json

400

bad request

get

HTTPcURLJavaScriptPython

GET /api/command/getOutputDevice HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "getOutputDevice",
    "device": "NDI",
    "reply": "getOutputDevice",
    "success": true
  }
}

getStreamHostServer

get

Get information on the current stream..

Responses

200

successful operation

application/json

400

bad request

get

HTTPcURLJavaScriptPython

GET /api/command/getStreamHostServer HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "getStreamHostServer",
    "reply": "getStreamHostServer",
    "success": true
  }
}

setOutputDevice

get

Set the current device to use for channel output. NOTE: only some products allow you to set different output devices for different channels.

Because this endpoint doesn't use any variables, it can also be accessed using a GET request.

Query parameters

devicestringOptional

the name of the output device to use, i.e. NDI

channelsstringOptional

optional: comma-separated list of channel indexes to connect to this device

Responses

200

successful operation

application/json

400

bad request

get

HTTPcURLJavaScriptPython

GET /api/command/setOutputDevice HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "setOutputDevice",
    "reply": "setOutputDevice",
    "success": true
  }
}

setStreamHostServers

get

Set the container format for the stream..

Query parameters

containerFormatstringOptional

RTMP for now

Responses

200

successful operation

application/json

400

bad request

get

HTTPcURLJavaScriptPython

GET /api/command/setStreamHostServers HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "setStreamHostServers",
    "error": "unknown command",
    "reply": "setStreamHostServers",
    "success": true
  }
}

startStreaming

get

Start an RTMP stream.

Query parameters

choicestringOptional

Service name, like "Facebook"

serverUrlstringOptional

rtmp(s) server url

streamKeystringOptional

stream key for the rtmp server

Responses

200

successful operation

application/json

400

bad request

get

HTTPcURLJavaScriptPython

GET /api/command/startStreaming HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "startStreaming",
    "reply": "startStreaming",
    "success": true
  }
}

stopStreaming

get

Stop the RTMP stream.

Responses

200

successful operation

application/json

400

bad request

get

HTTPcURLJavaScriptPython

GET /api/command/stopStreaming HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "stopStreaming",
    "reply": "stopStreaming",
    "folder": "",
    "subfolder": "",
    "success": true
  }
}