Node-mediastreamtrack NPM

node-mediastreamtrack

W3 MediaStreamTrack interface for Node.js.

This library is intended for Node.js applications or libraries that depend on the MediaStreamTrack class. The exposed MediaStreamTrack class does not internally manage any audio/video source. It's up to the application how to associate a MediaStreamTrack instance with a real media stream/track.

Install

$ npm install node-mediastreamtrack

Usage

const { MediaStreamTrack } = require('node-mediastreamtrack');
// or
import { MediaStreamTrack } from 'node-mediastreamtrack';

const track = new MediaStreamTrack({ kind: 'audio' });

track.enabled = false;

console.log('track.readyState: %s, track.enabled: %s', track.readyState, track.enabled);
// => 'track.readyState: live, track.enabled: false'

const clonedTrack = track.clone();

track.stop();

console.log('track.readyState: %s', track.readyState);
// => 'track.readyState: ended'

console.log('clonedTrack.readyState: %s', clonedTrack.readyState);
// => 'clonedTrack.readyState: live'

API additions

Constructor

The MediaStreamTrack provides a class constructor that accepts an Object as parameter with the following fields.

const track = new MediaStreamTrack({ kind, id, label })

kind: "audio" or "video" string.
id: Track unique identificator string. If not given, a random one is internally generated.
label: Track label (string).

Custom methods

track.remoteStop() emulates a stop generated remotely. It will fired "ended" event if not alread stopped.
track.remoteMute() emulates a mute generated remotely. It will fired "mute" event if not alread muted.
track.remoteUnmute() emulates a unmute generated remotely. It will fired "unmute" event if not alread muted.

const track = new MediaStreamTrack({ kind: 'video' });

track.onended = () => console.log('track ended (1)');
track.addEventListener('ended', () => console.log('track ended (2)'));

track.remoteStop();
// => track ended (1)
// => track ended (2)