Source: ui/externs/ui.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  7. /**
  8.  * @externs
  9.  * @suppress {duplicate} To prevent compiler errors with the namespace
  10.  *   being declared both here and by goog.provide in the library.
  11.  */
  13. /** @namespace */
  14. var shaka = {};
  16. /** @namespace */
  17. shaka.extern = {};
  19. /**
  20.  * @typedef {{
  21.  *   base: string,
  22.  *   buffered: string,
  23.  *   played: string,
  24.  *   adBreaks: string
  25.  * }}
  26.  *
  27.  * @property {string} base
  28.  *   The CSS background color applied to the base of the seek bar, on top of
  29.  *   which the buffer level and playback position are shown.
  30.  * @property {string} buffered
  31.  *   The CSS background color applied to the portion of the seek bar showing
  32.  *   what has been buffered ahead of the playback position.
  33.  * @property {string} played
  34.  *   The CSS background color applied to the portion of the seek bar showing
  35.  *   what has been played already.
  36.  * @property {string} adBreaks
  37.  *   The CSS background color applied to the portion of the seek bar showing
  38.  *   when the ad breaks are scheduled to occur on the timeline.
  39.  * @exportDoc
  40.  */
  41. shaka.extern.UISeekBarColors;
  43. /**
  44.  * @typedef {{
  45.  *   base: string,
  46.  *   level: string
  47.  * }}
  48.  *
  49.  * @property {string} base
  50.  *   The CSS background color applied to the base of the volume bar, on top of
  51.  *   which the volume level is shown.
  52.  * @property {string} level
  53.  *   The CSS background color applied to the portion of the volume bar showing
  54.  *   the volume level.
  55.  * @exportDoc
  56.  */
  57. shaka.extern.UIVolumeBarColors;
  59. /**
  60.  * @description
  61.  * The UI's configuration options.
  62.  *
  63.  * @typedef {{
  64.  *   controlPanelElements: !Array.<string>,
  65.  *   overflowMenuButtons: !Array.<string>,
  66.  *   addSeekBar: boolean,
  67.  *   addBigPlayButton: boolean,
  68.  *   castReceiverAppId: string,
  69.  *   clearBufferOnQualityChange: boolean,
  70.  *   showUnbufferedStart: boolean,
  71.  *   seekBarColors: shaka.extern.UISeekBarColors,
  72.  *   volumeBarColors: shaka.extern.UIVolumeBarColors,
  73.  *   trackLabelFormat: shaka.ui.Overlay.TrackLabelFormat,
  74.  *   fadeDelay: number,
  75.  *   doubleClickForFullscreen: boolean,
  76.  *   enableKeyboardPlaybackControls: boolean,
  77.  *   enableFullscreenOnRotation: boolean,
  78.  *   forceLandscapeOnFullscreen: boolean
  79.  * }}
  80.  *
  81.  * @property {!Array.<string>} controlPanelElements
  82.  *   The ordered list of control panel elements of the UI.
  83.  * @property {!Array.<string>} overflowMenuButtons
  84.  *   The ordered list of the overflow menu buttons.
  85.  * @property {boolean} addSeekBar
  86.  *   Whether or not a seek bar should be part of the UI.
  87.  * @property {boolean} addBigPlayButton
  88.  *   Whether or not a big play button in the center of the video
  89.  *   should be part of the UI.
  90.  * @property {string} castReceiverAppId
  91.  *   Receiver app id to use for the Chromecast support.
  92.  * @property {boolean} clearBufferOnQualityChange
  93.  *   Only applicable if the resolution selection is part of the UI.
  94.  *   Whether buffer should be cleared when changing resolution
  95.  *   via UI. Clearing buffer would result in immidiate change of quality,
  96.  *   but playback may flicker/stall for a sec as the content in new
  97.  *   resolution is being buffered. Not clearing the buffer will mean
  98.  *   we play the content in the previously selected resolution that we
  99.  *   already have buffered before switching to the new resolution.
  100.  * @property {boolean} showUnbufferedStart
  101.  *   If true, color any unbuffered region at the start of the seek bar as
  102.  *   unbuffered (using the "base" color).  If false, color any unbuffered region
  103.  *   at the start of the seek bar as played (using the "played" color).
  104.  *   <br>
  105.  *   A value of false matches the default behavior of Chrome's native controls
  106.  *   and Shaka Player v3.0+.
  107.  *   <br>
  108.  *   A value of true matches the default behavior of Shaka Player v2.5.
  109.  *   <br>
  110.  *   Defaults to false.
  111.  * @property {shaka.extern.UISeekBarColors} seekBarColors
  112.  *   The CSS colors applied to the seek bar.  This allows you to override the
  113.  *   colors used in the linear gradient constructed in JavaScript, since you
  114.  *   cannot easily do this in pure CSS.
  115.  * @property {shaka.extern.UIVolumeBarColors} volumeBarColors
  116.  *   The CSS colors applied to the volume bar.  This allows you to override the
  117.  *   colors used in the linear gradient constructed in JavaScript, since you
  118.  *   cannot do this in pure CSS.
  119.  * @property {shaka.ui.Overlay.TrackLabelFormat} trackLabelFormat
  120.  *   An enum that determines what is shown in the labels for text track and
  121.  *   audio variant selection.
  122.  *   LANGUAGE means that only the language of the item is shown.
  123.  *   ROLE means that only the role of the item is shown.
  124.  *   LANGUAGE_ROLE means both language and role are shown, or just language if
  125.  *   there is no role.
  126.  *   LABEL means the non-standard DASH "label" attribute or the HLS "NAME"
  127.  *   attribute are shown.
  128.  *   Defaults to LANGUAGE.
  129.  * @property {number} fadeDelay
  130.  *   The delay (in seconds) before fading out the controls once the user stops
  131.  *   interacting with them.  We recommend setting this to 3 on your cast
  132.  *   receiver UI.
  133.  *   Defaults to 0.
  134.  * @property {boolean} doubleClickForFullscreen
  135.  *   Whether or not double-clicking on the UI should cause it to enter
  136.  *   fullscreen.
  137.  *   Defaults to true.
  138.  * @property {boolean} enableKeyboardPlaybackControls
  139.  *   Whether or not playback controls via keyboard is enabled, such as seek
  140.  *   forward, seek backward, jump to the beginning/end of the video.
  141.  *   Defaults to true.
  142.  * @property {boolean} enableFullscreenOnRotation
  143.  *   Whether or not to enter/exit fullscreen mode when the screen is rotated.
  144.  *   Defaults to true.
  145.  * @property {boolean} forceLandscapeOnFullscreen
  146.  *   Whether or not the device should rotate to landscape mode when the video
  147.  *   enters fullscreen.  Note that this behavior is based on an experimental
  148.  *   browser API, and may not work on all platforms.
  149.  *   Defaults to true.
  150.  * @exportDoc
  151.  */
  152. shaka.extern.UIConfiguration;
  155. /**
  156.  * Interface for UI elements.  UI elements should inherit from the concrete base
  157.  * class shaka.ui.Element.  The members defined in this extern's constructor are
  158.  * all available from the base class, and are defined here to keep the compiler
  159.  * from renaming them.
  160.  *
  161.  * @extends {shaka.util.IReleasable}
  162.  * @interface
  163.  * @exportDoc
  164.  */
  165. shaka.extern.IUIElement = class {
  166.   /**
  167.    * @param {!HTMLElement} parent
  168.    * @param {!shaka.ui.Controls} controls
  169.    */
  170.   constructor(parent, controls) {
  171.     /**
  172.      * @protected {HTMLElement}
  173.      * @exportDoc
  174.      */
  175.     this.parent;
  177.     /**
  178.      * @protected {shaka.ui.Controls}
  179.      * @exportDoc
  180.      */
  181.     this.controls;
  183.     /**
  184.      * @protected {shaka.util.EventManager}
  185.      * @exportDoc
  186.      */
  187.     this.eventManager;
  189.     /**
  190.      * @protected {shaka.ui.Localization}
  191.      * @exportDoc
  192.      */
  193.     this.localization;
  195.     /**
  196.      * @protected {shaka.Player}
  197.      * @exportDoc
  198.      */
  199.     this.player;
  201.     /**
  202.      * @protected {HTMLMediaElement}
  203.      * @exportDoc
  204.      */
  205.     this.video;
  207.     /**
  208.      * @protected {shaka.extern.IAdManager}
  209.      * @exportDoc
  210.      */
  211.     this.adManager;
  213.     /**
  214.      * @protected {shaka.extern.IAd}
  215.      * @exportDoc
  216.      */
  217.     this.ad;
  218.   }
  220.   /**
  221.    * @override
  222.    */
  223.   release() {}
  224. };
  227. /**
  228.  * A factory for creating a UI element.
  229.  *
  230.  * @interface
  231.  * @exportDoc
  232.  */
  233. shaka.extern.IUIElement.Factory = class {
  234.   /**
  235.    * @param {!HTMLElement} rootElement
  236.    * @param {!shaka.ui.Controls} controls
  237.    * @return {!shaka.extern.IUIElement}
  238.    */
  239.   create(rootElement, controls) {}
  240. };
  243. /**
  244.  * Interface for UI range elements.  UI range elements should inherit from the
  245.  * concrete base class shaka.ui.RangeElement.  The members defined in this
  246.  * extern's constructor are all available from the base class, and are defined
  247.  * here to keep the compiler from renaming them.
  248.  *
  249.  * @extends {shaka.extern.IUIElement}
  250.  * @interface
  251.  * @exportDoc
  252.  */
  253. shaka.extern.IUIRangeElement = class {
  254.   /**
  255.    * @param {!HTMLElement} parent
  256.    * @param {!shaka.ui.Controls} controls
  257.    * @param {!Array.<string>} containerClassNames
  258.    * @param {!Array.<string>} barClassNames
  259.    */
  260.   constructor(parent, controls, containerClassNames, barClassNames) {
  261.     /**
  262.      * @protected {!HTMLElement}
  263.      * @exportDoc
  264.      */
  265.     this.container;
  267.     /**
  268.      * @protected {!HTMLInputElement}
  269.      * @exportDoc
  270.      */
  271.     this.bar;
  272.   }
  274.   /**
  275.    * @param {number} min
  276.    * @param {number} max
  277.    */
  278.   setRange(min, max) {}
  280.   /**
  281.    * Called when user interaction begins.
  282.    * To be overridden by subclasses.
  283.    */
  284.   onChangeStart() {}
  286.   /**
  287.    * Called when a new value is set by user interaction.
  288.    * To be overridden by subclasses.
  289.    */
  290.   onChange() {}
  292.   /**
  293.    * Called when user interaction ends.
  294.    * To be overridden by subclasses.
  295.    */
  296.   onChangeEnd() {}
  298.   /** @return {number} */
  299.   getValue() {}
  301.   /** @param {number} value */
  302.   setValue(value) {}
  304.   /** @param {number} value */
  305.   changeTo(value) {}
  306. };
  308. /**
  309.  * Interface for UI settings menus.  UI settings menus should inherit from the
  310.  * concrete base class shaka.ui.SettingsMenu.  The members defined in this
  311.  * extern's constructor are all available from the base class, and are defined
  312.  * here to keep the compiler from renaming them.
  313.  *
  314.  * @extends {shaka.extern.IUIElement}
  315.  * @interface
  316.  * @exportDoc
  317.  */
  318. shaka.extern.IUISettingsMenu = class {
  319.   /**
  320.    * @param {!HTMLElement} parent
  321.    * @param {!shaka.ui.Controls} controls
  322.    * @param {string} iconText
  323.    */
  324.   constructor(parent, controls, iconText) {
  325.     /**
  326.      * @protected {!HTMLButtonElement}
  327.      * @exportDoc
  328.      */
  329.     this.button;
  331.     /**
  332.      * @protected {!HTMLElement}
  333.      * @exportDoc
  334.      */
  335.     this.icon;
  337.     /**
  338.      * @protected {!HTMLElement}
  339.      * @exportDoc
  340.      */
  341.     this.nameSpan;
  343.     /**
  344.      * @protected {!HTMLElement}
  345.      * @exportDoc
  346.      */
  347.     this.currentSelection;
  349.     /**
  350.      * @protected {!HTMLElement}
  351.      * @exportDoc
  352.      */
  353.     this.menu;
  355.     /**
  356.      * @protected {!HTMLButtonElement}
  357.      * @exportDoc
  358.      */
  359.     this.backButton;
  361.     /**
  362.      * @protected {!HTMLElement}
  363.      * @exportDoc
  364.      */
  365.     this.backSpan;
  366.   }
  367. };
  369. /**
  370.  * Interface for SeekBars. SeekBars should inherit from the concrete base
  371.  * class shaka.ui.Element. If you do not need to totaly rebuild the
  372.  * SeekBar, you should consider using shaka.ui.RangeElement or
  373.  * shaka.ui.SeekBar as your base class.
  374.  *
  375.  * @extends {shaka.extern.IUIRangeElement}
  376.  * @interface
  377.  * @exportDoc
  378.  */
  379. shaka.extern.IUISeekBar = class {
  380.   /** @return {number} */
  381.   getValue() {}
  383.   /** @param {number} value */
  384.   setValue(value) {}
  386.   /**
  387.    * Called by Controls on a timer to update the state of the seek bar.
  388.    * Also called internally when the user interacts with the input element.
  389.    */
  390.   update() {}
  392.   /** @return {boolean} */
  393.   isShowing() {}
  394. };
  396. /**
  397.  * A factory for creating a SeekBar element.
  398.  *
  399.  * @interface
  400.  * @exportDoc
  401.  */
  402. shaka.extern.IUISeekBar.Factory = class {
  403.   /**
  404.    * @param {!HTMLElement} rootElement
  405.    * @param {!shaka.ui.Controls} controls
  406.    * @return {!shaka.extern.IUISeekBar}
  407.    */
  408.   create(rootElement, controls) {}
  409. };