This document contains information that is proprietary and confidential to COMPANY_NAME. This document is provided to the recipient with the expressed understanding that the recipient will not divulge its contents to other parties or otherwise misappropriate the information contained herein.
Base URI | Description |
---|---|
http://[IP_ADDRESS]/api/LiveTaskNode | The root structure containing the whole configuration tree. |
http://[IP_ADDRESS]/api/LiveTaskNode/State | A structure containing the common configuration shared by all tasks |
http://[IP_ADDRESS]/api/LiveTaskNode/Tasks | A map of all tasks present within a specific transcoder. |
Base URI | Description |
---|---|
http://[IP_ADDRESS]/api/LiveManager/TemplateManager | The root structure containing the whole configuration tree. |
http://[IP_ADDRESS]/api/LiveManager/TemplateManager/DeviceCluster | A structure containing the list of devices used by the manager to deploy the tasks |
http://[IP_ADDRESS]/api/LiveManager/TemplateManager/MaskMap | A map of all presets as defined by the user |
http://[IP_ADDRESS]/api/LiveManager/TemplateManager/PartitionMap | A map of all services as defined by the user |
Base URI | Description |
---|---|
http://[IP_ADDRESS]/api/FileTaskNode | The root structure containing the whole configuration tree. |
http://[IP_ADDRESS]/api/FileTaskNode/State | A structure containing the common configuration shared by all tasks |
http://[IP_ADDRESS]/api/FileTaskNode/Tasks | A map of all tasks present within a specific transcoder. |
Base URI | Description |
---|---|
http://[IP_ADDRESS]/api/FileManager | The root structure containing the whole configuration tree. |
http://[IP_ADDRESS]/api/FileManager/TaskManager/TaskModels | A map of all task models that can be pushed |
http://[IP_ADDRESS]/api/FileManager/TaskManager/TaskModels/{model_id}/_state_/Settings | The settings of the tasks that can be pushed in the model {model_id} |
http://[IP_ADDRESS]/api/FileManager/TaskManager/TaskModels/{model_id}/_state_/Tasks | A map of tasks previously pushed for the model {model_id} |
http://[IP_ADDRESS]/api/FileManager/TaskManager/Assets | A map of all the assets that have been created by the tasks that have ended |
http://[IP_ADDRESS]/api/FileManager/TaskManager/Nodes | A structure containing the list of devices used by the manager to deploy the tasks |
http://[IP_ADDRESS]/api/FileManager/WatchFolderManager | A structure containing the configuration of the watch folders |
Base URI | Description |
---|---|
http://[IP_ADDRESS]/api/CatchupNode | The root structure containing the whole configuration tree. |
http://[IP_ADDRESS]/api/CatchupNode/State | A structure containing the common configuration shared by all tasks |
http://[IP_ADDRESS]/api/CatchupNode/Tasks | A map of all tasks present within a specific transcoder. |
Base URI | Description |
---|---|
http://[IP_ADDRESS]/api/CatchupManager | The root structure containing the whole configuration tree. |
http://[IP_ADDRESS]/api/CatchupManager/TaskManager/Masks | A map of all presets as defined by the user |
http://[IP_ADDRESS]/api/CatchupManager/TaskManager/TaskModels | A map of all task models that can be pushed |
http://[IP_ADDRESS]/api/CatchupManager/TaskManager/TaskModels/{model_id}/_state_/Settings | The settings of the tasks that can be pushed in the model {model_id} |
http://[IP_ADDRESS]/api/CatchupManager/TaskManager/TaskModels/{model_id}/_state_/Tasks | A map of tasks previously pushed for the model {model_id} |
http://[IP_ADDRESS]/api/CatchupManager/TaskManager/Assets | A map of all the assets that have been created by the tasks that have ended |
http://[IP_ADDRESS]/api/CatchupManager/TaskManager/Nodes | A structure containing the list of devices used by the manager to deploy the tasks |
Operation | Description | Rest HTTP mappings | Query String |
---|---|---|---|
get | Get a specific resource. | HTTP GET on a resource URI | |
load | Load a specific resource, ignoring errors. | HTTP POST on a resource URI | |
insert | Insert an element to a specific resource. | HTTP POST on a resource URI | ?insert |
delete | Delete an element of a specific resource. | HTTP DELETE on a resource URI | |
set | Set a specific resource, returning on first error. | HTTP POST on a resource URI | ?set |
desc | Return the description of the resource. | HTTP GET on a resource URI | ?desc |
elements | The number of elements that conform the map's content. | HTTP GET on a resource URI | ?elements |
size | The number of elements in the container. | HTTP GET on a resource URI | ?size |
call | Perform a call on the function located at this URI. | HTTP POST on a resource URI | ?call |
clear | Clear the resource. | HTTP POST on a resource URI | ?clear |
Resource type | get | load | set | desc | size | elements | call | clear | insert | delete |
---|---|---|---|---|---|---|---|---|---|---|
Int32 | X | X | X | X | ||||||
Int64 | X | X | X | X | ||||||
string | X | X | X | X | ||||||
bool | X | X | X | X | ||||||
struct | X | X | X | X | ||||||
vector | X | X | X | X | X | |||||
map | X | X | X | X | X | X | X | |||
function | X | X | ||||||||
file | X | X | X | X | X | |||||
enum | X | X | X | X |
Returned value | Description |
---|---|
STARTING | Task has received a play order |
WAITING_FOR_DATA | Task is waiting for intput data to process |
CODING | Tasl is processing data |
STOPPING | Task has received a stop order |
WAITING_FOR_PARSE_TS | Task is waiting for TS source to be parsed |
NO_OUTPUT_SERVER_CONNECTION | Task is waiting for publication server |
FINALIZING | Task is finalizing |
STARTING_ERROR | Task can't start |
CODING_ERROR | Error while processing data |
[ 1, 4, 5 ]
{ "Adapter" : 3, "EnableSsm" : { "_type_" : "false", "_value_" : { "false" : {} } }, "IpAddress" : "226.0.8.8", "Port" : 5009 }
Key | Type | Description |
---|---|---|
"First" | int32 | First event index |
"Last" | int32 | Last event index |
Key | Type | Description |
---|---|---|
"TeamMode" | int32 | Team mode (0 = no Team) |
"VlanTag" | int32 | VLAN tag number |
"PhysicalAdapters" | vector | Physical adapter number |
{ "TeamMode": 0 , "VlanTag":746 , "PhysicalAdapters":[3] }
Returned value | Description |
---|---|
1 | The interface is up and able to pass packets |
2 | The interface is down and not in a condition to pass packets |
3 | The interface is in testing mode |
4 | The operational status of the interface is unknown |
URI : http://[IP_ADDRESS]/api/LiveTaskNode/Tasks/X/_state_/Activation/_value_/ACTIVATED/
State/_value_/LIVE_CHANNEL_TASK/Status/CpuLoad
URI : http://[IP_ADDRESS]/api/LiveTaskNode/Tasks/X/_state_/Activation/_value_/ACTIVATED/
State/_value_/LIVE_CHANNEL_TASK/Status/ExtendedState
URI : http://[IP_ADDRESS]/api/LiveTaskNode/Tasks/X/_state_/Activation/_value_/ACTIVATED/
State/_value_/LIVE_CHANNEL_TASK/Status/StatusMessage