0.1.1 • Published 5 years ago

procoder-watcher v0.1.1

Weekly downloads
1
License
MIT
Repository
-
Last release
5 years ago

NPM version Build Status Coverage Status

procoder-watcher

Exposes REST APIs to retrieve EDIUS ProCoder's transcoding job status

APIs

MethodPathDescriptionRequest ParamsQuery Strings
GET/api/logs/:numReturns the last {num} log entries in reverse chronological ordernum must be an integer between 1 to 128-

Response JSON Format

The response is an array of objects. Each object has the following format:

FieldTypeDescription
typestring"TRANSCODINGJOB"
statusstringEither of "queued"/"started"/"completed"/"failed"
sourcestringThe name of the source file
queuedTimestringThe time when the transcoding gets started
errorobjectIf any error occurred, an error object, otherwise null
progressnumberPercentage to represent the encoding progress
destinationstringThe name of the output file
endTimestringThe time when the transcoding completed
fileSizenumberThe file size of the output file

Install

  • Install Node.js
  • Clone source code and install dependencies
$ git clone git@github.com:kuu/procoder-watcher.git
$ cd procoder-watcher
$ npm install

Run

  • Start the server with specifying parameters (see below)
$ PORT={port number} LOG_PATH={full path} npm start
  • Once the server gets started, you can access the APIs
$ curl http://localhost:3000/api/logs/3
[
  {
    "type": "TRANSCODINGJOB",
    "status": "completed",
    "source": "xxx.avi",
    "queuedTime": "2018-04-17T12:14:22.000Z",
    "error": null,
    "progress": 100,
    "destination": "xxx.mp4",
    "endTime": "2018-04-17T12:16:36.395Z",
    "fileSize": 596487805
  }
  ...
]
  • Timezone is UTC
  • Use DEBUG environ variable for detail logs
$ DEBUG=procoder-watcher npm start

Stop

  • You can stop the server by the following command in the same directory you did npm start
$ npm stop

Parameters

The parameters can be specified via environment variables:

VariableDescriptionDefault Value
PORTPort number to listen for HTTP requests3000
LOG_PATHDirectory where the ProCoder log files are locatedcurrent directory
INTERVALHow frequently the log files are read (in milliseconds)1000
DEBUGTo enable the debug trace, add procoder-watcher to the DEBUG variable- (no debug trace)