Joey Parrish
8ba088a38f
We were not able to get our externs generated by the Closure compiler. There were many issues with the Closure-generated externs, including the order of the externs and the replacement of record types and enums with their underlying types. We made a few attempts to patch the compiler, but could not get our patches accepted upstream. This change introduces a new script to generate our externs from scratch. It uses a JavaScript parser called 'esprima'. Some interfaces need to be exported to the generated externs, but are not actually attached to the namespace by the compiler. For this, we introduce a new annotation. These are the currently-supported export annotations: - @export: truly exported (attached to namespace) by the compiler - @expose: truly exposed (not renamed) by the compiler - @exportDoc: considered part of the exports in the docs - @exportInterface: considered part of the exports in generated externs These annotations are now documented in docs/design/export.md Change-Id: I33bf7384889c14c9edb0fa5f11caa7c4f4d79af6
4.2 KiB
Shaka Player is a JavaScript library for adaptive video streaming. It plays DASH content without browser plugins using MediaSource Extensions and Encrypted Media Extensions.
We are currently testing on the latest stable releases of Chrome, Firefox, and Edge, as well as IE 11 and Safari. We test using both Widevine and PlayReady, but any browser-supported DRM system available through EME should work.
Our main goal is to make it as easy as possible to stream adaptive bitrate video using modern browser technologies. We try to keep the library light and simple, and it has no third-party dependencies. Everything you need to build and deploy is in the sources.
We support both ISO BMFF (MP4) and WebM content (even in the same manifest), WebVTT for subtitles and captions, both clear and encrypted content, and multilingual content. And best of all, it's free!
Important Links
- hosted demo (sources in
demo/) - hosted builds on cdnjs
- mailing list (join for release announcements or to discuss development)
- hosted API docs
- tutorials
Compiled Mode
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 sources have already been compiled for you and the externs have been generated.
See:
- dist/shaka-player.compiled.js (compiled bundle)
- dist/shaka-player.compiled.externs.js (generated externs)
In order to build, you simply need python v2.7 (for the build scripts) and
JRE 7+ (for the compiler). Just run ./build/all.py and look for the output
in dist/shaka-player.compiled.js. The output can be included directly in a
<script> tag or loaded via a number of JavaScript module loaders.
To build the documentation, you will also need nodejs. Just run
./build/docs.py and look for the output in docs/api/.
Uncompiled Mode
Shaka Player can also be run in uncompiled mode. This is very useful for development purposes.
To load the library without compiling, you will need to generate a Closure
"deps file" by running ./build/gendeps.py. Then, you'll need to bootstrap
your application with three <script> tags:
<script src="third_party/closure/goog/base.js"></script>
<script src="dist/deps.js"></script>
<script src="shaka-player.uncompiled.js"></script>
If you installed Shaka Player via npm, the deps file has already been generated for you.
Testing
You will need a few third-party dependencies to run automated tests. These
dependencies are managed through npm and Shaka's package.json. If you
cloned Shaka from github, simply run npm install from your git working
directory to install these dependencies locally.
Run the tests in your platform's browsers using ./build/test.py. If you are
familiar with the karma test runner, you can pass additional arguments
to karma from build/test.py. For example:
./build/test.py --browsers Opera
Or:
./build/test.py --browsers Chrome,Firefox --reporters coverage
You can skip slow-running integration tests with --quick.
Contributing
If you have improvements or fixes, we would love to have your contributions. Please read CONTRIBUTING.md for more information on the process we would like contributors to follow.