Files
shaka-player/docs/tutorials/welcome.md
T
Joey Parrish 9e571b3938 Update docs with regard to users list
The users list is now for announcements only.

Issue #1095

Change-Id: I4d86bfda5c116e88b950e2139a1c3d42afc91693
2017-10-30 15:28:16 -07:00

1.8 KiB

Welcome to Shaka Player

Shaka Player is a JavaScript library for adaptive video streaming. It plays DASH content without browser plugins using MediaSource Extensions and Encrypted Media Extensions.

Prerequisites

You can build Shaka on Linux, Windows, or Mac. To get the sources and compile the library, you will need:

Additionally, to build the documentation and run the tests, you will need:

To quickly install these prerequisites on Ubuntu or Debian, run:

sudo apt-get update
sudo apt-get install git python2.7 default-jre-headless npm

# Upgrade npm and node to the latest versions
sudo npm install -g n
sudo n stable
sudo npm install -g npm

Installation instructions for other operating systems are not provided here. (We can't possibly document them all.) You can follow the links above to download and install the prerequisites.

Get the source

git clone https://github.com/google/shaka-player.git
cd shaka-player

Compile the library

python build/all.py

Join the announcement list

If you want to receive release or survey announcements, you should join our mailing list. The list is very low volume.

Continue the Tutorials

Next, check out {@tutorial basic-usage}.