Skip to content

Commit

Permalink
Update the upgrade guides for v2.1
Browse files Browse the repository at this point in the history
Also changes the jsdoc template for tutorials with children, to give
the tutorial content itself control over how the links to children are
formatted.

Also fixes annotations for the TextParser interface.

Change-Id: I99502f38bf711b74a596ad804d8abdddee5d6f4d
  • Loading branch information
joeyparrish committed Apr 20, 2017
1 parent e37cba8 commit 395cc17
Show file tree
Hide file tree
Showing 7 changed files with 1,041 additions and 748 deletions.
12 changes: 7 additions & 5 deletions docs/tutorials/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@
{ "drm-config": { "title": "DRM Configuration" } },
{ "license-server-auth": { "title": "License Server Authentication" } },
{ "license-wrapping": { "title": "License Wrapping" } },
{ "Coming Soon": { "children": [
{ "live": { "title": "Special Considerations for Live Streaming" } },
{ "offline": { "title": "Offline Storage and Playback" } }
] } },
{ "plugins": { "title": "Plugins and Customizing the Build" } },
{ "manifest-parser": { "title": "Manifest Parser Plugins" } },
{ "architecture": { "title": "Architecture Diagrams" } },
{ "service-worker": { "title": "Service Worker Caching" } },
{ "upgrade": { "title": "Shaka v2 Upgrade Guide" } }
{ "upgrade": {
"title": "Upgrade Guide",
"children": {
"upgrade-v1": { "title": "Upgrade Guide, v1 => v2.1" },
"upgrade-v2-0": { "title": "Upgrade Guide, v2.0 => v2.1" }
}
} }
]
10 changes: 8 additions & 2 deletions docs/tutorials/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,16 @@ __Manifest parsers__
and {@link shaka.media.ManifestParser.registerParserByMime}
- Default manifest parser plugins:
- DASH: {@linksource shaka.dash.DashParser}
- HLS: {@linksource shaka.hls.HlsParser}

__Subtitle/caption parsers__
- Selected by MIME type
- Register with {@link shaka.media.TextEngine.registerParser}
- Default text parser plugins:
- WebVTT: {@linksource shaka.media.VttTextParser}
- WebVTT: {@linksource shaka.media.VttTextParser} and
{@linksource shaka.media.Mp4VttParser}
- TTML: {@linksource shaka.media.TtmlTextParser} and
{@linksource shaka.media.Mp4TtmlParser}

__Networking plugins__
- Selected by URI scheme (http, https, etc.)
Expand All @@ -59,6 +63,8 @@ __Polyfills__
- prefixed EME implementations for IE 11 and very old versions of embedded
Chrome/Chromium: {@linksource shaka.polyfill.MediaKeys}
- Promise implementation for IE 11: {@linksource shaka.polyfill.Promise}
- variants of VTTCue and TextTrackCue constructors:
{@linksource shaka.polyfill.VTTCue}


#### Excluding Default Plugins
Expand All @@ -68,7 +74,7 @@ technically optional. For example, if you don't need WebVTT, you can exclude
our VTT parser from the build to save space. Any VTT text streams found in a
manifest would then be ignored.

*(At the time of this writing, our default plugins account for 43% of the size
*(At the time of this writing, our default plugins account for 54% of the size
of our compiled library.)*

Because each plugin's source file ends with a call to register itself with the
Expand Down

0 comments on commit 395cc17

Please sign in to comment.