Commit Graph

29 Commits

Author SHA1 Message Date
Vinod Balakrishnan c1e18d3583 feat: Migration of LCEVC DIL (Decoder Integration Layer) to LCEVC Dec (Decoder) (#5459) 2023-10-03 09:00:26 +02:00
Joey Parrish 472bcbbcff docs: Add Widevine Service Certificate tutorial (#5018)
Also fixes a related typo in the FairPlay tutorial and adds a missing
entry to the tutorial index.
2023-02-23 11:56:39 -08:00
Joey Parrish d8b3341720 test: Run tests on a custom Selenium grid (#4117)
Includes a YAML config file for our lab, and documentation on how to
create a custom config for another Selenium grid.

A workflow will run tests nightly in the Shaka lab, using a
self-hosted runner with access to our private grid.

The workflow can also be triggered manually by maintainers to test a
PR in the lab.  This will report status back to the PR.
2022-04-12 11:32:59 -07:00
Joey Parrish ac5acc80cb feat!: Remove deprecated features, update upgrade guides (#4089)
Below are the changelog entries for each deprecated feature removed by this commit.

-----

feat(config)!: `manifest.dash.defaultPresentationDelay` has been replaced by `manifest.defaultPresentationDelay` (deprecated in v3.0.0)

feat(config)!: Configuration of factories should be plain factory functions, not constructors; these will not be invoked with `new` (deprecated in v3.1.0)

feat(player)!: `shaka.Player.prototype.addTextTrack()` has been replaced by `addTextTrackAsync()`, which returns a `Promise` (deprecated in v3.1.0)

feat(ui)!: `shaka.ui.TrackLabelFormat` has been renamed to `shaka.ui.Overlay.TrackLabelFormat` (deprecated in v3.1.0)

feat(ui)!: `shaka.ui.FailReasonCode` has been renamed to `shaka.ui.Overlay.FailReasonCode` (deprecated in v3.1.0)

feat(offline)!: `shaka.offline.Storage.prototype.store()` returns `AbortableOperation` instead of `Promise` (deprecated in v3.0.0)

feat(offline)!: `shaka.offline.Storage.prototype.getStoreInProgress()` has been removed; concurrent operations are supported, so callers don't need to check this (deprecated in v3.0.0)

feat!: `shaka.util.Uint8ArrayUtils.equal` has been replaced by `shaka.util.BufferUtils.equal`, which can handle multiple types of buffers (deprecated in v3.0.0)

feat(manifest)!: `shaka.media.SegmentIndex.prototype.destroy()` has been replaced by `release()`, which is synchronous (deprecated in v3.0.0)

feat(manifest)!: `shaka.media.SegmentIterator.prototype.seek()`, which mutates the iterator, has been replaced by `shaka.media.SegmentIndex.getIteratorForTime()` (deprecated in v3.1.0)

feat(manifest)!: `shaka.media.SegmentIndex.prototype.merge()` has become private; use `mergeAndEvict()` instead (deprecated in v3.2.0)

feat(plugin)!: `AbrManager` plugins must implement the `playbackRateChanged()` method (deprecated in v3.0.0)

feat(plugin)!: `shaka.extern.Cue.prototype.spacer` has been replaced by the more clearly-named `lineBreak` (deprecated in v3.1.0)

feat(plugin)!: `IUIElement` plugins must have a `release()` method (not `destroy()`) (deprecated in v3.0.0)
2022-04-11 17:11:40 -07:00
Álvaro Velad Galván 0e02312597 docs: Add blob-url tutorial (#3586)
Closes #1481
2021-08-21 05:08:42 -07:00
Joey Parrish bfece76f10 docs: Update upgrade guides
This drops the v2.4 guide (no longer maintained), and adds a specific
guide for v3 changes (which are minimal).

Closes #3487

Change-Id: Id2e6d3ce92114ca5685787994cac7a5ed36a86e9
2021-07-08 20:56:45 +00:00
Joey Parrish 6f803bd176 docs: Add doc on Application-Level Redirects
This scheme came up recently while working with a partner on
integration with their streaming infrastructure.  This new doc will
clarify what an Application-Level Redirect is, how it works, and how
it can be supported with Shaka Player.

Change-Id: Ia532fa543c0efb98333c1a5a8ad5f2afbd7936fd
2020-08-20 17:28:47 +00:00
Joey Parrish aba5e2583c Rename v2.6 to v3.0 and v2.7 to v3.1
We have decided to bump the major version number instead of the minor
number, based primarily on the fact that this release breaks
compatibility with our previous manifest structure.

Change-Id: I67e4c8267c6e103cfc7278e09daac186ae5cbbc6
2020-05-29 17:50:22 +00:00
Joey Parrish 200a0e2b95 Update the upgrade guides for v2.6
Change-Id: Ie024e7048b44f2f78b7fe359c083196f52747323
2020-05-11 09:56:40 -07:00
Sandra Lokshina 943dfa756b Add a tutorial on serving ads.
Issue #1169.

Change-Id: Ibc3a987278374fba3422880ed4060bbb844e3729
2020-04-16 22:38:10 +00:00
Jacob Trimble ad996d6873 Add tutorial for FairPlay support.
Closes #1951

Change-Id: I2dac43117ef444cf0701b2195d4a0e93385e5d52
2019-08-05 17:25:34 +00:00
Joey Parrish 94fd088199 Update upgrade guides for v2.5
This also drops the oldest upgrade guides for v1 - v2.2, because they
were far too difficult to maintain.

Change-Id: I9552891376d34f48e6424e862bd980f8ecc274c7
2019-05-07 22:19:13 +00:00
Sandra Lokshina 3f04554926 Add tutorials on creating accessible buttons.
Change-Id: I203cffef9f73205a33b77a76aa85a2c5ad62451e
2019-02-06 19:28:23 +00:00
Sandra Lokshina 6b1ca2d229 Initial release of Shaka Player UI
Other contributors:
 - @joeyparrish
 - @michellezhuogg
 - @TheModMaker
 - @theodab
 - @vaage

Change-Id: If6df33d9ab5035d1ead4402004f7de37ee8470f4
2018-11-16 14:40:37 -08:00
Joey Parrish 6a02bd25d3 Update upgrade guides for v2.4
Closes #1342

Change-Id: I2cbb8933abe833afc74471efb6ad1e3e40bb1c28
2018-04-06 17:40:51 +00:00
Joey Parrish 9a69e26a86 Fix upgrade guide links
Change-Id: Ia5427a5b50850e820b04dbf5ba66b2146820f3a1
2017-12-22 15:15:54 -08: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
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 7d42496a59 Fix upgrade guide titles and links
Change-Id: Ie6f5abde281ae7f2f1c6552f749a82d91694c736
2017-08-11 16:04: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 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
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
Joey Parrish 2567d07576 Rewrite the debugging tutorial
This should be less awkward and artificial, and focuses more on the
debugging tools available than trying to solve a fictional problem.

Change-Id: Idc451115b777cea3ba84f68d489fe817f8bf0350
2016-09-26 11:06:19 -07:00
Joey Parrish 20ddb8a130 License-wrapping tutorial
Change-Id: I62d81f9c0a5b46c843c753ca64bdfc7d3f10b6a0
2016-05-13 07:47:04 +00:00
Joey Parrish 04d3df3ae8 Apply feedback from doc review
- Add prereqs section
  - Add architecture diagrams
  - Adjust doc margins
  - Change some wording and fix typos
  - Convert alert() to console.error() in basic usage tutorial
  - Expand prose in debugging tutorial
  - Add comments about asynchronous methods
  - Expand description of Closure base
  - Change some links to source rather than API docs
  - Clarify some vague language
  - Refactor some of the plugin text

Modified jsdoc to add a new 'linksource' tag to link directly to the
source code for an entity.

Change-Id: I6b879050fc59917ce98954a4fabd8afca60af456
2016-04-13 17:12:32 -07:00
Joey Parrish c29fdf401b Shaka v2 Upgrade Guide
Also fixes docs export on some of our external structures.

Change-Id: Ia31f2ad46c6f07845c289c6ca2f206a6fd6cf341
2016-04-13 21:15:40 +00:00
Joey Parrish c8e80cb58d Tutorials and other doc revisions
- 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
2016-04-06 19:17:51 +00:00