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.
Delete the requested title/layer.
optional id to track this command, will be returned in the response
optional: UUID of title/layer to operate on
{218f46f9-e881-49a8-ab17-03c8f9cc8461}optional: Name (or UUID) of the title to operate on.
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
}
}Create a copy of the selected title/layer.
optional id to track this command, will be returned in the response
optional: UUID of title/layer to operate on
{218f46f9-e881-49a8-ab17-03c8f9cc8461}optional: Name (or UUID) of the title to operate on.
Optional ID to assign to the new title
{85DB25322-F9BF-4D40-AC16-85DB05E21BF8}Optional name to give the title
New Title NameOptional position in the list
2Channel to use for title
0GET /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"
}
}get the duration of the graphic timeline attached to this title.
optional id to track this command, will be returned in the response
optional: UUID of title/layer to operate on
optional: Name (or UUID) of the title to operate on.
Title NameGET /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
}
}Load a title from file, and optionally give it a new name, position, and id.
optional id to track this command, will be returned in the response
File to load the title from. Ends with .nbtitle
c:\desktop\dot2.nbtitleOptional ID to assign to the title
{85DB25322-F9BF-4D40-AC16-85DB05E21BF8}Optional name to give the title
Title NameOptional position in the list
2Channel of list
1GET /api/command/loadTitle HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*
{
"result": {
"command": "loadTitle",
"reply": "loadTitle",
"success": true
}
}Create a new title/layer.
optional id to track this command, will be returned in the response
Optional ID to assign to the title
{85DB25322-F9BF-4D40-AC16-85DB05E21BF8}Optional name to give the title
Title NameOptional position in the list
2Channel to use for title
1GET /api/command/newTitle HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*
{
"result": {
"command": "newTitle",
"reply": "newTitle",
"success": true
}
}Open the title designer with the requested title..
optional id to track this command, will be returned in the response
optional: UUID of title/layer to operate on
{218f46f9-e881-49a8-ab17-03c8f9cc8461}optional: Name (or UUID) of the title to operate on.
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
}
}Save the selected title to file.
optional id to track this command, will be returned in the response
optional: UUID of title/layer to operate on
{218f46f9-e881-49a8-ab17-03c8f9cc8461}optional: Name (or UUID) of the title to operate on.
File path to save to. Ends with .nbtitle
c:\desktop\dot2.nbtitleChannel of title
1GET /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
}
}same as clicking on the title in the UI.
optional id to track this command, will be returned in the response
optional: Name (or UUID) of the title to operate on.
Title NameGET /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
}
}Assign an input to the title.
optional id to track this command, will be returned in the response
optional: UUID of title/layer to operate on
optional: Name (or UUID) of the title to operate on.
Testoptional: Input name, used to select the title(s) to operate on
inputNamewhen 1, the new input will be combined with existing inputs on the title
GET /api/command/setTitleInput HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*
{
"result": {
"command": "setTitleInput",
"reply": "setTitleInput",
"success": true
}
}Assign a new name to the title. The title can be selected by either id or title name.
optional id to track this command, will be returned in the response
optional: UUID of title/layer to operate on
optional: Name (or UUID) of the title to operate on.
Current Namenew name for the title/layer
New NameGET /api/command/setTitleName HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*
{
"result": {
"command": "setTitleName",
"error": "no title found.",
"reply": "setTitleName",
"success": true
}
}Reposition a title in the list.
optional id to track this command, will be returned in the response
optional: UUID of title/layer to operate on
optional: Name (or UUID) of the title to operate on.
TestDesired location in play list
3GET /api/command/setTitlePosition HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*
{
"result": {
"command": "setTitlePosition",
"reply": "setTitlePosition",
"success": true
}
}Last updated