Commit Graph

215 Commits

Author SHA1 Message Date
Joey Parrish e298fb60fc Update muxjs to use new keepOriginalTimestamps option
Depended on issue videojs/mux.js#168

Issue #1194

Change-Id: Ia2ad5c17ad82a2c53215d34fbfec7be1d119df95
2018-01-18 20:18:09 +00:00
theodab 27ffe4d23a Add an FAQ entry for handling file:// requests
Closes #1222

Change-Id: I5cb9dcb07d65d839aa4809faaea9bf2273c69c68
2018-01-16 15:03:55 -08:00
Aaron Vaage d8cc658606 Removed Extra </span>
In the offline tutorial there was an extra closing tag for
a span tag.

Change-Id: I4ac2691b362bcd2c8c9ff61d8faf4770a3e428e6
2018-01-05 10:47:38 -08:00
Joey Parrish 1a2c88745e Upgrade the Closure compiler to v20171203
Change-Id: Id0dd4619db0c3a141d60e9e38757739e0697e6f0
2018-01-03 15:07:02 -08:00
Darío Hereñú b7f783d3c7 Fixing Typo in upgrade-v1 docs
Fixing a typo in docs/tutorials/upgrade-v1.md
2018-01-02 09:24:27 -08:00
Joey Parrish 9a69e26a86 Fix upgrade guide links
Change-Id: Ia5427a5b50850e820b04dbf5ba66b2146820f3a1
2017-12-22 15:15:54 -08:00
Joey Parrish ab0db55d27 Update upgrade tutorials to target v2.3
Also adds:
 - Missing details on a deprecated config field in the v2.2 => v2.3
   upgrade guide & changelog
 - Missing details about new language/role APIs in the v2.2 => v2.3
   upgrade guide

Closes #1183

Change-Id: I57e8bf4e56ffb1d741b691cdeaeb22e435c26e41
2017-12-20 15:56:35 -08:00
Joey Parrish 918a122a57 Update service worker caching docs
Issue #1183

Change-Id: If6eb7add692e31efa99008773f4107ea45cc3013
2017-12-20 03:02:52 +00:00
Joey Parrish e23bfb3a24 Update manifest parser tutorial
Issue #1183

Change-Id: Ic16e84f98cb45f2ecbba6da985f310e8f55b6b42
2017-12-20 03:02:52 +00:00
Joey Parrish 3f65d1c8a7 Update plugin tutorial
Issue #1183

Change-Id: If7024cbfabb7d85299162cb6488b5f44ed07febd
2017-12-20 03:02:52 +00:00
Joey Parrish 62e77876fa Update offline storage tutorial.
Issue #1183

Change-Id: I0ac267b2c620b9d28c3cf4a28c103e8ef772c368
2017-12-20 03:02:52 +00:00
Joey Parrish a17e904261 Add upgrade guide for v2.2 => v2.3
Issue #1183

Change-Id: Ib933603dd5ea35e1aa2c600970ce71a9a0a37b2e
2017-12-20 03:02:52 +00:00
Joey Parrish cd04cca269 Update config tutorial examples
Issue #1183

Change-Id: If3f9eb587c87babe7a8b43b5ced7d1b80205b1c1
2017-12-18 22:14:42 +00:00
Joey Parrish 4372d482b2 Update FAQ
Issue #1183

Change-Id: I1830b1343b11567643ef1994113265c037662701
2017-12-16 10:41:44 -08:00
Joey Parrish 08601defc8 Refactor README.md and welcome.md
README.md duplicated some information from welcome.md, included other
details better left to welcome.md, and did not provide clear enough
information about support and features.

This moves some parts of README.md to welcome.md, drops others, adds
some details about feature set, and reformats some of the existing
support information into tables.

Change-Id: Ic863bc47fd46d01ca57d126654b2c9902a4b17bb
2017-11-28 00:14:32 +00:00
Joe Medley 1cf25d433a Correct name of init function. (#1124) 2017-11-14 11:58:49 -08:00
Joey Parrish 5f81a464bd Update address of Widevine proxy to UAT
The appspot proxy address has been deprecated. UAT is now preferred.

Change-Id: I7a5f5eac554ec70eec83218d79f4927becd23828
2017-10-31 09:12:05 -07:00
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
Aaron Vaage d85abe86da Offline Tutorial
This change include the offline tutorial to show users how to set up
storage and use offline playback.

Change-Id: I470bfc6761a433116a766d338ac2a87eee1bde28
2017-10-18 18:45:19 +00:00
Joey Parrish 37753aaa9a Update docs with regard to text namespace
We moved TextEngine to a new namespace between v2.1 and v2.2, but
forgot to update the relevant docs.

Closes #1046

Change-Id: Ifddbe03931b2e76cc4778aaa4c3c70695a2dce62
2017-10-03 20:48:41 +00:00
Jacob Trimble c9aca1aeb9 Add CORS explanations to tutorial.
Closes #1018

Change-Id: I0ec915fe37b3cc62aff0184f2306297b388db701
2017-09-26 17:17:23 +00:00
Joey Parrish c7cd714b0d Fix FAQ typo
Change-Id: I6f2cd0b383ab849e7b4b0d14929b7c4b16dfa8e4
2017-08-31 20:05:37 +00:00
Joey Parrish 16f3965496 Update FAQ with regard to error codes
We no longer use UNPLAYABLE_PERIOD when TS is unsupported.

Change-Id: Ic6278e8eda62d8fd55697c64226a4ac868078a1e
2017-08-14 15:04:30 -07:00
Joey Parrish 7d42496a59 Fix upgrade guide titles and links
Change-Id: Ie6f5abde281ae7f2f1c6552f749a82d91694c736
2017-08-11 16:04:33 -07:00
Joey Parrish 2af0de2adb Move streaming retry logic into callback
Closes #960

Change-Id: Ieeacbf2e25f53a5af25a1de1935085e43457a092
2017-08-10 20:27:53 +00:00
Joey Parrish 53c3ad776c Fix order of operations in ABR upgrade docs
ABR should be disabled before selecting a new track.  The demo app
does it right, but the upgrade docs had it in the wrong order.

Closes #962

Change-Id: I57020098f24401c7d56acfe050cf2363cd22621f
2017-08-10 18:32:24 +00:00
Joey Parrish 37ebcffbfe Add player.retryStreaming()
This method will allow applications to retry streaming after a
failure.

Issue #960

Change-Id: I2c97f6dea44dbc9431182172101f99d740ea177f
2017-08-10 10:54:34 -07:00
Joey Parrish 7e0f46931e Overhaul variant-based and stream-based interfaces
While I set out to fix failing assertions during playback, I found
many more changes necessary to clean up the code and make things more
consistent.

When we changed switch history to include variants instead of streams,
we broke the filtering logic that is applied to the history.  This
caused assertions at runtime that were not caught by the tests.

This moves the filtering logic to addToSwitchHistory_ and makes it
aware of variants.  It also adds a regression test that would have
caught the assertions.

This fix affected many other tests, though, which necessitated other
API changes and cleanup.

Many interfaces are simplified, as is switching logic in Player.  The
data flow is also easier to follow, since there are fewer transitions
between variant and stream.  Everything up to StreamingEngine uses
Variants, and StreamingEngine uses Streams internally.

  - All stream-based interfaces on AbrManager replaced
    - switch callback takes a variant
    - chooseStreams replaced with chooseVariant
    - setTextStreams has been dropped
    - Player maintains compatibility with old interfaces until v2.3

  - Most stream-based interfaces on StreamingEngine replaced
    - onChooseStreams callback to Player returns variant & text
      instead of a stream map
    - switch was replaced with switchVariant and switchTextStream,
      both of which delegate to switchInternal_, which is largely
      unchanged from the original switch method
    - still has getActiveStreams, which I hope some day can become
      getActiveVariant and getActiveTextStream so Player no longer
      has to convert anything

  - Most stream-based logic in Player replaced
    - deferred switches map broken into variant and text members
    - switch history logging broken into simpler variant and text
      methods
    - simplified manual and automatic track selection logic using
      new AbrManager and StreamingEngine APIs
    - player no longer filters duplicate selections, StreamingEngine
      handles that
    - replaced one case of deferred switches with an assertion

Closes #954

Change-Id: Ia49f6ffb9c5fa13ed8790dd03eeeded5122f7683
2017-08-03 21:34:47 +00:00
Joey Parrish 015b4f456f Revert timeline correction code.
This reverts commit 478fb1a473
("Detect and attempt to correct timeline sync issues") and commit
4334b6ea90 ("Add mediaSegmentReferences
 to shakaExtern.Stream").

Timeline correction only addresses one class of broken live content,
while actually making it more difficult to diagnose other classes of
broken live content.

Issue #933

Change-Id: Ie71b8a45600ed0994626f53268fb90e336c3c62b
2017-07-31 10:42:33 -07:00
Sandra Lokshina 978e49789e Update upgrade guides with v2.2 changes.
Closes #930.

Change-Id: Ie31f6f1e90df6dd4a768f7a662d68e31d6014bea
2017-07-25 20:23:52 +00:00
Joey Parrish 4334b6ea90 Add mediaSegmentReferences to shakaExtern.Stream.
This will allow us, in many cases, to detect time sync issues in
content by comparing the media segment references to the presentation
timeline.  If the references are outside the timeline, it may indicate
a common form of bad content, and we may be able to attempt to correct
it.

In some cases, the references are not available upfront.  We can't
detect time sync issues in DASH with SegmentTemplate+duration, because
the references are not explicitly described by the manifest.  We can't
detect time sync issues in DASH with SegmentBase, because the segment
index requires additional fetching and parsing.  (SegmentBase is not
used with live content, so this should be a non-issue.)

This only introduces the new data, but does not use it for detection
or correction yet.

Issue #933

Change-Id: If70b1bdbd3b08a7c8b7ae296da209737492dfe17
2017-07-25 20:13:42 +00:00
Joey Parrish 6ca00260ee Emphasize HTTPS requirement for EME in tutorials
- Move the note about EME and HTTP to the top of the DRM config
   tutorial
 - Reference this note in both the server authentication and license
   wrapping tutorials

Closes #928

Change-Id: Ibb47053c6ce5db1e1b120e0bb810c1f9f9069a82
2017-07-17 09:23:39 -07:00
Sandra Lokshina 5e8fc2065d Update HLS TS question in FAQ.
Update HLS TS question in FAQ to include info about our ongoing
effort on transmuxing TS to fMP4. This will let people know that
the solution is coming and subscribe to the issue on github.

Change-Id: I9b90e4c355834573a0d23472a2ffd369847ddb16
2017-06-22 21:08:33 +00:00
Jacob Trimble 678390b92a Update tutorials and add another FAQ entry.
Closes #862
Closes #866
Closes #867

Change-Id: I8e97750ddc9851a9d893f0d9aadab234a1deb988
2017-06-21 23:35:50 +00:00
Joey Parrish 65785451b0 Add FAQ entry about buffering and ABR interactions
Also changes some formatting on the existing entries.

Closes #864

Change-Id: I11f2c3f905c43c28649786837c9ea678227002f4
2017-06-09 23:53:38 +00:00
Joey Parrish 2f7a5b6059 Build the FAQ into the tutorials
The FAQ file had to be moved into the tutorials folder to make this
work for some reason.  JSDoc did not want to take "../faq" as a name.

Closes #865

Change-Id: I63ff5b181f494d72c04eaa054111d9fdc866064c
2017-06-09 23:53:38 +00:00
Aaron Vaage bc8fcaeb06 Update Welcome Docs
NPM released a new version which no longer work with the version
of Node we install in the docs. By updating NPM and Node they
play nicely with each other and no longer need the symlink.

Tested on a clean VM using:
  Distributor ID: Ubuntu
  Description:    Ubuntu 14.04.5 LTS
  Release:        14.04
  Codename:       trusty

Change-Id: Ie4a2cce194944ea57b542b01d072dfff8a8b40b3
2017-06-09 21:59:48 +00:00
bhh1988 41eac10c08 Stop infinitely retrying on network errors for VOD (#842)
Do not infinitely retry on top of the retry-policy already defined by
RetryParameters, especially for VOD. For live video the previous retry
logic is still useful to be robust against clock-sync or asset
availability issues. This commit adds a boolean configuration parameter,
infiniteRetriesForLiveStreams, to allow the user to turn this behavior
off even for live video.

Fixes #830 and #762
2017-06-05 10:42:09 -07:00
Joey Parrish 82d8669bcb Add notes on adaptation to upgrade guide
Change-Id: Ia0ab28deb415b35a7fda94ee9ef288e32b292c50
2017-05-12 15:56:33 -07:00
Joey Parrish 677dc1c7e8 Tutorial cleanup
Add a note that language configs affect the next load.

Change the example in build customization to one that works.

Change-Id: I3baa962fdb0d31c57c195385c9ab9da309fe9c29
2017-04-25 17:43:31 +00:00
Joey Parrish 395cc1745e Update the upgrade guides for v2.1
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
2017-04-20 23:39:27 +00:00
Jacob Trimble d1bc3fdb71 Add manifest parser plugin tutorial.
Change-Id: I4e5b1d7ece7df8f006ca6261a74cd8eb38bfd037
2017-04-06 19:26:40 +00:00
Jacob Trimble 40bd34d8ac Add support for special cache header.
This allows network responses to have an X-Shaka-From-Cache header to
indicate that the response was somehow from a cache and should be
ignored for bandwidth calculations.  For example, this can be from a
service worker intercepting the request.

Change-Id: I4dfdf4211921b7205febb58f1e80967f0c4841cd
2017-03-03 19:53:17 +00:00
Jacob Trimble cbbc61ec4c Add a diagram for the PresentationTimeline
Change-Id: I6ca8dcd88e56daaf99820816ca9f3c9f02a2076f
2017-02-27 17:06:30 -08:00
Joey Parrish fd1786b7a9 Add asynchronous filter example in the tutorials
This adds an example of using asynchronous filters for authentication.

Closes #610

Change-Id: Idf47558af4c399178ff3806f944d69909ee2fd7a
2017-02-07 16:18:27 -08:00
Joey Parrish 836bd9a177 Make filters, requests, and responses easier
By exporting StringUtils and Uint8ArrayUtils, we can simplify the
process of wrapping, unwrapping, and parsing requests and responses
in NetworkingEngine filters.

This makes it easier to write filters that deal with text-based
data, as it is no longer the job of the application developer to
deal with subtle conversions between string and ArrayBuffer.

We will also fill in requests with defaults if needed.  This allows
developers to omit fields when initiating extra requests at the
application level.

Closes #667

Change-Id: Ie6a0f23b4d46e7e458d996759eac6cd85a36b741
2017-02-08 00:09:08 +00:00
Jacob Trimble b452db8986 Add offline storage to v2 upgrade guide.
Change-Id: I47e947bd9247013351ec1505ee577f76a8c80e94
2017-02-03 22:51:33 +00:00
Jacob Trimble 79ea0f0854 Update documentation for Tracks.
Closes #679

Change-Id: I7a7fa6534f328a79fdce2b7b8cd6cd60fec210fc
2017-02-03 22:50:49 +00:00
Jacob Trimble 3f4eb4a111 Add additional docs for AbrManager.
Issue #629

Change-Id: I9548c24078e07537ae4c1e6f28461c992f5f794e
2017-01-27 23:19:13 +00:00
Joey Parrish 43e086dbaf Update the debugging tutorial for clarity
This updates the debugging tutorial to clarify a few things:
 - Formatting in the sample console output is not exact
 - Log level should be set in the top of initApp() before we construct
   the Player object
 - Verbose messages are only seen after we change the log level and
   reload

Closes #653

Change-Id: Id0d7dabff225c3d82a9c54c05bb356a0bfa9b241
2017-01-20 10:28:34 -08:00