An implementation of the timing provider specification.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
src
test/unit
.gitignore
.travis.yml
LICENSE
README.md
gruntfile.js
package-lock.json
package.json

README.md

timing-provider

An implementation of the timing provider specification.

tests dependencies version

This is an implementation of a TimingProvider as it is defined by the Timing Object specification. It uses WebRTC to communicate between the connected clients.

Installation

This package is available on npm and can be installed by running npm's install command.

npm install timing-provider

Usage

This package exposes the TimingProvider class which can be used to instantiate a TimingProvider.

import { TimingProvider } from 'timing-provider';

const timingProvider = new TimingProvider('aSuperSecretClientId');

The only constructor argument the TimingProvider expects is the clientId. This is unfornately necessary to do the signaling process which establishes the WebRTC connection. Currently there is no automated way to get a clientId. Please send a quick email to info@media-codings.com if you like to have a clientId for your project.

The TimingProvider can be used with the TimingObject of the timing-object package.