Amazon IVS Player Web SDK Samples

This project contains code samples demonstrating how to build, package, and integrate with the Amazon IVS Player Web SDK. You can find the Web SDK API reference and documentation here.

Requirements

Node 12+
NPM 6+
A browser which meets the IVS web player requirements

How to Import the SDK from NPM

The Amazon IVS Web SDK on NPM is built using Webpack using the commonjs2 library target. We recommend importing with the import statement, but any module syntax compatible with commonjs2 will work.

You need to import two files to use the SDK:

amazon-ivs-player/dist/assets/amazon-ivs-wasmworker.min.js
amazon-ivs-player/dist/assets/amazon-ivs-wasmworker.min.wasm

Please see our sample player for an example on how to import the SDK assets. However, you must also configure your build tool to properly import the SDK WebAssembly files.

How to import WebAssembly Files

The Amazon IVS Web SDK uses WebAssembly (WASM). The WASM file is included separately from the JavaScript file. There are two important steps you must take to properly import the WASM:

You must not transpile the WASM file. If you do, the Player will fail on setup and throw an error.
It is strongly suggested to stream the WASM file

Webpack's file-loader meets both of the above requirements. We have included a sample Webpack config which demonstrates how to use this to load our SDK.

You don't need to install from NPM

We also provide the Amazon IVS SDK hosted on our CDN. Cloud-hosted SDKs are easier to get started with, and do not require you to use Webpack or another build tool. There is no difference in performance between either SDK. However, the Cloud SDK does not currently support TypeScript types. Please see the sample directory below for how to use the Cloud SDK.

Setup

Locally clone this repository.
Install dependencies: npm install
Build and host using webpack-dev-server: npm start
- Alternatively, you can just build with npm run bundle. The dist/ folder can then be independently hosted.
Navigate to the index page and select a demo.
Once in the demo, open the developer tools to see relevant logs.

Code Samples

Cloud Player Demo - Demonstrates how to instantiate a player using our cloud-hosted assets. Webpack is used here to transpile TypeScript.
How to load from NPM - Demonstrates how to create a player using the NPM package and Webpack.
Basic VideoJS Tech demo - A basic integration with the IVS player VideoJS tech.
Service worker Demo - Demonstrates how to setup and configure a service worker to enhance playback on environments / browsers where only native playback is available. Primarily useful for mobile Safari on iOS.
- See the Service worker setup section in the Web SDK Guide for more information
Pure JavaScript Codepen - A demo player built using pure JavaScript.
Webpack build configuration - Demonstrates how to make player assets available via Webpack.

Please see each sample for detailed code comments.

Live Demo

Try out this repo in CodeSandbox. You can build, run, and experiment with our code without having to set it up yourself.

Test Streams

License

This project is licensed under the MIT-0 License. See the LICENSE file.

aws-samples / amazon-ivs-player-web-sample

readme