Skip to content

Commit

Permalink
Small Refinements on Documentation (#536)
Browse files Browse the repository at this point in the history
* Add tutorial tag to shakaExtern.RetryParameters

Properties like `backoffFactor` or `fuzzFactor` is a little difficult to
understand for new users.  Link to the tutorial to explain.

* Additional Description to Sample Code

Explains why request.uris is an array.
  • Loading branch information
toshi0383 authored and joeyparrish committed Oct 19, 2016
1 parent 467d1a0 commit 6cb078d
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 0 deletions.
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,5 @@ Roi Lipman <roilipman@gmail.com>
SameGoal Inc. <*@samegoal.com>
Sanborn Hilland <sanbornh@rogers.com>
TalkTalk Plc <*@talktalkplc.com>
Toshihiro Suzuki <t.suzuki326@gmail.com>
uStudio Inc. <*@ustudio.com>
1 change: 1 addition & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,6 @@ Sanborn Hilland <sanbornh@rogers.com>
Seth Madison <seth@philo.com>
Thomas Stephens <thomas@ustudio.com>
Timothy Drews <tdrews@google.com>
Toshihiro Suzuki <t.suzuki326@gmail.com>
Vasanth Polipelli <vasanthap@google.com>
Vignesh Venkatasubramanian <vigneshv@google.com>
3 changes: 3 additions & 0 deletions docs/tutorials/license-server-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,9 @@ We can use a request filter to modify the URL and add the required parameter:
// Only add headers to license requests:
if (type == shaka.net.NetworkingEngine.RequestType.LICENSE) {
// This is the specific parameter name and value the server wants:
// Note that all network requests can have multiple URIs (for fallback),
// and therefore this is an array. But there should only be one license
// server URI in this tutorial.
request.uris[0] += '?CWIP-Auth-Param=VGhpc0lzQVRlc3QK';
}
});
Expand Down
2 changes: 2 additions & 0 deletions externs/shaka/net.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@
* @property {number} timeout
* The request timeout, in milliseconds. Zero means "unlimited".
*
* @tutorial network-and-buffering-config
*
* @exportDoc
*/
shakaExtern.RetryParameters;
Expand Down

0 comments on commit 6cb078d

Please sign in to comment.