Skip to content

Commit

Permalink
docs: Clarify bandwidth estimation docs. (shaka-project#6547)
Browse files Browse the repository at this point in the history
This adds more information to the docs for defaultBandwidthEstimate and
useNetworkInformation, to make it clearer that they are mutually
exclusive.

Closes shaka-project#4691
  • Loading branch information
theodab authored and joeyparrish committed May 7, 2024
1 parent f49c067 commit 5c9a2b7
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions externs/shaka/player.js
Original file line number Diff line number Diff line change
Expand Up @@ -1376,11 +1376,14 @@ shaka.extern.AdsConfiguration;
* @property {boolean} enabled
* If true, enable adaptation by the current AbrManager. Defaults to true.
* @property {boolean} useNetworkInformation
* If true, use Network Information API in the current AbrManager.
* If true, use the Network Information API in the current AbrManager, if it
* is available in the browser environment. If the Network Information API is
* used, Shaka Player will ignore the defaultBandwidthEstimate config.
* Defaults to true.
* @property {number} defaultBandwidthEstimate
* The default bandwidth estimate to use if there is not enough data, in
* bit/sec.
* bit/sec. Only used if useNetworkInformation is false, or if the Network
* Information API is not available.
* @property {shaka.extern.Restrictions} restrictions
* The restrictions to apply to ABR decisions. These are "soft" restrictions.
* Any track that fails to meet these restrictions will not be selected
Expand Down

0 comments on commit 5c9a2b7

Please sign in to comment.