@vindral/web-sdk 2.0.1 → 2.0.2

package/README.md

@@ -2,41 +2,55 @@
 
 **Ultra low latency streaming on all modern web browsers.**
 
-This package contains the web SDK for Vindral - the ultra low latency streaming platform for synchronized live experiences.
+This package contains the Web SDK for Vindral - the ultra low latency streaming platform for synchronized live experiences.
 
-Check out our [demo](https://demo.vindral.com/).
+For information about the Vindral product family and how the Web SDK fits into the system, [make sure to read the System Overview](https://docs.vindral.com/docs/overview/system-overview).
+
+Make sure to check out the full [Web SDK Documentation](https://docs.vindral.com/web-sdk/) as well.
+
+[Check out our demo](https://demo.vindral.com/) to see some of Vindral's features.
 
 ## Getting Started
 
 There are multiple ways to integrate the Web SDK, depending on use-case.
 
-The simplest way to get started is to use the [Iframe Embed Player](#embed). This requires the least amount of code, and will automatically be updated when new releases are available.
+The most simple way to get started is to use the iframe-based [Embed Player](#embed-player). This requires the least amount of code, and will automatically be updated when new releases are available.
 
 The two other alternatives are [Player SDK](#player-sdk) and [Core SDK](#core-sdk) - these are the recommended options if the integration requires access to the APIs, such as timed metadata or other controls. The two SDKs have very similar APIs, but the Player SDK provides controls and buffering indication built in - the Core SDK is the most strippped down implementation for use-cases where all UI components are customized.
 
-### Embed
+If you are going for one of the SDK alternatives, follow the steps at [Installation](#installation) to get started:
+
+## Embed Player
 
 This is the simplest way to integrate. It allows you to add a fully functional video player to your site in no time. It will also be automatically updated when improvements are released.
 
-Add the following html snippet, replace `channel-id` and `cdn-entry-url` with your stream credentials, done!
+Add the following html snippet, set `channelId` to channel id credential, done!
 
-```
-<iframe src="https://embed.vindral.com/?core.channelId=<channel-id>&core.url=<cdn-entry-url>" frameborder="0" allowfullscreen></iframe>
+```html
+<iframe
+  src="https://embed.vindral.com/?channelId=vindral_demo1_ci_099ee1fa-80f3-455e-aa23-3d184e93e04f"
+  frameborder="0"
+  allowfullscreen
+></iframe>
 ```
 
-### SDK
+[See the player in action](https://embed.vindral.com/?channelId=vindral_demo1_ci_099ee1fa-80f3-455e-aa23-3d184e93e04f) or [read more about Embed Player here](https://docs.vindral.com/docs/guides/using-the-embed-player).
 
-**Installation**
+## Installation
 
-The SDK is available as a package on NPM for use with a module bundler:
+Install @vindral/web-sdk using `npm`:
 
 ```
-npm install @vindral/web-sdk
+npm install --save @vindral/web-sdk
 ```
 
-For usage, see [Player Example](#example) and [Core Example](#example-1) and the API references.
+or `yarn`:
 
-#### Player SDK
+```
+yarn add @vindral/web-sdk
+```
+
+### Player SDK
 
 The Player SDK provides a ready-to-go player with controls - perfect for use-cases where the embed solution is not enough, such as when access to the javascript API is needed.
 
@@ -52,21 +66,18 @@ import { Player } from "@vindral/web-sdk"
 const root = document.querySelector<HTMLElement>("#root")
 
 const player = new Player({
-  url: "<cdn-entry-url>",
-  channelId: "<channel-id>",
+  url: "https://lb.cdn.vindral.com",
+  channelId: "vindral_demo1_ci_099ee1fa-80f3-455e-aa23-3d184e93e04f",
 })
 
 // Starts connecting to the channel
 player.core.connect()
 
-// This event is emitted when timed metadata events occur
-player.core.on("metadata", (metadata) => console.log("metadata: ", metadata.content))
-
 // Attaches the player view to the DOM
 player.attach(root)
 ```
 
-#### Core SDK
+### Core SDK
 
 The Core SDK is the lowest level method to integrate that provides only a video view and audio playback - this allows for full customization of the look of buffering indication, controls, etc.
 
@@ -75,7 +86,7 @@ The Core SDK is the lowest level method to integrate that provides only a video
 The example assumes that there is a html page that loads this script that has at least a div with `id="#root"`, `id="#playback-state"` and a button with `id="#activate-audio-button"`.
 
 ```typescript
-import { Vindral } from "@vindrl/web-sdk"
+import { Vindral } from "@vindral/web-sdk"
 
 const root = document.querySelector<HTMLElement>("#root")!
 const button = document.querySelector<HTMLElement>("#activate-audio-button")!
@@ -84,8 +95,8 @@ const playbackState = document.querySelector<HTMLElement>("#playback-state")!
 button.style.display = "none"
 
 const instance = new Vindral({
-  url: "<cdn-entry-url>",
-  channelId: "<channel-id>",
+  url: "https://lb.cdn.vindral.com",
+  channelId: "vindral_demo1_ci_099ee1fa-80f3-455e-aa23-3d184e93e04f",
 })
 
 // Errors are emitted when they can not be handled internally
@@ -122,6 +133,6 @@ button.addEventListener("click", () => {
 
 #### License and support
 
-Vindral is a commercial product and requires an active, paid license to access and use. To obtain such a license, or in case you have any questions, get in touch on vindral.com/inquiries
+Vindral is a commercial product and requires an active, paid license to access and use. To obtain such a license, or in case you have any questions, do not hesitate to [get in touch](https://vindral.com/inquiries)!
 
-Copyright Realsprint AB
+Copyright RealSprint AB

package/index.d.ts

@@ -380,6 +380,7 @@ declare class ConnectionModule {
 	private _firstConnectionTime?;
 	private _lastConnectionTime?;
 	private contextSwitchesInProgress;
+	private contextSwitchesCompleted;
 	private buffer;
 	private constructor();
 	static create: (emitter: Emitter<ConnectionModuleListeners, ConnectionModuleEvents>, logger: Logger, options: ConnectOptions) => ConnectionModule;
@@ -1240,6 +1241,7 @@ export interface PublicVindralEvents {
 	["rendition levels"]: ReadonlyArray<RenditionLevel>;
 	["rendition level"]: Readonly<RenditionLevel>;
 	["languages"]: ReadonlyArray<string>;
+	["channels"]: ReadonlyArray<Channel>;
 	["server wallclock time"]: Readonly<number>;
 	["buffer state event"]: Readonly<BufferStateEvent>;
 	["initialized media"]: void;
@@ -1309,6 +1311,9 @@ interface Subscription {
 interface ContextSwitch {
 	type: "context switch";
 }
+interface ContextSwitchComplete {
+	type: "context switch complete";
+}
 interface RenditionsSignal {
 	type: "renditions";
 	renditions: Rendition[];
@@ -1343,7 +1348,7 @@ interface RefreshAuthSignal {
 	type: "refresh auth";
 	token: string;
 }
-declare type Signal = RenditionsSignal | SubscribeSignal | SubscriptionChangedSignal | TimingInfoSignal | PingSignal | PongSignal | ClientIpSignal | ContextSwitch | RefreshAuthSignal;
+declare type Signal = RenditionsSignal | SubscribeSignal | SubscriptionChangedSignal | TimingInfoSignal | PingSignal | PongSignal | ClientIpSignal | ContextSwitch | ContextSwitchComplete | RefreshAuthSignal;
 export interface Channel {
 	channelId: string;
 	name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vindral/web-sdk",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "homepage": "https://vindral.com",
   "description": "Web SDK for viewing Vindral streams",
   "license": "SEE LICENSE IN https://www.vindral.com/terms-conditions",