Supported input protocols: FTP, Webdav, SMB
Video encoding panel full documentation is available here.
Supported publication protocols: FTP, HTTP, Webdav
# | Description | HTTP Verb | URL | Argument | Returned value |
---|---|---|---|---|---|
1 | Get tasks indexes | GET | http://[IP_ADDRESS]/api/FileTaskNode/Tasks?elements | N/A | Comma-separated list of task indexes
[ 1, 2, 3 ] |
2 | Disable the task | POST | http://[IP_ADDRESS]/api/FileTaskNode/Tasks/[TASK_INDEX]/_state_/Activation/_type_ | "DEACTIVATED" | "" |
3 | Get file input settings | GET | http://[IP_ADDRESS]/api/FileTaskNode/Tasks/[TASK_INDEX]/_state_/Config/ Input/InputMode/_value_/TS_FILE/ |
N/A | JSON structure of file input settings
{ "Address" : "10.1.100.3", "Login" : "login", "Password" : "password", "Path" : "f2f_in/columbiana-tlr1_h1080p.mov", "Protocol" : "FTP_PASSIVE" } |
4 | Edit JSON structure and change file input settings | ||||
5 | Post file input settings | POST | http://[IP_ADDRESS]/api/FileTaskNode/Tasks/[TASK_INDEX]/_state_/Config/ Input/InputMode/_value_/TS_FILE/ |
Updated JSON structure of file input settings
{ "Address" : "10.1.100.3", "Login" : "login", "Password" : "password", "Path" : "f2f_in/cinderella-tlr2_h1080p.mp4", "Protocol" : "FTP_PASSIVE" } |
"" |
6 | Get file output settings | GET | http://[IP_ADDRESS]/api/FileTaskNode/Tasks/[TASK_INDEX]/_state_/Config/ Output/OutputMode/_value_/OTT/PublishingPoints/1 |
N/A | JSON structure of file input settings
{ "Address" : "10.1.100.3", "BaseDir" : "f2f_out", "GetAvailableProtocols" : null, "Login" : "login", "Password" : "password", "Protocol" : "FTP_PASSIVE", "Proxy" : "", "ProxyLogin" : "", "ProxyPassword" : "", "ProxyPort" : 0, "Status" : { "AtomicUpload" : "UNKNOWN", "Connection" : "UNKNOWN" }, "WebDavCompatibilityMode" : "GENERIC" } |
7 | Edit JSON structure and change file output settings | ||||
8 | Post file output settings | POST | http://[IP_ADDRESS]/api/FileTaskNode/Tasks/[TASK_INDEX]/_state_/Config/ Output/OutputMode/_value_/OTT/PublishingPoints/1 |
Updated JSON structure of file output settings
{ "Address" : "10.1.100.3", "BaseDir" : "f2f_out", "GetAvailableProtocols" : null, "Login" : "login", "Password" : "password", "Protocol" : "FTP_PASSIVE", "Proxy" : "", "ProxyLogin" : "", "ProxyPassword" : "", "ProxyPort" : 0, "Status" : { "AtomicUpload" : "UNKNOWN", "Connection" : "UNKNOWN" }, "WebDavCompatibilityMode" : "GENERIC" } |
"" |
9 | Enable the task | POST | http://[IP_ADDRESS]/api/FileTaskNode/Tasks/[TASK_INDEX]/_state_/Activation/_type_ | "ACTIVATED" | "" |
10 | Get task progress | GET | http://[IP_ADDRESS]/api/FileTaskNode/Tasks/[TASK_INDEX]/_state_/Activation/ _value_/ACTIVATED/State/_value_/FILE_TO_FILE_TASK/Progress |
N/A | Task progress in % from 0 to 100. |
12 | Get task status | GET | http://[IP_ADDRESS]/api/FileTaskNode/Tasks/[TASK_INDEX]/_state_/Activation/ _value_/ACTIVATED/State/_value_/FILE_TO_FILE_TASK/CoderState |
N/A | Task status: Starting, Running, Finished |