file_software - Quick Start Guide

Table of contents

  1. Supported inputs
  2. "File to file encoding" task creation
    1. "File" function creation
    2. Task creation
  3. "File to file encoding" task configuration
    1. Input settings
    2. Video encoding settings
    3. Audio encoding settings
    4. Output settings
  4. "File to file encoding" task operation
    1. Task startup
    2. Task progress monitoring
    3. Task stop
  5. "File to file encoding" task management from HTTP RestFULL API
  1. Supported inputs

  2. "File to file encoding" task creation

    1. "File" function creation

      To create a "File" function, click-on "Device" button and open "Functions" panel. Click on "Insert" button" and add "File Task Node" function.


      Enable "File Task Node" function and refresh your web browser.

    2. Task creation

      To create a new task, click on "File Tasks" button, select "Tasks Map" in the list and click on "New" button.

      Give a name to the new task.

  3. "File to file encoding" task configuration

    1. Input settings

      In "Input" panel, configure input file parameters.

      Supported input protocols: FTP, Webdav, SMB


    2. Video encoding settings

      In "Video" panel, select desired video codec.
      In "Video" > "Video profiles" panel, configure video encoding settings.

      Video encoding panel full documentation is available here.

    3. Audio encoding settings

      In "Audio" panel, configure audio encoding settings.

    4. Output settings

      In "Output" panel, configure desired packaging mode:

      Supported publication protocols: FTP, HTTP, Webdav

  4. "File to file encoding" task operation

    1. Task startup

      Select "Tasks Map" in the list, select the task to start and click on "Enable" button.
    2. Task progress monitoring

      In "Operation" > "Status" panel, monitor task status and progress.
    3. Task stop

      Select "Tasks Map" in the list, select the task to start and click on "Disable" button.
  5. "File to file encoding" task management from HTTP RestFULL API

    Once the task canvas is created with the WebGUI, it can be reused very easily with company_name HTTP RestFUL API to automize tasks editing and operations.
    In the table below is detailed step by step procedure to update input and output file settings and start "File to File encoding" tasks from the API.
    # 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