mirror of
https://github.com/shaka-project/shaka-player.git
synced 2026-06-16 16:16:40 +03:00
Joey Parrish
c8e80cb58d
- Update tutorial link in README - Fix python version in README - Move jsdoc conf to docs/ folder - Add API docs main page - Change style of inline code blocks - Don't repeat tutorial title in jsdoc template - (makes it easier to read tutorials on github as MD) - Add tutorials for: - Welcome to Shaka - Basic Usage - Debugging - Configuration - Networking and Buffering Configuration - DRM Configuration - License Server Authentication - Plugins - Tutorials still to come: - License Headers and Track Restrictions - Special Considerations for Live - v2 Upgrade Guide Change-Id: I16401c216cf4023d9097750ac7f6090c68bf3c9b
29 lines
1.2 KiB
Markdown
29 lines
1.2 KiB
Markdown
## Shaka Player API Documentation
|
|
|
|
The Shaka Player library is meant to be compiled before deployment. The
|
|
compiled library will only have some symbols exported. Others will be
|
|
inaccessible from the compiled bundle.
|
|
|
|
Because of this, these API docs can be filtered to show you what is and isn't
|
|
accessible. The combo box in the top-right corner of the page lets you select
|
|
different views of the library. You can choose the "exported", "public", or
|
|
"everything" view.
|
|
|
|
"Exported" means everything which is available outside the compiled library.
|
|
In all modes, exported symbols are shown in red.
|
|
|
|
"Public" means everything which is public in the sources. This is used in the
|
|
sense of [public/protected/private](http://goo.gl/jg5iKD) in object-oriented
|
|
programming languages.
|
|
|
|
"Everything" shows all symbols, even private ones.
|
|
|
|
Whatever view you choose will be stored by the browser across page loads and
|
|
sessions, so you should not have to keep setting it as you browse the docs.
|
|
|
|
## Tutorials
|
|
|
|
We have written several tutorials to help you learn about Shaka Player. Each
|
|
is an easy, hands-on tutorial with sample code. If you don't know where to go
|
|
next, we recommend you start with {@tutorial welcome}.
|