Variable Commands

assignVariable

get

Assign an input variable to a title variable..

Query parameters
requestIdstringOptional

optional id to track this command, will be returned in the response

idstringOptional

optional: UUID of title/layer to operate on

titlestringOptional

optional: Name (or UUID) of the title to operate on.

Example: Test
inputstringOptional

optional: Input name, used to select the title(s) to operate on

inputVarstringOptional

Name of the input variable.

titleVarstringOptional

Name of the title variable to connect input to.

Responses
200
successful operation
application/json
get
GET /api/command/assignVariable HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

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

setDynamic

get

Change the dynamic state of a specific title variable.

Query parameters
requestIdstringOptional

optional id to track this command, will be returned in the response

idstringOptional

optional: UUID of title/layer to operate on

titlestringOptional

optional: Name (or UUID) of the title to operate on.

Example: Test
channelnumberOptional

channel to query or -1 for all; channels are numbered from left to right starting at 0 regardless of their names in the project

Example: 0
variablestringOptional

name of the variable

Example: message
dynamicnumberOptional

1 to set to dynamic, 0 to set to static.

Example: 1
Responses
200
successful operation
application/json
get
GET /api/command/setDynamic HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "setDynamic",
    "reply": "setDynamic",
    "success": true
  }
}
PreviousTitle CommandsNextVideo Commands

Last updated