gstreamer-recorder

GStreamer wrapper for recording desktop.

Requires GStreamer-1.0 with gst-launch-1.0 binary and following GStreamer1 plugins: base, good, bad, ugly.

Used by GNOME Shell Extension Cast to TV and gst-rec terminal app.

Examples

Record desktop directly to file:

1var gstRecorder = require('gstreamer-recorder');
2var recorder = new gstRecorder({
3  output: 'file',
4  format: 'mp4',
5  file: {
6    dir: '/tmp',
7    name: 'My Recording'
8  }
9});
10var duration = 10000;
11
12recorder.start();
13setTimeout(() => recorder.stop(), duration);
14
15console.log(`Recording ${duration/1000} sec video to ${recorder.opts.file.dir}`);

Pipe output:

1var fs = require('fs');
2var gstRecorder = require('gstreamer-recorder');
3var recorder = new gstRecorder({ output: 'stdout', format: 'matroska' });
4var destFile = '/tmp/recording.mkv';
5var writableStream = fs.createWriteStream(destFile);
6var duration = 10000;
7
8recorder.start().pipe(writableStream);
9setTimeout(() => recorder.stop(), duration);
10
11console.log(`Piping output to ${destFile} for ${duration/1000} seconds`);

Create tcp server:

1var gstRecorder = require('gstreamer-recorder');
2var recorder = new gstRecorder({ output: 'server', server: { port: 8080 }});
3
4recorder.start();
5process.on('SIGINT', () => recorder.stop());
6process.on('SIGTERM', () => recorder.stop());
7
8console.log(`Started tcp media server on port ${recorder.opts.server.port}`);

Donation

If you like my work please support it by buying me a cup of coffee :grin: