Note: This is a fork from https://github.com/dturing/node-gstreamer-superficial that adds a new method getPad that case be used to get pads and change their properties at pipeline play-time. See https://github.com/dturing/node-gstreamer-superficial/pull/56 for details. The plan is to delete this fork and published package when the above PR is merged into upstream and a new version of the package is released.

gstreamer-superficial

Superficial GStreamer binding

What?

This is a superficial binding of GStreamer to Node.js. It does not attempt at being a complete binding, and will hopefully one day be replaced by (or implemented with) node-gir.

How?

1const gstreamer = require('gstreamer-superficial');
2const pipeline = new gstreamer.Pipeline(`videotestsrc ! textoverlay name=text
3	! autovideosink`);
4
5pipeline.play();

Then, you can find an element within the pipeline, and set its properties:

1const target = pipeline.findChild('text');
2
3target.text = 'Hello';
4Object.assign(target.text, {
5	text: 'Hello',
6	'font-desc': 'Helvetica 32',
7})

(see also examples/basic-pipeline.js)

Pipeline also knows .stop(), .pause() and .pollBus(), the elements returned by .findChild() getting and setting all properties the real GObjects do, appsinks also support .pull() (see below).

Seeking and Querying Position and Duration

There is a simple .seek(position, flags) function. Normally you should pass 1 for flags (GST_SEEK_FLAG_FLUSH). See Flags and Seek Docs.

You can query the pipeline's duration and current position with .getDuration() and .getPosition() (both might return -1). All time position values are in Seconds.

(see also examples/seek.js)

Polling the GStreamer Pipeline Bus

You can asynchronously handle bus messages using Pipeline.pollBus(callback):

1pipeline.pollBus(msg => {
2	console.log(msg);
3});

(see also examples/bus.js)

Handling binary data

You can feast off GStreamer's appsink to handle binary data. .pull starts a background work queue and calls your callback whenever a buffer is (or caps are) available:

1const appsink = pipeline.findChild('sink');
2
3function onData(buf, caps) {
4	if (caps) {
5		console.log('CAPS', caps);
6	}
7	if (buf) {
8		console.log('BUFFER size', buf.length);
9		appsink.pull(onData);
10	}
11
12	// !buf probably means EOS
13}
14
15appsink.pull(onData);

(see examples/appsink.js)

A simple Ogg/Theora streaming server

should be working as implemented in examples/streaming/ run server.js (requires express) and point your browser to http://localhost:8001. (Tested only with Chromium). This handles retaining the streamheader to feed first to every newly connected client.

Who?

gstreamer-superficial was originally written by Daniel Turing, and has received contributions from various individuals as seen on github and in package.json.

Requisites

• libgstreamer-plugins-base1.0-dev
• libgstreamer1.0-dev
• nan