Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Title Commands

All commands found in this section are related to titles. Titles are individual graphic designs that display text, images, and other visual information.

closeDesigner

get
/api/command/closeDesigner

Close the title designer..

Responses
200

successful operation

application/json
get/api/command/closeDesigner
GET /api/command/closeDesigner HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

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

deleteTitle

get
/api/command/deleteTitle

Delete the requested title/layer.

Query parameters
requestIdstringOptional

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

idstringOptional

optional: UUID of title/layer to operate on

Example: {218f46f9-e881-49a8-ab17-03c8f9cc8461}
titlestringOptional

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

Responses
200

successful operation

application/json
get/api/command/deleteTitle
GET /api/command/deleteTitle HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "deleteTitle",
    "id": "{218f46f9-e881-49a8-ab17-03c8f9cc8461}",
    "reply": "deleteTitle",
    "success": true
  }
}

duplicateTitle

get
/api/command/duplicateTitle

Create a copy of the selected title/layer.

Query parameters
requestIdstringOptional

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

idstringOptional

optional: UUID of title/layer to operate on

Example: {218f46f9-e881-49a8-ab17-03c8f9cc8461}
titlestringOptional

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

newIdstringOptional

Optional ID to assign to the new title

Example: {85DB25322-F9BF-4D40-AC16-85DB05E21BF8}
newNamestringOptional

Optional name to give the title

Example: New Title Name
newPositionnumberOptional

Optional position in the list

Example: 2
channelnumberOptional

Channel to use for title

Example: 0
Responses
200

successful operation

application/json
get/api/command/duplicateTitle
GET /api/command/duplicateTitle HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "duplicateTitle",
    "id": "{954d679e-9977-43eb-96ce-83f122b0d786}",
    "reply": "duplicateTitle",
    "success": true,
    "title": "New+Title+Name"
  }
}

getTimelineDuration

get
/api/command/getTimelineDuration

get the duration of the graphic timeline attached to this title.

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: Title Name
Responses
200

successful operation

application/json
get/api/command/getTimelineDuration
GET /api/command/getTimelineDuration HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "getTimelineDuration",
    "error": "unable to find title from 'title' or 'id' attributes",
    "reply": "getTimelineDuration",
    "success": true
  }
}

loadTitle

get
/api/command/loadTitle

Load a title from file, and optionally give it a new name, position, and id.

Query parameters
requestIdstringOptional

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

filestringOptional

File to load the title from. Ends with .nbtitle

Example: c:\desktop\dot2.nbtitle
newIdstringOptional

Optional ID to assign to the title

Example: {85DB25322-F9BF-4D40-AC16-85DB05E21BF8}
newNamestringOptional

Optional name to give the title

Example: Title Name
newPositionnumberOptional

Optional position in the list

Example: 2
channelnumberOptional

Channel of list

Example: 1
Responses
200

successful operation

application/json
get/api/command/loadTitle
GET /api/command/loadTitle HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

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

newTitle

get
/api/command/newTitle

Create a new title/layer.

Query parameters
requestIdstringOptional

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

newIdstringOptional

Optional ID to assign to the title

Example: {85DB25322-F9BF-4D40-AC16-85DB05E21BF8}
newNamestringOptional

Optional name to give the title

Example: Title Name
newPositionnumberOptional

Optional position in the list

Example: 2
channelnumberOptional

Channel to use for title

Example: 1
Responses
200

successful operation

application/json
get/api/command/newTitle
GET /api/command/newTitle HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

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

openDesigner

get
/api/command/openDesigner

Open the title designer with the requested title..

Query parameters
requestIdstringOptional

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

idstringOptional

optional: UUID of title/layer to operate on

Example: {218f46f9-e881-49a8-ab17-03c8f9cc8461}
titlestringOptional

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

Responses
200

successful operation

application/json
get/api/command/openDesigner
GET /api/command/openDesigner HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "openDesigner",
    "id": "{218f46f9-e881-49a8-ab17-03c8f9cc8461}",
    "reply": "openDesigner",
    "success": true
  }
}

saveTitle

get
/api/command/saveTitle

Save the selected title to file.

Query parameters
requestIdstringOptional

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

idstringOptional

optional: UUID of title/layer to operate on

Example: {218f46f9-e881-49a8-ab17-03c8f9cc8461}
titlestringOptional

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

filestringOptional

File path to save to. Ends with .nbtitle

Example: c:\desktop\dot2.nbtitle
channelnumberOptional

Channel of title

Example: 1
Responses
200

successful operation

application/json
get/api/command/saveTitle
GET /api/command/saveTitle HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "saveTitle",
    "id": "{218f46f9-e881-49a8-ab17-03c8f9cc8461}",
    "reply": "saveTitle",
    "success": true
  }
}

selectTitle

get
/api/command/selectTitle

same as clicking on the title in the UI.

Query parameters
requestIdstringOptional

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

titlestringOptional

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

Example: Title Name
Responses
200

successful operation

application/json
get/api/command/selectTitle
GET /api/command/selectTitle HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "selectTitle",
    "error": "No such title name",
    "reply": "selectTitle",
    "success": true
  }
}

setTitleInput

get
/api/command/setTitleInput

Assign an input to the title.

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

Example: inputName
mergestringOptional

when 1, the new input will be combined with existing inputs on the title

Responses
200

successful operation

application/json
get/api/command/setTitleInput
GET /api/command/setTitleInput HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

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

removeTitleInput

get
/api/command/removeTitleInput

Remove an input from the title.

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. Either title name or id are required.

Example: Test
inputstringRequired

required: Input name to remove from the title.

Example: inputName
Responses
200

successful operation

application/json
get/api/command/removeTitleInput
GET /api/command/removeTitleInput?input=text HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

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

setTitleName

get
/api/command/setTitleName

Assign a new name to the title. The title can be selected by either id or title name.

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: Current Name
newNamestringOptional

new name for the title/layer

Example: New Name
Responses
200

successful operation

application/json
get/api/command/setTitleName
GET /api/command/setTitleName HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "setTitleName",
    "error": "no title found.",
    "reply": "setTitleName",
    "success": true
  }
}

setTitlePosition

get
/api/command/setTitlePosition

Reposition a title in the list.

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
positionnumberOptional

Desired location in play list

Example: 3
Responses
200

successful operation

application/json
get/api/command/setTitlePosition
GET /api/command/setTitlePosition HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "setTitlePosition",
    "reply": "setTitlePosition",
    "success": true
  }
}
PreviousStatus InformationNextVariable Commands

Last updated