Skip to main content
Top

REST API Documentation

nablet Support Team
  • Updated
This is a sample server for the nablet mediaEngine REST API. You can find out more here. For this sample, you can use the API-Token special-key to test the authorization filters.

Access

  1. HTTP Basic Authentication
  2. APIKey Key
    ParamName: API-Token
    KeyInQuery: false
    KeyInHeader: true

Methods

Authentication

Presets

Version

Workers

Authentication

get /auth
Returns an API access token after successful login (authGet)
 

Return type

auth

Example data

Content-Type: application/json
{
  "data" : {
    "expires" : 1684427563,
    "neverExpires" : true,
    "product" : "nablet mediaEngine",
    "token" : "*******",
    "version" : "v3.0.0"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK auth

400

MIME type not accepted

401

Unauthorized access

Presets

get /presets/builtIn/{folder}/{name}
Get a built-in or user preset from the database (presetsBuiltInFolderNameGet)
 

Path parameters

folder (required)
Path Parameter — A folder path name for the preset
name (required)
Path Parameter — A preset name for the preset

Return type

mediaEnginePreset

Example data

Content-Type: application/json
{
  "muxer_stream_count" : 6.027456183070403,
  "video_stream_settings" : [ "", "" ],
  "video_stream_count" : 2.3021358869347655,
  "writing_application" : "writing_application",
  "writing_application_date" : "writing_application_date",
  "writing_application_version" : "writing_application_version",
  "audio_stream_count" : 0.8008281904610115,
  "output_stream_count" : 1.4658129805029452,
  "preset_info" : {
    "valid_framerate_count" : 5.637376656633329,
    "valid_container_format_count" : 5.962133916683182,
    "comment" : "comment",
    "valid_container_formats" : [ "", "" ],
    "display_name" : "display_name"
  },
  "transcoder_settings" : {
    "match_source_streams" : true
  },
  "audio_stream_settings" : [ "", "" ],
  "output_stream_settings" : [ "", "" ],
  "muxer_stream_settings" : [ "", "" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
  • text/plain
  • text/html

Responses

200

OK mediaEnginePreset

400

Bad request

401

Unauthorized access

404

Not found
get /presets
Returns the built-in and/or user presets as list of path objects (presetsGet)
 

Query parameters

builtin (optional)
Query Parameter —
user (optional)
Query Parameter —

Return type

presets

Example data

Content-Type: application/json
{
  "presets" : [ {
    "created" : "2023-12-15T13:41:20.625Z",
    "displayName" : "DNxHD 110x 720p29.97",
    "folder" : "avid",
    "href" : "/api/v1/preset/avid/dnxhd-110x-720p2997",
    "name" : "dnxhd-110x-720p2997",
    "sdkVersion" : "v3.0.14",
    "type" : "built-in"
  }, {
    "created" : "2023-11-26T00:43:19.665Z",
    "displayName" : "Beta 4444 DNxHD",
    "folder" : "Avid",
    "href" : "/api/v1/preset/user/Avid/Beta_4444_DNxHD",
    "name" : "Beta_4444_DNxHD",
    "sdkVersion" : "v3.0.14",
    "type" : "user"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK presets

400

Bad request

401

Unauthorized access
delete /presets/user/{folder}/{name}
Remove user preset from the database (presetsUserFolderNameDelete)
 

Path parameters

folder (required)
Path Parameter — A folder path name for the user preset
name (required)
Path Parameter — A preset name for the user preset

Query parameters

removeEmptyFolder (optional)
Query Parameter — If set to 'true' the folder will be removed from the database if it doesn't contain any no other presets

Return type

inline_response_200

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK inline_response_200

400

Bad request

401

Unauthorized access

404

Not found
get /presets/user/{folder}/{name}
Get a user preset from the database (presetsUserFolderNameGet)
 

Path parameters

folder (required)
Path Parameter — A folder path name for the preset
name (required)
Path Parameter — A preset name for the preset

Return type

mediaEnginePreset

Example data

Content-Type: application/json
{
  "muxer_stream_count" : 6.027456183070403,
  "video_stream_settings" : [ "", "" ],
  "video_stream_count" : 2.3021358869347655,
  "writing_application" : "writing_application",
  "writing_application_date" : "writing_application_date",
  "writing_application_version" : "writing_application_version",
  "audio_stream_count" : 0.8008281904610115,
  "output_stream_count" : 1.4658129805029452,
  "preset_info" : {
    "valid_framerate_count" : 5.637376656633329,
    "valid_container_format_count" : 5.962133916683182,
    "comment" : "comment",
    "valid_container_formats" : [ "", "" ],
    "display_name" : "display_name"
  },
  "transcoder_settings" : {
    "match_source_streams" : true
  },
  "audio_stream_settings" : [ "", "" ],
  "output_stream_settings" : [ "", "" ],
  "muxer_stream_settings" : [ "", "" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
  • text/plain

Responses

200

OK mediaEnginePreset

400

Bad request

401

Unauthorized access

404

Not found
post /presets/user/{folder}/{name}
Save a user preset in the database (presetsUserFolderNamePost)

Adding a mediaEngine Preset

There are two ways to a preset to the database: a) using a converted JSON preset or b) using a text/plain preset directly. For converting a text/plain preset to JSON you can use the 'cfgconverter' from the mediaEngine SDK:

cfgconverter -j -i mypreset.txt -co mypreset.json

For more furher information about the cmd-line options please call 'cfgconverter' with the help (-h/--help) argument.

Path parameters

folder (required)
Path Parameter — A folder path name for the user preset
name (required)
Path Parameter — A preset name for the user preset

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • text/plain

Request body

body mediaEnginePreset (optional)
Body Parameter —

Return type

inline_response_200

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK inline_response_200

400

Bad request

401

Unauthorized access

409

Conflict
put /presets/user/{folder}/{name}
Update a user preset (presetsUserFolderNamePut)
 

Path parameters

folder (required)
Path Parameter — A folder path name for the user preset
name (required)
Path Parameter — A preset name for the user preset

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • text/plain

Request body

body updatePreset (optional)
Body Parameter —

Return type

inline_response_200

Example data

Content-Type: application/json
{
  "status" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK inline_response_200

400

Bad request

401

Unauthorized access

404

Not found

Version

get /version
Returns the mediaEngine version numbers (versionGet)
 

Return type

version

Example data

Content-Type: application/json
{
  "data" : {
    "coreDLLBuildDate" : "11/29/2023 01:11:01",
    "coreDLLVersion" : "v3.0.4",
    "coreSDKVersion" : "v3.0.4",
    "meDLLBuildDate" : "11/29/2023 01:10:57",
    "meDLLVersion" : "v3.0.3",
    "meSDKVersion" : "v3.0.3",
    "product" : "nablet mediaEngine REST server"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK version

401

Unauthorized access

Workers

delete /workers/findByFilter
Remove one or more stopped jobs from the database and erase their stored data with filters (workersFindByFilterDelete)
 

Query parameters

date (optional)
Query Parameter — Filter for the exact ISO date format: date-time
date_lt (optional)
Query Parameter — Filter for items less than this ISO date format: date-time
date_gt (optional)
Query Parameter — Filter for items greater than this ISO date format: date-time
date_lte (optional)
Query Parameter — Filter for items less or equal than this ISO date format: date-time
date_gte (optional)
Query Parameter — Filter for items greater or equal than this ISO date format: date-time
date_ne (optional)
Query Parameter — Filter for items not equal to this ISO date format: date-time

Responses

200

OK

401

Unauthorized access

404

Not found
get /workers/findByFilter
Returns one or more workers job list (workersFindByFilterGet)
 

Query parameters

offset (optional)
Query Parameter — The number of items to skip before starting to collect the result set
limit (optional)
Query Parameter — The numbers of items to return
order (optional)
Query Parameter — <p>Sort order:</p> <ul> <li><code>asc</code> - Ascending</li> <li><code>desc</code> - Descending</li> </ul>
details (optional)
Query Parameter — Enable or disable show details like stats
date (optional)
Query Parameter — Filter for the exact ISO date format: date-time
date_lt (optional)
Query Parameter — Filter for items less than this ISO date format: date-time
date_gt (optional)
Query Parameter — Filter for items greater than this ISO date format: date-time
date_lte (optional)
Query Parameter — Filter for items less or equal than this ISO date format: date-time
date_gte (optional)
Query Parameter — Filter for items greater or equal than this ISO date format: date-time
date_ne (optional)
Query Parameter — Filter for items not equal to this ISO date format: date-time
onlyIDs (optional)
Query Parameter — If enabled only IDs are listed in an array

Responses

200

OK

400

Bad request

401

Unauthorized access

404

Not found
get /workers/info/{id}
Get worker or job information (workersInfoIdGet)
 

Path parameters

id (required)
Path Parameter — The 12-byte field (hexadecimal) job ID or the keyword 'last'

Return type

array[workerInfo]

Example data

Content-Type: application/json
[ {
  "inputConfiguration" : {
    "application" : "transcode",
    "processOptions" : {
      "kubernetes" : { },
      "maxMemoryLimit" : 6,
      "visibility" : "server",
      "linux" : { },
      "forcedShutdownTimeout" : 5000,
      "cpuSet" : "0-4,7,9-11",
      "windows" : {
        "jobUserTimeLimitMs" : 1.4658129805029452,
        "propagateOnChildProcesses" : true,
        "priorityClass" : "normal",
        "processUserTimeLimitMs" : 5.962133916683182
      },
      "clockTimeLimitMs" : 0.8008281904610115,
      "docker" : { }
    },
    "inputSources" : [ "", "" ],
    "applicationArgs" : [ "-sw" ],
    "config" : {
      "preset" : "/preset/avid/dnxhd-115-720p50",
      "customPreset" : { }
    },
    "outputPaths" : [ "S:\\test.mxf", "S:\\test.mxf" ]
  },
  "product" : "nablet mediaEngine",
  "processorTime" : 0,
  "statsURL" : "ws://127.0.0.1:43211",
  "exitCode" : -1,
  "pid" : 52084,
  "id" : "65629821692375e86c067611",
  "state" : "running",
  "commandLine" : "../transcode -i   -o ",
  "version" : "v3.0.3"
}, {
  "inputConfiguration" : {
    "application" : "transcode",
    "processOptions" : {
      "kubernetes" : { },
      "maxMemoryLimit" : 6,
      "visibility" : "server",
      "linux" : { },
      "forcedShutdownTimeout" : 5000,
      "cpuSet" : "0-4,7,9-11",
      "windows" : {
        "jobUserTimeLimitMs" : 1.4658129805029452,
        "propagateOnChildProcesses" : true,
        "priorityClass" : "normal",
        "processUserTimeLimitMs" : 5.962133916683182
      },
      "clockTimeLimitMs" : 0.8008281904610115,
      "docker" : { }
    },
    "inputSources" : [ "", "" ],
    "applicationArgs" : [ "-sw" ],
    "config" : {
      "preset" : "/preset/avid/dnxhd-115-720p50",
      "customPreset" : { }
    },
    "outputPaths" : [ "S:\\test.mxf", "S:\\test.mxf" ]
  },
  "product" : "nablet mediaEngine",
  "processorTime" : 0,
  "statsURL" : "ws://127.0.0.1:43211",
  "exitCode" : -1,
  "pid" : 52084,
  "id" : "65629821692375e86c067611",
  "state" : "running",
  "commandLine" : "../transcode -i   -o ",
  "version" : "v3.0.3"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK

401

Unauthorized access

404

Not found
get /workers/log/{id}
Get worker or job log file (workersLogIdGet)
 

Path parameters

id (required)
Path Parameter — The 12-byte field (hexadecimal) job ID or the keyword 'last'

Return type

String

Example data

Content-Type: application/json
"12/02/2023 17:40:40.438 [37284] info: nbmecore: ********************************************************************************\n12/02/2023 17:40:40.438 [37284] info: nbmecore: nablet MediaEngine Core\n12/02/2023 17:40:40.438 [37284] info: nbmecore: SDK Version: 3.0.4.0 (11/29/2023 01:11:01)\n12/02/2023 17:40:40.438 [37284] info: nbmecore: DLL Version: 3.0.4.0 (11/29/2023 01:11:01)\n12/02/2023 17:40:40.438 [37284] info: nbmecore: Windows Version: 6.02.9200\n12/02/2023 17:40:40.438 [37284] info: nbmecore: CPU: Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz, Active CPUs: 5\n12/02/2023 17:40:40.438 [37284] info: nbmecore: Host: NV-AVX02-PC\n12/02/2023 17:40:40.438 [37284] info: nbmecore: Application: 'transcode' v3.0.3\n12/02/2023 17:40:40.438 [37284] info: nbmecore: \n12/02/2023 17:40:40.438 [37284] info: nbmecore: Date: 12/02/2023 18:40:40.438 [+1:00]\n12/02/2023 17:40:40.438 [37284] info: nbmecore: ********************************************************************************\n12/02/2023 17:40:40.438 [37284] info: nbmecore: \n12/02/2023 17:40:40.439 [37284] info: nbmecore: ***************************************\n12/02/2023 17:40:40.439 [37284] info: nbmecore: TraceSetLevel=0\n12/02/2023 17:40:40.439 [37284] info: nbmecore: DebugSetLevel=5\n12/02/2023 17:40:40.439 [37284] info: nbmecore: InfoSetLevel=5\n12/02/2023 17:40:40.439 [37284] info: nbmecore: WarningSetLevel=5\n12/02/2023 17:40:40.439 [37284] info: nbmecore: ***************************************\n12/02/2023 17:40:40.439 [37284] info: nbmecore: initializing core library\n...\n"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain

Responses

200

OK String

401

Unauthorized access

404

Not found
post /workers
Creates a worker which performs a new job (workersPost)

Process Options

Common Options

forcedShutdownTimeout - Time to wait for a shutdown event to finish.

cpuSet - Sets the CPUs for this job, e.g. 0-4,7,9-11.

clockTimeLimitMs - Time limit for the job in ms or '0' for no limit.

maxMemoryLimit - Maximum memory usage for worker in bytes (currently, only supported on Windows).  visibility - Determines if the worker should show in a console window or not. Allowed values are 'normal', 'minimized', 'hidden' and 'server'.|

Windows Options

priorityClass - Causes all worker processes associated with the job to use the same priority class. Allowed values are 'aboveNormal', 'belowNormal', 'high', 'idle', 'normal', 'realtime'.

jobUserTimeLimitMs - Establishes a user-mode execution time limit in ms for the job. 

processUserTimeLimitMs - Establishes a user-mode execution time limit in ms for each currently active process and for all future processes associated with the job. 

propagateOnChildProcesses -Allows any process associated with the job to create child processes that are not associated with the job. 

Docker Options

Not available yet. 

Kubernetes Options

Not available yet. 

Application Settings

application - The application name, currently only 'transcode' is supported.

applicationArgs - List of cmd-line options (please use carefully, can change in the future). 

Configuration Settings

preset - Link to built-in preset.

customPreset - Optional customer preset in mediaEngine preset JSON format. 

Input Sources

inputSources - Array of input sources which can be URLs, file paths or RAW video/audio. 

Input Source Types

path - A path to an input file reachable by the server (local file system)

url - A URL either using a network path or a device specific syntax (e.g. DeckLink)

raw-video - A raw video file (see also JSON schema)

raw-audio - A raw (PCM) audio file (see also JSON schema) 

Output Paths

outputPaths - Array of output paths which can be URLs or file paths. 

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body inputConfiguration (optional)
Body Parameter —

Return type

array[workerInfo]

Example data

Content-Type: application/json
[ {
  "inputConfiguration" : {
    "application" : "transcode",
    "processOptions" : {
      "kubernetes" : { },
      "maxMemoryLimit" : 6,
      "visibility" : "server",
      "linux" : { },
      "forcedShutdownTimeout" : 5000,
      "cpuSet" : "0-4,7,9-11",
      "windows" : {
        "jobUserTimeLimitMs" : 1.4658129805029452,
        "propagateOnChildProcesses" : true,
        "priorityClass" : "normal",
        "processUserTimeLimitMs" : 5.962133916683182
      },
      "clockTimeLimitMs" : 0.8008281904610115,
      "docker" : { }
    },
    "inputSources" : [ "", "" ],
    "applicationArgs" : [ "-sw" ],
    "config" : {
      "preset" : "/preset/avid/dnxhd-115-720p50",
      "customPreset" : { }
    },
    "outputPaths" : [ "S:\\test.mxf", "S:\\test.mxf" ]
  },
  "product" : "nablet mediaEngine",
  "processorTime" : 0,
  "statsURL" : "ws://127.0.0.1:43211",
  "exitCode" : -1,
  "pid" : 52084,
  "id" : "65629821692375e86c067611",
  "state" : "running",
  "commandLine" : "../transcode -i   -o ",
  "version" : "v3.0.3"
}, {
  "inputConfiguration" : {
    "application" : "transcode",
    "processOptions" : {
      "kubernetes" : { },
      "maxMemoryLimit" : 6,
      "visibility" : "server",
      "linux" : { },
      "forcedShutdownTimeout" : 5000,
      "cpuSet" : "0-4,7,9-11",
      "windows" : {
        "jobUserTimeLimitMs" : 1.4658129805029452,
        "propagateOnChildProcesses" : true,
        "priorityClass" : "normal",
        "processUserTimeLimitMs" : 5.962133916683182
      },
      "clockTimeLimitMs" : 0.8008281904610115,
      "docker" : { }
    },
    "inputSources" : [ "", "" ],
    "applicationArgs" : [ "-sw" ],
    "config" : {
      "preset" : "/preset/avid/dnxhd-115-720p50",
      "customPreset" : { }
    },
    "outputPaths" : [ "S:\\test.mxf", "S:\\test.mxf" ]
  },
  "product" : "nablet mediaEngine",
  "processorTime" : 0,
  "statsURL" : "ws://127.0.0.1:43211",
  "exitCode" : -1,
  "pid" : 52084,
  "id" : "65629821692375e86c067611",
  "state" : "running",
  "commandLine" : "../transcode -i   -o ",
  "version" : "v3.0.3"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK

400

Bad request

401

Unauthorized access
delete /workers/remove/{id}
Remove a terminated job from the database and erase it's stored data (workersRemoveIdDelete)
 

Path parameters

id (required)
Path Parameter — The 12-byte field (hexadecimal) job ID or the keyword 'last'

Responses

200

OK

401

Unauthorized access

404

Not found
get /workers/stats/{id}
Get worker or job stats (workersStatsIdGet)
 

Path parameters

id (required)
Path Parameter — The 12-byte field (hexadecimal) job ID or the keyword 'last'

Return type

array[stats]

Example data

Content-Type: application/json
[ {
  "processInfo" : {
    "estimatedTime" : {
      "ms" : 89484.73976845638,
      "timecode" : "00:01:29.484"
    },
    "timeElapsed" : {
      "ms" : 15461.1197,
      "timecode" : "00:00:15.461"
    },
    "stats" : {
      "framerateN" : 2997,
      "totalInputDropFrameCount" : 0,
      "currentFPS" : 29.63742866409841,
      "currentFramesRendered" : 456,
      "currentMediaPosition" : {
        "27Mhz" : 0,
        "timecode" : "--:--:--.---"
      },
      "streamingMode" : false,
      "totalInputFramesCount" : 3337,
      "totalJobs" : 1,
      "currentJobDonePercent" : 14,
      "currentInputFrames" : 0,
      "maxFPS" : 38.3387365392696,
      "totalFramesPerJob" : 3337,
      "outputStreamStatsCount" : 0,
      "minFPS" : 26.781398176454644,
      "averageFPS" : 32.19543362873544,
      "currentJobsIndex" : 0,
      "framerateD" : 125,
      "outputStreamStats" : [ ],
      "totalFramesRendered" : 0,
      "totalMediaDuration" : {
        "27Mhz" : 3757882896,
        "timecode" : "00:02:19.180"
      }
    },
    "message" : "",
    "status" : "job finished"
  },
  "product" : "nablet mediaEngine",
  "processorTime" : 0,
  "exitCode" : 0,
  "pid" : 45036,
  "id" : "65629821692375e86c067611",
  "state" : "terminated",
  "version" : "v3.0.3"
}, {
  "processInfo" : {
    "estimatedTime" : {
      "ms" : 89484.73976845638,
      "timecode" : "00:01:29.484"
    },
    "timeElapsed" : {
      "ms" : 15461.1197,
      "timecode" : "00:00:15.461"
    },
    "stats" : {
      "framerateN" : 2997,
      "totalInputDropFrameCount" : 0,
      "currentFPS" : 29.63742866409841,
      "currentFramesRendered" : 456,
      "currentMediaPosition" : {
        "27Mhz" : 0,
        "timecode" : "--:--:--.---"
      },
      "streamingMode" : false,
      "totalInputFramesCount" : 3337,
      "totalJobs" : 1,
      "currentJobDonePercent" : 14,
      "currentInputFrames" : 0,
      "maxFPS" : 38.3387365392696,
      "totalFramesPerJob" : 3337,
      "outputStreamStatsCount" : 0,
      "minFPS" : 26.781398176454644,
      "averageFPS" : 32.19543362873544,
      "currentJobsIndex" : 0,
      "framerateD" : 125,
      "outputStreamStats" : [ ],
      "totalFramesRendered" : 0,
      "totalMediaDuration" : {
        "27Mhz" : 3757882896,
        "timecode" : "00:02:19.180"
      }
    },
    "message" : "",
    "status" : "job finished"
  },
  "product" : "nablet mediaEngine",
  "processorTime" : 0,
  "exitCode" : 0,
  "pid" : 45036,
  "id" : "65629821692375e86c067611",
  "state" : "terminated",
  "version" : "v3.0.3"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK

401

Unauthorized access

404

Not found
put /workers/terminate/{id}
Terminate one running worker (workersTerminateIdPut)
 

Path parameters

id (required)
Path Parameter — The 12-byte field (hexadecimal) job ID or the keyword 'last'

Responses

200

OK

401

Unauthorized access

404

Not found

Models

  1. auth
  2. auth_data
  3. inline_response_200
  4. inputConfiguration
  5. inputConfiguration_config
  6. inputConfiguration_processOptions
  7. inputConfiguration_processOptions_windows
  8. mediaEnginePreset
  9. mediaEnginePreset_preset_info
  10. mediaEnginePreset_transcoder_settings
  11. preset-count
  12. presetcount_builtIn
  13. presets
  14. stats
  15. stats_processInfo
  16. stats_processInfo_estimatedTime
  17. stats_processInfo_stats
  18. stats_processInfo_stats_currentMediaPosition
  19. stats_processInfo_stats_totalMediaDuration
  20. stats_processInfo_timeElapsed
  21. updatePreset
  22. version
  23. version_data
  24. workerInfo

auth

data (optional)
auth_data

auth_data

expires (optional)
Integer
neverExpires (optional)
Boolean
product (optional)
String
token (optional)
String
version (optional)
String

inline_response_200

status (optional)
String
example: OK

inputConfiguration

processOptions
inputConfiguration_processOptions
application
String
example: transcode
applicationArgs (optional)
array[String]
example: ["-sw"]
config
inputConfiguration_config
inputSources (optional)
array[null]
items anyOf:
outputPaths (optional)
array[String]

inputConfiguration_config

preset
String
example: /preset/avid/dnxhd-115-720p50
customPreset
Object

inputConfiguration_processOptions

forcedShutdownTimeout (optional)
Integer
example: 5000
cpuSet (optional)
String
example: 0-4,7,9-11
clockTimeLimitMs (optional)
BigDecimal
maxMemoryLimit (optional)
Integer
visibility (optional)
String
Enum:
normal
minimized
hidden
server
windows (optional)
inputConfiguration_processOptions_windows
linux (optional)
Object
docker (optional)
Object
kubernetes (optional)
Object

inputConfiguration_processOptions_windows

priorityClass (optional)
String
Enum:
aboveNormal
belowNormal
high
idle
normal
realtime
jobUserTimeLimitMs (optional)
BigDecimal
processUserTimeLimitMs (optional)
BigDecimal
propagateOnChildProcesses (optional)
Boolean

mediaEnginePreset

audio_stream_count
BigDecimal
audio_stream_settings
array[null]
muxer_stream_count
BigDecimal
muxer_stream_settings
array[null]
output_stream_count
BigDecimal
output_stream_settings
array[null]
preset_info
mediaEnginePreset_preset_info
transcoder_settings
mediaEnginePreset_transcoder_settings
video_stream_count
BigDecimal
video_stream_settings
array[null]
writing_application (optional)
String
writing_application_date (optional)
String
writing_application_version (optional)
String

mediaEnginePreset_preset_info

comment
String
display_name
String
valid_container_format_count
BigDecimal
valid_container_formats
array[null]
valid_framerate_count
BigDecimal

mediaEnginePreset_transcoder_settings

match_source_streams
Boolean

preset-count

builtIn (optional)
presetcount_builtIn
user (optional)
presetcount_builtIn

presetcount_builtIn

count (optional)
Integer
folders (optional)
Integer

presets

presets (optional)
array[null]
items anyOf:

stats

exitCode
Integer
example: 0
id
String
example: 65629821692375e86c067611
pid
Integer
example: 45036
processInfo
stats_processInfo
processorTime
BigDecimal
example: 0
product
String
example: nablet mediaEngine
state
String
example: terminated
version
String
example: v3.0.3

stats_processInfo

estimatedTime
stats_processInfo_estimatedTime
message
String
stats (optional)
stats_processInfo_stats
status
String
example: job finished
timeElapsed
stats_processInfo_timeElapsed

stats_processInfo_estimatedTime

ms
BigDecimal
example: 89484.73976845638
timecode
String
example: 00:01:29.484

stats_processInfo_stats

averageFPS
BigDecimal
example: 32.19543362873544
currentFPS
BigDecimal
example: 29.63742866409841
currentFramesRendered
Integer
example: 456
currentInputFrames
Integer
example: 0
currentJobDonePercent
BigDecimal
example: 14
currentJobsIndex
Integer
example: 0
currentMediaPosition
stats_processInfo_stats_currentMediaPosition
currentSourcePosition
stats_processInfo_stats_currentMediaPosition
framerateD
BigDecimal
example: 125
framerateN
BigDecimal
example: 2997
maxFPS
BigDecimal
example: 38.3387365392696
minFPS
BigDecimal
example: 26.781398176454644
outputStreamStats
array[null]
example: []
outputStreamStatsCount
BigDecimal
example: 0
streamingMode
Boolean
example: false
totalFramesPerJob
BigDecimal
example: 3337
totalFramesRendered
BigDecimal
example: 0
totalInputDropFrameCount
BigDecimal
example: 0
totalInputFramesCount
BigDecimal
example: 3337
totalJobs
BigDecimal
example: 1
totalMediaDuration
stats_processInfo_stats_totalMediaDuration

stats_processInfo_stats_currentMediaPosition

27Mhz
Integer
timecode
String
example: --:--:--.---

stats_processInfo_stats_totalMediaDuration

27Mhz
Integer
example: 3757882896
timecode
String
example: 00:02:19.180

stats_processInfo_timeElapsed

ms
BigDecimal
example: 15461.1197
timecode
String
example: 00:00:15.461

updatePreset

displayName (optional)
String
comment (optional)
String
config
Object

version

data (optional)
version_data

version_data

coreDLLBuildDate (optional)
String
coreDLLVersion (optional)
String
coreSDKVersion (optional)
String
meDLLBuildDate (optional)
String
meDLLVersion (optional)
String
meSDKVersion (optional)
String
product (optional)
String

workerInfo

commandLine (optional)
String
example: ../transcode -i <input> <preset> -o <output>
exitCode (optional)
Integer
example: -1
id (optional)
String
example: 65629821692375e86c067611
inputConfiguration (optional)
inputConfiguration
pid (optional)
Integer
example: 52084
processorTime (optional)
BigDecimal
example: 0
product (optional)
String
example: nablet mediaEngine
state (optional)
String
Enum:
terminated
running
example: running
statsURL (optional)
String
example: ws://127.0.0.1:43211
version (optional)
String
example: v3.0.3

Related articles