Replay-ffmpeg NPM

replay-ffmpeg-service

replay-ffmpeg-service is module that export some useful methods for record videos and manipulation on TS files. It uses Behind the Scenes the fluent-ffmpeg module.

###Install

Install ffmpeg and ffprobe on ubuntu through this guide.
run the command: npm install --save replay-ffmpeg-service

###Methods

for using the methods first require the module

var ffmpeg = require('replay-ffmpeg-service');

#####ffmpeg.convertToMp4(params)

convert ts file from file system to mp4 format. It take the file and create new file with the suffix '.mp4'

params | <Object>
- inputPath | <String> the path of the file with the file name.
- outoutPath (optional) | <String> the path of the output, default to the same path and the same name of the input file but with the suffix '.mp4'.
- divideToResolutions (optional) | <Boolean> option if want to divide the video into different resolutions.
emit 'FFmpeg_errorOnConverting' when error eccured on converting.
emit 'FFmpeg_finishConverting' when finish the converting.
Return promise | <BlueBird Promise> just for the building of the command, not of the processing.

#####ffmpeg.extractData(params)

extract data from the ts file. It take the file and create new file with the suffix '.data'

params | <Object>
- inputPath | <String> the path of the file with the file name.
- outoutPath (optional) | <String> the path of the output, default to the same path and the same name of the input file but with the suffix '.data'.
emit 'FFmpeg_errorOnExtractData' when error eccured on extracting.
emit 'FFmpeg_finishExtractData' when finish the extracting.
Return promise | <BlueBird Promise> just for the building of the command, not of the processing.

#####ffmpeg.convertAndExtract(params)

It convert and extract data from the ts file, it combine the extractData and convertToMp4 methods. note: this method won't work if the file doesnt have both video and data streams!

params | <Object>
- inputPath | <String> the path of the file with the file name.
- outoutPath (optional) | <String> the path of the output, default to the same path and the same name of the input files but with the suffix '.mp4' and '.data'.
- divideToResolutions (optional) | <Boolean> option if want to divide the video into different resolutions.
emit 'FFmpeg_errorOnConvertAndExtract' when error eccured on process.
emit 'FFmpeg_finishConvertAndExtract' when finish the process.
Return promise | <BlueBird Promise> just for the building of the command, not of the processing.

#####ffmpeg.duration(params,callBack)

get the duration of video.

params | <Object>
- filePath | <String> the path of the file with the file name.
callBack (optional) | <Function> The callback gets two arguments (err, duration).
Return Promise | <BlueBird Promise> .then(durtion) | .catch(err)

you can see that the function work both with promise or callback, that means it Asynchronous.

#####ffmpeg.record(params)

convert ts file from file system to mp4 format. It take the file and create new file with the suffix '.mp4'

params | <Object>
- input | <String> the input of the record, it can be path of file or it can be brodcast streaming host.
  note: if the input is brodcast streaming host it should be in the next format: udp://[ip]:[port]
- outout | <String> the path of the output without extension,the method will add .ts extension.
- duration (optiona) | <Number> duration of the record in seconds, default to 1800 seconds(3 minutes).
emit 'ffmpegWrapper_error_while_recording' when error eccured on recording with the error.
emit 'ffmpegWrapper_finish_recording' when finish the record with the path of the output file.
Return promise | <BlueBird Promise> just for the building of the command, not of the processing.