shaka-player 4.6.4 → 4.7.0

package/docs/jsdoc-template/tmpl/params.tmpl

@@ -1,131 +0,0 @@
-<?js
-    var params = obj;
-
-    /* sort subparams under their parent params (like opts.classname) */
-    var parentParam = null;
-    params.forEach(function(param, i) {
-        var paramRegExp;
-
-        if (!param) {
-            return;
-        }
-
-        if (parentParam && parentParam.name && param.name) {
-            try {
-                paramRegExp = new RegExp('^(?:' + parentParam.name + '(?:\\[\\])*)\\.(.+)$');
-            }
-            catch (e) {
-                // there's probably a typo in the JSDoc comment that resulted in a weird
-                // parameter name
-                return;
-            }
-
-            if ( paramRegExp.test(param.name) ) {
-                param.name = RegExp.$1;
-                parentParam.subparams = parentParam.subparams || [];
-                parentParam.subparams.push(param);
-                params[i] = null;
-            }
-            else {
-                parentParam = param;
-            }
-        }
-        else {
-            parentParam = param;
-        }
-    });
-
-    /* determine if we need extra columns, "attributes" and "default" */
-    params.hasAttributes = false;
-    params.hasDefault = false;
-    params.hasName = false;
-
-    params.forEach(function(param) {
-        if (!param) { return; }
-
-        if (param.optional || param.nullable || param.variable) {
-            params.hasAttributes = true;
-        }
-
-        if (param.name) {
-            params.hasName = true;
-        }
-
-        if (typeof param.defaultvalue !== 'undefined') {
-            params.hasDefault = true;
-        }
-    });
-?>
-
-<table class="params">
-    <thead>
-    <tr>
-        <?js if (params.hasName) {?>
-        <th>Name</th>
-        <?js } ?>
-
-        <th>Type</th>
-
-        <?js if (params.hasAttributes) {?>
-        <th>Attributes</th>
-        <?js } ?>
-
-        <?js if (params.hasDefault) {?>
-        <th>Default</th>
-        <?js } ?>
-
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-
-    <tbody>
-    <?js
-        var self = this;
-        params.forEach(function(param) {
-            if (!param) { return; }
-    ?>
-
-        <tr>
-            <?js if (params.hasName) {?>
-                <td class="name"><code><?js= param.name ?></code></td>
-            <?js } ?>
-
-            <td class="type">
-            <?js if (param.type && param.type.names) {?>
-                <?js= self.partial('type.tmpl', param.type.names) ?>
-            <?js } ?>
-            </td>
-
-            <?js if (params.hasAttributes) {?>
-                <td class="attributes">
-                <?js if (param.optional) { ?>
-                    &lt;optional><br>
-                <?js } ?>
-
-                <?js if (param.nullable) { ?>
-                    &lt;nullable><br>
-                <?js } ?>
-
-                <?js if (param.variable) { ?>
-                    &lt;repeatable><br>
-                <?js } ?>
-                </td>
-            <?js } ?>
-
-            <?js if (params.hasDefault) {?>
-                <td class="default">
-                <?js if (typeof param.defaultvalue !== 'undefined') { ?>
-                    <?js= self.htmlsafe(param.defaultvalue) ?>
-                <?js } ?>
-                </td>
-            <?js } ?>
-
-            <td class="description last"><?js= param.description ?><?js if (param.subparams) { ?>
-                <h6>Properties</h6>
-                <?js= self.partial('params.tmpl', param.subparams) ?>
-            <?js } ?></td>
-        </tr>
-
-    <?js }); ?>
-    </tbody>
-</table>

package/docs/jsdoc-template/tmpl/properties.tmpl

@@ -1,125 +0,0 @@
-<?js
-    var data = obj;
-    var props = data.subprops || data.properties;
-
-    /* sort subprops under their parent props (like opts.classname) */
-    var parentProp = null;
-    props.forEach(function(prop, i) {
-        if (!prop) { return; }
-        if ( parentProp && prop.name && prop.name.indexOf(parentProp.name + '.') === 0 ) {
-            prop.name = prop.name.substr(parentProp.name.length+1);
-            parentProp.subprops = parentProp.subprops || [];
-            parentProp.subprops.push(prop);
-            props[i] = null;
-        }
-        else {
-            parentProp = prop;
-        }
-    });
-
-    /* determine if we need extra columns, "attributes" and "default" */
-    props.hasAttributes = false;
-    props.hasDefault = false;
-    props.hasName = false;
-
-    props.forEach(function(prop) {
-        if (!prop) { return; }
-
-        if (prop.optional || prop.nullable) {
-            props.hasAttributes = true;
-        }
-
-        if (prop.name) {
-            props.hasName = true;
-        }
-
-        if (typeof prop.defaultvalue !== 'undefined') {
-            props.hasDefault = true;
-        }
-    });
-?>
-
-<table class="props">
-    <thead>
-    <tr>
-        <?js if (props.hasName) {?>
-        <th>Name</th>
-        <?js } ?>
-
-        <?js if (props.hasDefault && data.isEnum) {?>
-        <th>Value</th>
-        <?js } ?>
-
-        <th>Type</th>
-
-        <?js if (props.hasAttributes) {?>
-        <th>Attributes</th>
-        <?js } ?>
-
-        <?js if (props.hasDefault && !data.isEnum) {?>
-        <th>Default</th>
-        <?js } ?>
-
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-
-    <tbody>
-    <?js
-        var self = this;
-        props.forEach(function(prop) {
-            if (!prop) { return; }
-    ?>
-
-        <?js if (props.hasDefault && data.isEnum) {?>
-        <tr class="enum" id="value:<?js= self.htmlsafe(prop.defaultvalue) ?>">
-        <?js } else { ?>
-        <tr>
-        <?js } ?>
-
-            <?js if (props.hasName) {?>
-                <td class="name"><code><?js= prop.name ?></code></td>
-            <?js } ?>
-
-            <?js if (props.hasDefault && data.isEnum) {?>
-                <td class="default">
-                <?js if (typeof prop.defaultvalue !== 'undefined') { ?>
-                    <?js= self.htmlsafe(prop.defaultvalue) ?>
-                <?js } ?>
-                </td>
-            <?js } ?>
-
-            <td class="type">
-            <?js if (prop.type && prop.type.names) {?>
-                <?js= self.partial('type.tmpl', prop.type.names) ?>
-            <?js } ?>
-            </td>
-
-            <?js if (props.hasAttributes) {?>
-                <td class="attributes">
-                <?js if (prop.optional) { ?>
-                    &lt;optional><br>
-                <?js } ?>
-
-                <?js if (prop.nullable) { ?>
-                    &lt;nullable><br>
-                <?js } ?>
-                </td>
-            <?js } ?>
-
-            <?js if (props.hasDefault && !data.isEnum) {?>
-                <td class="default">
-                <?js if (typeof prop.defaultvalue !== 'undefined') { ?>
-                    <?js= self.htmlsafe(prop.defaultvalue) ?>
-                <?js } ?>
-                </td>
-            <?js } ?>
-
-            <td class="description last"><?js= prop.description ?><?js if (prop.subprops) { ?>
-                <h6>Properties</h6><?js= self.partial('properties.tmpl', prop) ?>
-            <?js } ?></td>
-        </tr>
-
-    <?js }); ?>
-    </tbody>
-</table>

package/docs/jsdoc-template/tmpl/returns.tmpl

@@ -1,19 +0,0 @@
-<?js
-var data = obj || {};
-if (data.description) {
-?>
-<div class="param-desc">
-    <?js= description ?>
-</div>
-<?js } ?>
-
-<?js if (data.type && data.type.names) {?>
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        <?js= this.partial('type.tmpl', data.type.names) ?>
-    </dd>
-</dl>
-<?js } ?>

package/docs/jsdoc-template/tmpl/source.tmpl

@@ -1,8 +0,0 @@
-<?js
-    var data = obj;
-?>
-    <section>
-        <article>
-            <pre class="prettyprint source linenums"><code><?js= data.code ?></code></pre>
-        </article>
-    </section>

package/docs/jsdoc-template/tmpl/tutorial.tmpl

@@ -1,21 +0,0 @@
-<section>
-
-<!--
-<header>
-    <?js if (children.length > 0) { ?>
-    <ul><?js
-        var self = this;
-        children.forEach(function(t) { ?>
-        <li><?js= self.tutoriallink(t.name) ?></li>
-    <?js }); ?></ul>
-    <?js } ?>
-
-    <h2><?js= header ?></h2>
-</header>
--->
-
-<article>
-    <?js= content ?>
-</article>
-
-</section>

package/docs/jsdoc-template/tmpl/type.tmpl

@@ -1,7 +0,0 @@
-<?js
-    var data = obj;
-    var self = this;
-    data.forEach(function(name, i) { ?>
-<span class="param-type"><?js= self.linkto(name, self.htmlsafe(name)) ?></span>
-<?js if (i < data.length-1) { ?>|<?js } ?>
-<?js }); ?>

package/docs/jsdoc.conf.json

@@ -1,38 +0,0 @@
-{
-  "tags": {
-    "dictionaries": [ "closure", "jsdoc" ]
-  },
-  "source": {
-    "include": [
-      "lib",
-      "ui",
-      "externs/shaka"
-    ]
-  },
-  "templates": {
-    "default": {
-      "sortTutorialsByConfigOrder": true,
-      "useLongnameInNav": true,
-      "navOrder": [
-        "Tutorials",
-        "Classes",
-        "Enums",
-        "Interfaces",
-        "Events"
-      ]
-    }
-  },
-  "plugins": [ "docs/jsdoc-plugin" ],
-  "markdown": {
-    "idInHeadings": true
-  },
-  "opts": {
-    "pedantic": true,
-    "private": true,
-    "recurse": true,
-    "readme": "docs/api-mainpage.md",
-    "tutorials": "docs/tutorials",
-    "template": "docs/jsdoc-template",
-    "destination": "docs/api"
-  }
-}

package/docs/style.md

@@ -1,174 +0,0 @@
-# Style and Practices
-
-## Readability
-
-General rule, if someone in the team doesn't understand it, someone in the
-community won't either.
-
-If someone asks a question, don't just leave a comment in the review. Make a
-change in the code (e.g. add a comment, change a variable name, move a logical
-structure) to improve the readability of the code.
-
-Some guidelines to avoid non-readable patterns are to:
-
-### Avoid Function Apply
-
-Using the `apply` functionality of any function
-(e.g.`Array.prototype.push.apply`) has been deemed non-readable.
-
-
-## Non-Functional Changes
-
-Isolated changes that enhance readability - and not just based on preference -
-are encouraged.
-
-Wide-spread practices should be proposed to the Shaka Player team as it's own
-issue and someone from the team will discuss it with you and say on whether they
-are accepted and executed.
-
-## Practices
-
-### Static vs Member
-
-A function should only be static when it doesn't modify the class's state.
-Modifying the class's state is defined as using the same references under "this"
-in the same way for each call.
-
-Example
-
-Member Function
-
-```
-X = class {
-  doSomething() {
-    // a lot of math
-    // …
-    result = ...
-    this.fast.doSomething(result);
-  }
-};
-```
-
-Static Function
-
-```
-X = class {
-  doSomethingFast() {
-    X.doSomething(this.fast);
-  }
-  doSomethingSlow() {
-    X.doSomething(this.slow);
-  }
-  static doSomething(target) {
-    // a lot of math
-    // …
-    result = ...
-    target.doSomething(result);
-  }
-};
-```
-
-### Function Declaration
-
-__Definitions__
-
--   "Arrow-Function" means using the `() => {}` syntax in ES6.
-
--   "Function-Function" means using the `function() {}` syntax.
-
-While using the pre-ES6 syntax for classes, all functions defined on the class
-(member or static) should use Function-Functions.
-
-Arrow-Functions should be used within other functions unless there is an
-explicit need to control the this-scope of the function, for example:
-
--   All polyfills need to use Function-Functions as they require controlling
-    `this`.
-
--   All functions expecting to be called with "new" must use Function-Functions
-    as they need a new `this`.
-
-### Const and Let
-
-We use two forms of assignment: `const` and `let`:
-
--   `const x = y` means that `x` is to be assigned the value of `y` and may not
-    be reassigned later. However members of `x` may be changes (e.g. `x.z = 3`).
-
--   `let x = y` means that `x` is to be assigned the value of `y` and may be
-    reassigned later.
-
-Unless a variable need to support reassignment, it should use `const`. A
-variable declared with `const` but never assigned will hold the value
-"undefined".
-
-### Async and Await
-
-When working with promises, we recommended to use `async` and `await`. We find
-they improve readability by making the code more linear than `then` and `catch`
-blocks.
-
-Any function that is labeled as `async` will allow you to use `await`. A
-function that is labeled as `async` looks like:
-
- - `const f = async function () { ... };`
-
-- `const f = async () => { };`
-
-- `class X { async f() { ... } }`
-
-Using `await` will stop execution of the current function and wait for the
-"awaited" promise to resolve before continuing execution, for example:
-
-```
-  await sleep(5);
-```
-
-`await` will also allow you to store the result of a promise while not changing
-scope, for example:
-
-```
-  const response = await networkingEngine.request(...);
-```
-
-### Shadowing Parameters
-
-Shadowing a parameter is defined as "reassigning the value of a parameter passed
-to a function while within the function".
-
-This is allowed only when normalizing the value, for example:
-
--   `x = x || defaultValue`
-
--   `x = x.toLowerCase()`
-
-### Array Traversal
-
-Whatever means of traversing an array that supports readability is allowed,
-however there are some recommendations:
-
--   Default to the "for-of" pattern
--   Use `forEach` if using other array functions (e.g. filter) at the same time
--   Avoiding using indexes unless the index is needed
--   Do not use "await" in a loop (not allowed by ESLint). Instead use
-    |Promise.all|.
-
-### Building Arrays
-
-Whatever means of building an array that supports readability is allowed,
-however some patterns for simple cases are encouraged:
-
-#### Simple Transformation
-
-__Before__
-
-```
-const audio = [];
-variants.forEach((variant) => audio.push(variant.audio));
-```
-
-__After__
-
-```
-const audio = variants.map((variant) => variant.audio);
-```

package/docs/tutorials/a11y.md

@@ -1,64 +0,0 @@
-# Creating accessible custom buttons.
-
-
-All Shaka-provided UI elements follow the [Web Accessibility Standards][],
-meaning that people who use screen readers to surf the web still get their full
-functionality even though they might not be able to see the elements.
-
-Creating accessible buttons is really easy, and we encourage all applications
-to do it. With just a few lines of code, your custom elements can become
-accessible for everyone!
-
-We use [ARIA labels][] to tell screen readers what the button is for.
-Let's take our skip button from the Customization tutorial and add an aria label to it:
-
-```js
-// skipButton.js
-
-// Use shaka.ui.Element as a base class
-myapp.SkipButton = class extends shaka.ui.Element {
-  constructor(parent, controls) {
-    super(parent, controls);
-
-    // The actual button that will be displayed
-    this.button_ = document.createElement('button');
-    this.button_.textContent = 'Skip current video';
-    // Screen readers will read "skip button"
-    this.button_.setAttribute('aria-label', 'Skip');
-    this.parent.appendChild(this.button_);
-  }
-};
-```
-
-Please note that you might need to update the aria label if the button changes its purpose.
-Let's say, we want the skip button to take us to the first video of the playlist if we're
-currently watching the last one. We can change the button's icon to visually emphasize
-new behavior. These changes, however, won't affect someone using a screen reader, so we
-will need to change the aria-label as well.
-
-```js
-this.eventManager.listen(this.button_, 'click', () => {
-  const nextManifest = /* Your logic to pick the next video to be played */
-    myapp.getNextManifest();
-
-  this.player.load(nextManifest);
-
-  if (this.isLastManifest(nextManifest)) {
-    // This is the last video. Change icon and aria label.
-    this.button_.icon = goToBeginningIcon;
-    // Screen readers will read "Go to the first video button"
-    this.button_.setAttribute('aria-label', 'Go to the first video');
-  } else if (this.isFirstManifest(nextManifest)){
-    // Change icon and aria label back to the skip state
-    this.button_.icon = skipIcon;
-    this.button_.setAttribute('aria-label', 'Skip');
-  }
-});
-```
-
-
-
-[Web Accessibility Standards]: https://www.w3.org/WAI/standards-guidelines/wcag/
-[ARIA labels]: https://www.w3.org/TR/wai-aria/
-[volume_up icon]: https://material.io/tools/icons/?icon=volume_up&style=baseline
-[volume_off icon]: https://material.io/tools/icons/?icon=volume_off&style=baseline