Video Commands
If you are ingesting any live source (SDI, HDMI, NDI, USB, etc.) into Captivate, these video commands will return lists and allow you to manipulate any live source in the switcher.
Close a video device by named port. NOTE: This call uses "video" as the field name, not "videoIn.".
optional id to track this command, will be returned in the response
Name of the video device to open.
successful operation
bad request
GET /api/command/closeVideoIn HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*
{
"result": {
"command": "closeVideoIn",
"reply": "closeVideoIn",
"success": true
}
}Returns a list of all video devices available for input.
optional id to track this command, will be returned in the response
set to 1 for more information
successful operation
bad request
GET /api/command/getAllVideoIns HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*
{
"result": {
"command": "getAllVideoIns",
"count": "23",
"reply": "getAllVideoIns",
"success": true,
"videoIns": [
"NDI Video"
]
}
}Get a list of all opened video devices..
optional id to track this command, will be returned in the response
successful operation
bad request
GET /api/command/getOpenedVideoIns HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*
{
"result": {
"command": "getOpenedVideoIns",
"reply": "getOpenedVideoIns",
"success": true,
"videoIns": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
]
}
}Retrieve an encoded png of the specified stream in the width and height requested.
optional id to track this command, will be returned in the response
required width in pixels
required height in pixels
The name of the video input to query.
successful operation
bad request
GET /api/command/getVideoInIcon?width=text&height=text HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*
{
"result": {
"command": "getVideoInIcon",
"error": "missing width or height or video attributes",
"reply": "getVideoInIcon",
"success": true
}
}Returns a set of all video devices available and their status.
optional id to track this command, will be returned in the response
The name of the video input to query.
successful operation
bad request
GET /api/command/getVideoInInfo HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*
{
"result": {
"command": "getVideoInInfo",
"reply": "getVideoInInfo",
"success": true,
"videoIns": [
{
"add": "0",
"audio": "0",
"config": "BB86C477-373F-49D9-AA4B-CE86A0E883F1",
"name": "NDI Video",
"setup": "0",
"type": "Mac",
"video": "1"
}
]
}
}Open a video device by named port. NOTE: This call uses "video" as the field name, not "videoIn.".
optional id to track this command, will be returned in the response
Name of the video device to open.
successful operation
bad request
GET /api/command/openVideoIn HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*
{
"result": {
"command": "openVideoIn",
"reply": "openVideoIn",
"success": true
}
}Make a specific video device active in the switcher..
optional id to track this command, will be returned in the response
A specific channel index must be specified.
Name of the video device to open.
successful operation
bad request
GET /api/command/switchVideoIn HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*
{
"result": {
"command": "switchVideoIn",
"reply": "switchVideoIn",
"success": true
}
}Last updated