# Player SDK

The BlendVision Player SDK allows you to interact with and control an embedded BlendVision Player.

## Installation

You can install the BlendVision Player SDK through either npm:

npm install @kksweb/player-sdk

Alternatively, you can reference an up‐to‐date version on our CDN:

<script src="https://tbd.kkstream.com/sdk/player.js"></script>

## Getting Started

In order to control the BlendVision player, you need a player to control.

### Create with a Moment live event token

You can use the library to make the embed for you. All you need is an empty
element and the Moment live event token:

<div id="my-player"></div>

<script src="https://tbd.kkstream.com/sdk/player.js"></script>
<script>
    const options = {
      playerUrl: 'https://player.live.kkstream.io',
      token: 'eyJhsomethingjh8',
    };
    const player = new Player('my-player', config);
    player.setVolume(0);
</script>

## Browser Support

The Player SDK library is supported in Chrome, Firefox, and Safari.

## Script Commands

| Script | Description |
| ------------- | ---------------------------------------------------------------------------------- |
| `start` | Runs the app in development mode at http://localhost:3000. |
| `build:dev` | Builds the SDK for development env to the `dist` folder. |
| `build:stag` | Builds the SDK for stage env to the `dist` folder. |
| `build` | Builds the SDK for production to the `dist` folder. |
| `build:demo` | Builds the SDK demo site to the `build` folder. Need to build SDK first. |
| `release` | Bump version, add tag, push to remote repository. |
| `clean` | Removes the `dist` folder. |
| `clean:build` | Removes the `build` folder. |