Web SDK NPM package

Requirements

To use our WT SDK npm package, an Access Token will be needed. If you don't have a token, please contact us at [email protected].

What is the Access Token? Why do you need it?

WT SDK is a private package that is hosted on the npm registry. Only authorized users can access it. When you receive access to the SDK we will generate an authentication token for you. An authentication token is a hexadecimal string that gives you access to SDK.

Before installation

In your project root folder create a .npmrc file. This file will set the specific npm config values for this project. Insert the code snippet below to the .npmrc file. Replace YOUR_ACCESS_TOKEN with the token that was provided.

//registry.npmjs.org/:_authToken=YOUR_ACCESS_TOKEN

Installation

npm i @sscale/syncsdk

Documentation

Usage

To get a worked solution you need to create a template with a html5 video tag, then initialize SDK and create a synchronization group. After that create a player and relate the html5 video with the player object. And in the finish, you must attach the player-object to the group and start the sync process.

The instruction below help you create a simple solution.

In your .ts service added next import.

Last updated

Was this helpful?