Skip to content

Commit

Permalink
Update doc and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicolas Joyard committed Feb 24, 2014
1 parent ac3faa1 commit 3cf801b
Show file tree
Hide file tree
Showing 11 changed files with 510 additions and 240 deletions.
641 changes: 431 additions & 210 deletions README.md

Large diffs are not rendered by default.

11 changes: 8 additions & 3 deletions examples/express-stream.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,15 @@ app.get('/video/:filename', function(req, res) {
var proc = new ffmpeg({ source: pathToMovie, nolog: true })
// use the 'flashvideo' preset (located in /lib/presets/flashvideo.js)
.usingPreset('flashvideo')
// save to stream
.writeToStream(res, {end:true}, function(retcode, error){
// setup event handlers
.on('end', function() {
console.log('file has been converted succesfully');
});
})
.on('error', function(err) {
console.log('an error happened: ' + err.message);
})
// save to stream
.writeToStream(res, {end:true});
});

app.listen(4000);
11 changes: 8 additions & 3 deletions examples/full.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,12 @@ var proc = new ffmpeg({ source: '/path/to/your_movie.avi', nolog: true })
.addOption('-vtag', 'DIVX')
// set output format to force
.toFormat('avi')
// save to file
.saveToFile('/path/to/your_target.avi', function(retcode, error){
// setup event handlers
.on('end', function() {
console.log('file has been converted succesfully');
});
})
.on('error', function(err) {
console.log('an error happened: ' + err.message);
})
// save to file
.saveToFile('/path/to/your_target.avi');
11 changes: 8 additions & 3 deletions examples/image2video.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@ var proc = new ffmpeg({ source: '/path/to/your_image.jpg', nolog: true })
.loop(5)
// using 25 fps
.withFps(25)
// save to file
.saveToFile('/path/to/your_target.m4v', function(retcode, error){
// setup event handlers
.on('end', function() {
console.log('file has been converted succesfully');
});
})
.on('error', function(err) {
console.log('an error happened: ' + err.message);
})
// save to file
.saveToFile('/path/to/your_target.m4v');
10 changes: 8 additions & 2 deletions examples/input-stream.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ infs.on('error', function(err) {
// instead of file path (can be any ReadableStream)
var proc = new ffmpeg({ source: infs, nolog: true })
.usingPreset('flashvideo')
.saveToFile('/path/to/your_target.flv', function(stdout, stderr, err) {
// setup event handlers
.on('end', function() {
console.log('done processing input stream');
});
})
.on('error', function(err) {
console.log('an error happened: ' + err.message);
})
// save to file
.saveToFile('/path/to/your_target.flv');
11 changes: 8 additions & 3 deletions examples/livertmp2hls.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,12 @@ var proc = new ffmpeg({ source: 'rtmp://path/to/live/stream', nolog: true, timeo
.addOption('-hls_time', 10)
// include all the segments in the list
.addOption('-hls_list_size',0)
// save to file
.saveToFile('/path/to/your_target.m3u8', function(retcode, error){
// setup event handlers
.on('end', function() {
console.log('file has been converted succesfully');
});
})
.on('error', function(err) {
console.log('an error happened: ' + err.message);
})
// save to file
.saveToFile('/path/to/your_target.m3u8');
10 changes: 7 additions & 3 deletions examples/mergeVideos.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ var proc = new ffmpeg({source:firstFile,nolog:true})
.mergeAdd(thirdFile)
//.mergeAdd(fourthFile)
//.mergeAdd(...)
.mergeToFile(outPath,function(){
console.log('files have been merged successfully');
});
.on('end', function() {
console.log('files have been merged succesfully');
})
.on('error', function(err) {
console.log('an error happened: ' + err.message);
})
.mergeToFile(outPath);
11 changes: 8 additions & 3 deletions examples/preset.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@ var proc = new ffmpeg({ source: '/path/to/your_movie.avi', nolog: true })
.usingPreset('podcast')
// in case you want to override the preset's setting, just keep chaining
.withVideoBitrate('512k')
// save to file
.saveToFile('/path/to/your_target.m4v', function(retcode, error){
// setup event handlers
.on('end', function() {
console.log('file has been converted succesfully');
});
})
.on('error', function(err) {
console.log('an error happened: ' + err.message);
})
// save to file
.saveToFile('/path/to/your_target.m4v');
12 changes: 8 additions & 4 deletions examples/progress.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,14 @@ infs.on('error', function(err) {

var proc = new ffmpeg({ source: infs, nolog: true })
.usingPreset('flashvideo')
// set the callback for our progress notification
.onProgress(function(info) {
// setup event handlers
.on('progress', function(info) {
console.log('progress ' + info.percent + '%');
})
.saveToFile('/path/to/your_target.flv', function(stdout, stderr, err) {
.on('end', function() {
console.log('done processing input stream');
});
})
.on('error', function(err) {
console.log('an error happened: ' + err.message);
})
.saveToFile('/path/to/your_target.flv');
11 changes: 8 additions & 3 deletions examples/stream.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,12 @@ var stream = fs.createWriteStream('/path/to/yout_target.flv')
var proc = new ffmpeg({ source: '/path/to/your_movie.avi', nolog: true })
// use the 'flashvideo' preset (located in /lib/presets/flashvideo.js)
.usingPreset('flashvideo')
// save to stream
.writeToStream(stream, {end:true}, function(retcode, error){ //end = true, close output stream after writing
// setup event handlers
.on('end', function() {
console.log('file has been converted succesfully');
});
})
.on('error', function(err) {
console.log('an error happened: ' + err.message);
})
// save to stream
.writeToStream(stream, {end:true}); //end = true, close output stream after writing
11 changes: 8 additions & 3 deletions examples/thumbnails.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@ var ffmpeg = require('../index');
var proc = new ffmpeg({ source: '/path/to/your_movie.avi', nolog: true })
// set the size of your thumbnails
.withSize('150x100')
// setup event handlers
.on('end', function(files) {
console.log('screenshots were saved as ' + files.join(', '));
})
.on('error', function(err) {
console.log('an error happened: ' + err.message);
})
// take 2 screenshots at predefined timemarks
.takeScreenshots({ count: 2, timemarks: [ '00:00:02.000', '6' ] }, '/path/to/thumbnail/folder', function(err) {
console.log('screenshots were saved');
});
.takeScreenshots({ count: 2, timemarks: [ '00:00:02.000', '6' ] }, '/path/to/thumbnail/folder');

0 comments on commit 3cf801b

Please sign in to comment.