Joey Parrish
b8baeb8a3a
Jsdoc has the `@link` syntax for links, but github's markdown renderer sees the closing curly brace as part of the link. To format things in a way that works for both jsdoc and github, we should specify text for the `@link` as well as the link itself. This separates the URL from the enclosing curly braces in a way that fixes github's rendering of the markdown. Change-Id: I1cb9273aae50d6089aa4d3c33a7ad5daecaa141f
3.3 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.
Shaka Player is meant to be deployed after being compiled. The tools you need to compile the sources and documentation are included in the sources: Closure Compiler, Closure Linter, and JSDoc.
If you are integrating Shaka Player into another Closure-based project, our build process will generate externs for Shaka Player itself.
If you installed Shaka Player via npm, the source has been compiled and the externs have been generated.
Prerequisites
You can build Shaka on Linux, Windows, or Mac. To get the sources and compile the library, you will need:
- {@link https://git-scm.com/downloads Git v1.9+}
- {@link https://www.python.org/downloads/ Python v2.7}
- {@link https://java.com/en/download/ Java Runtime Environment v8+}
- {@link https://nodejs.org/en/download/ NodeJS v6+}
- A local web server, such as {@link https://httpd.apache.org/ Apache}
- NOTE: A local web server is required because browsers place restrictions on applications from file:/// URLs.
To quickly install these prerequisites on Ubuntu or Debian, you can run this script:
curl https://raw.githubusercontent.com/google/shaka-player/master/build/install-linux-prereqs.sh | bash
We do not provide detailed instructions or scripts for installing these prerequisites on other operating systems or on non-Debian-based Linux distributions. (We couldn't possibly document them all.) You can follow the links above to download and install the prerequisites manually on any OS.
Get the source
git clone https://github.com/google/shaka-player.git
cd shaka-player
Compile the library and generate the docs
python build/all.py
The output is:
- dist/shaka-player.compiled.js (compiled bundle)
- dist/shaka-player.compiled.debug.js (debug bundle)
- dist/shaka-player.compiled.externs.js (generated externs, for Closure-based projects)
- docs/api/index.html (generated documentation)
Run the tests
The tests depend on a few third-party tools, which are installed automatically
via npm when you run the tests. Nothing will be installed globally.
Run the tests in your platform's browsers using ./build/test.py. You can
specify particular browsers with the --browsers argument. For example:
./build/test.py --browsers Opera
# or:
./build/test.py --browsers Chrome,Firefox,Edge
You can find a full list of available browsers with --browsers help, and you
can find a complete list of testing options with --help.
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}.