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.  *   contextMenuElements: !Array.<string>,
  67.  *   statisticsList: !Array.<string>,
  68.  *   playbackRates: !Array.<number>,
  69.  *   fastForwardRates: !Array.<number>,
  70.  *   rewindRates: !Array.<number>,
  71.  *   addSeekBar: boolean,
  72.  *   addBigPlayButton: boolean,
  73.  *   customContextMenu: boolean,
  74.  *   castReceiverAppId: string,
  75.  *   castAndroidReceiverCompatible: boolean,
  76.  *   clearBufferOnQualityChange: boolean,
  77.  *   showUnbufferedStart: boolean,
  78.  *   seekBarColors: shaka.extern.UISeekBarColors,
  79.  *   volumeBarColors: shaka.extern.UIVolumeBarColors,
  80.  *   trackLabelFormat: shaka.ui.Overlay.TrackLabelFormat,
  81.  *   textTrackLabelFormat: shaka.ui.Overlay.TrackLabelFormat,
  82.  *   fadeDelay: number,
  83.  *   doubleClickForFullscreen: boolean,
  84.  *   singleClickForPlayAndPause: boolean,
  85.  *   enableKeyboardPlaybackControls: boolean,
  86.  *   enableFullscreenOnRotation: boolean,
  87.  *   forceLandscapeOnFullscreen: boolean,
  88.  *   enableTooltips: boolean,
  89.  *   keyboardSeekDistance: number,
  90.  *   keyboardLargeSeekDistance: number,
  91.  *   fullScreenElement: HTMLElement,
  92.  *   preferDocumentPictureInPicture: boolean,
  93.  *   showAudioChannelCountVariants: boolean,
  94.  *   seekOnTaps: boolean,
  95.  *   tapSeekDistance: number,
  96.  *   refreshTickInSeconds: number,
  97.  *   displayInVrMode: boolean,
  98.  *   defaultVrProjectionMode: string
  99.  * }}
  100.  *
  101.  * @property {!Array.<string>} controlPanelElements
  102.  *   The ordered list of control panel elements of the UI.
  103.  * @property {!Array.<string>} overflowMenuButtons
  104.  *   The ordered list of the overflow menu buttons.
  105.  * @property {!Array.<string>} contextMenuElements
  106.  *   The ordered list of buttons in the context menu.
  107.  * @property {!Array.<string>} statisticsList
  108.  *   The ordered list of statistics present in the statistics container.
  109.  * @property {!Array.<number>} playbackRates
  110.  *   The ordered list of rates for playback selection.
  111.   * @property {!Array.<number>} fastForwardRates
  112.  *   The ordered list of rates for fast forward selection.
  113.  * @property {!Array.<number>} rewindRates
  114.  *   The ordered list of rates for rewind selection.
  115.  * @property {boolean} addSeekBar
  116.  *   Whether or not a seek bar should be part of the UI.
  117.  * @property {boolean} addBigPlayButton
  118.  *   Whether or not a big play button in the center of the video
  119.  *   should be part of the UI.
  120.  * @property {boolean} customContextMenu
  121.  *   Whether or not a custom context menu replaces the default.
  122.  * @property {string} castReceiverAppId
  123.  *   Receiver app id to use for the Chromecast support.
  124.  * @property {boolean} castAndroidReceiverCompatible
  125.  *   Indicates if the app is compatible with an Android Cast Receiver.
  126.  * @property {boolean} clearBufferOnQualityChange
  127.  *   Only applicable if the resolution selection is part of the UI.
  128.  *   Whether buffer should be cleared when changing resolution
  129.  *   via UI. Clearing buffer would result in immidiate change of quality,
  130.  *   but playback may flicker/stall for a sec as the content in new
  131.  *   resolution is being buffered. Not clearing the buffer will mean
  132.  *   we play the content in the previously selected resolution that we
  133.  *   already have buffered before switching to the new resolution.
  134.  * @property {boolean} showUnbufferedStart
  135.  *   If true, color any unbuffered region at the start of the seek bar as
  136.  *   unbuffered (using the "base" color).  If false, color any unbuffered region
  137.  *   at the start of the seek bar as played (using the "played" color).
  138.  *   <br>
  139.  *   A value of false matches the default behavior of Chrome's native controls
  140.  *   and Shaka Player v3.0+.
  141.  *   <br>
  142.  *   A value of true matches the default behavior of Shaka Player v2.5.
  143.  *   <br>
  144.  *   Defaults to false.
  145.  * @property {shaka.extern.UISeekBarColors} seekBarColors
  146.  *   The CSS colors applied to the seek bar.  This allows you to override the
  147.  *   colors used in the linear gradient constructed in JavaScript, since you
  148.  *   cannot easily do this in pure CSS.
  149.  * @property {shaka.extern.UIVolumeBarColors} volumeBarColors
  150.  *   The CSS colors applied to the volume bar.  This allows you to override the
  151.  *   colors used in the linear gradient constructed in JavaScript, since you
  152.  *   cannot do this in pure CSS.
  153.  * @property {shaka.ui.Overlay.TrackLabelFormat} trackLabelFormat
  154.  *   An enum that determines what is shown in the labels for audio variant
  155.  *   selection.
  156.  *   LANGUAGE means that only the language of the item is shown.
  157.  *   ROLE means that only the role of the item is shown.
  158.  *   LANGUAGE_ROLE means both language and role are shown, or just language if
  159.  *   there is no role.
  160.  *   LABEL means the non-standard DASH "label" attribute or the standard DASH
  161.  *   "Label" element or the HLS "NAME" attribute are shown.
  162.  *   Defaults to LANGUAGE.
  163.  * @property {shaka.ui.Overlay.TrackLabelFormat} textTrackLabelFormat
  164.  *   An enum that determines what is shown in the labels for text track
  165.  *   selection.
  166.  *   LANGUAGE means that only the language of the item is shown.
  167.  *   ROLE means that only the role of the item is shown.
  168.  *   LANGUAGE_ROLE means both language and role are shown, or just language if
  169.  *   there is no role.
  170.  *   LABEL means the non-standard DASH "label" attribute or the standard DASH
  171.  *   "Label" element or the HLS "NAME" attribute are shown.
  172.  *   Defaults to LANGUAGE.
  173.  * @property {number} fadeDelay
  174.  *   The delay (in seconds) before fading out the controls once the user stops
  175.  *   interacting with them.  We recommend setting this to 3 on your cast
  176.  *   receiver UI.
  177.  *   Defaults to 0.
  178.  * @property {boolean} doubleClickForFullscreen
  179.  *   Whether or not double-clicking on the UI should cause it to enter
  180.  *   fullscreen.
  181.  *   Defaults to true.
  182.  * @property {boolean} singleClickForPlayAndPause
  183.  *   Whether or not clicking on the video should cause it to play or pause.
  184.  *   It does not work in VR mode.
  185.  *   Defaults to true.
  186.  * @property {boolean} enableKeyboardPlaybackControls
  187.  *   Whether or not playback controls via keyboard is enabled, such as seek
  188.  *   forward, seek backward, jump to the beginning/end of the video.
  189.  *   Defaults to true.
  190.  * @property {boolean} enableFullscreenOnRotation
  191.  *   Whether or not to enter/exit fullscreen mode when the screen is rotated.
  192.  *   Defaults to true.
  193.  * @property {boolean} forceLandscapeOnFullscreen
  194.  *   Whether or not the device should rotate to landscape mode when the video
  195.  *   enters fullscreen.  Note that this behavior is based on an experimental
  196.  *   browser API, and may not work on all platforms.
  197.  *   Defaults to true.
  198.  * @property {boolean} enableTooltips
  199.  *   Whether or not buttons in the control panel display tooltips that contain
  200.  *   information about their function.
  201.  *   Defaults to false.
  202.  * @property {number} keyboardSeekDistance
  203.  *   The time interval, in seconds, to seek when the user presses the left or
  204.  *   right keyboard keys when the video is selected. If less than or equal to 0,
  205.  *   no seeking will occur.
  206.  *   Defaults to 5 seconds.
  207.  * @property {number} keyboardLargeSeekDistance
  208.  *   The time interval, in seconds, to seek when the user presses the page up or
  209.  *   page down keyboard keys when the video is selected. If less than or equal
  210.  *   to 0, no seeking will occur.
  211.  *   Defaults to 60 seconds.
  212.  * @property {HTMLElement} fullScreenElement
  213.  *   DOM element on which fullscreen will be done.
  214.  *   Defaults to Shaka Player Container.
  215.  * @property {boolean} preferDocumentPictureInPicture
  216.  *   Indicates whether the Document Picture in Picture API is preferred or the
  217.  *   Video Element Picture in Picture API is preferred.
  218.  *   Changing this property in mid-playback may produce undesired behavior if
  219.  *   you are already in PiP.
  220.  *   Defaults to true.
  221.  * @property {boolean} showAudioChannelCountVariants
  222.  *   Indicates whether the combination of language and channel count should be
  223.  *   displayed or if, on the contrary, only the language should be displayed
  224.  *   regardless of the channel count.
  225.  *   Defaults to true.
  226.  * @property {boolean} seekOnTaps
  227.  *   Indicates whether or not a fast-forward and rewind tap button that seeks
  228.  *   video some seconds.
  229.  *   Defaults to true.
  230.  * @property {number} tapSeekDistance
  231.  *   The time interval, in seconds, to seek when the user presses the left or
  232.  *   right part of the video. If less than or equal to 0,
  233.  *   no seeking will occur.
  234.  *   Defaults to 10 seconds.
  235.  * @property {number} refreshTickInSeconds
  236.  *   The time interval, in seconds, to update the seek bar.
  237.  *   Defaults to 0.125 seconds.
  238.  * @property {boolean} displayInVrMode
  239.  *   If true, the content will be treated as VR.
  240.  *   If false, it will only be treated as VR if we automatically detect it as
  241.  *   such. (See the Enabling VR section in docs/tutorials/ui.md)
  242.  *   Defaults to false.
  243.  * @property {string} defaultVrProjectionMode
  244.  *   Indicate the default VR projection mode.
  245.  *   Possible values: <code>'equirectangular'</code> or <code>'cubemap'</code>.
  246.  *   Defaults to <code>'equirectangular'</code>.
  247.  * @exportDoc
  248.  */
  249. shaka.extern.UIConfiguration;
  252. /**
  253.  * Interface for UI elements.  UI elements should inherit from the concrete base
  254.  * class shaka.ui.Element.  The members defined in this extern's constructor are
  255.  * all available from the base class, and are defined here to keep the compiler
  256.  * from renaming them.
  257.  *
  258.  * @extends {shaka.util.IReleasable}
  259.  * @interface
  260.  * @exportDoc
  261.  */
  262. shaka.extern.IUIElement = class {
  263.   /**
  264.    * @param {!HTMLElement} parent
  265.    * @param {!shaka.ui.Controls} controls
  266.    */
  267.   constructor(parent, controls) {
  268.     /**
  269.      * @protected {HTMLElement}
  270.      * @exportDoc
  271.      */
  272.     this.parent;
  274.     /**
  275.      * @protected {shaka.ui.Controls}
  276.      * @exportDoc
  277.      */
  278.     this.controls;
  280.     /**
  281.      * @protected {shaka.util.EventManager}
  282.      * @exportDoc
  283.      */
  284.     this.eventManager;
  286.     /**
  287.      * @protected {shaka.ui.Localization}
  288.      * @exportDoc
  289.      */
  290.     this.localization;
  292.     /**
  293.      * @protected {shaka.Player}
  294.      * @exportDoc
  295.      */
  296.     this.player;
  298.     /**
  299.      * @protected {HTMLMediaElement}
  300.      * @exportDoc
  301.      */
  302.     this.video;
  304.     /**
  305.      * @protected {shaka.extern.IAdManager}
  306.      * @exportDoc
  307.      */
  308.     this.adManager;
  310.     /**
  311.      * @protected {shaka.extern.IAd}
  312.      * @exportDoc
  313.      */
  314.     this.ad;
  315.   }
  317.   /**
  318.    * @override
  319.    */
  320.   release() {}
  321. };
  324. /**
  325.  * A factory for creating a UI element.
  326.  *
  327.  * @interface
  328.  * @exportDoc
  329.  */
  330. shaka.extern.IUIElement.Factory = class {
  331.   /**
  332.    * @param {!HTMLElement} rootElement
  333.    * @param {!shaka.ui.Controls} controls
  334.    * @return {!shaka.extern.IUIElement}
  335.    */
  336.   create(rootElement, controls) {}
  337. };
  340. /**
  341.  * Interface for UI range elements.  UI range elements should inherit from the
  342.  * concrete base class shaka.ui.RangeElement.  The members defined in this
  343.  * extern's constructor are all available from the base class, and are defined
  344.  * here to keep the compiler from renaming them.
  345.  *
  346.  * @extends {shaka.extern.IUIElement}
  347.  * @interface
  348.  * @exportDoc
  349.  */
  350. shaka.extern.IUIRangeElement = class {
  351.   /**
  352.    * @param {!HTMLElement} parent
  353.    * @param {!shaka.ui.Controls} controls
  354.    * @param {!Array.<string>} containerClassNames
  355.    * @param {!Array.<string>} barClassNames
  356.    */
  357.   constructor(parent, controls, containerClassNames, barClassNames) {
  358.     /**
  359.      * @protected {!HTMLElement}
  360.      * @exportDoc
  361.      */
  362.     this.container;
  364.     /**
  365.      * @protected {!HTMLInputElement}
  366.      * @exportDoc
  367.      */
  368.     this.bar;
  369.   }
  371.   /**
  372.    * @param {number} min
  373.    * @param {number} max
  374.    */
  375.   setRange(min, max) {}
  377.   /**
  378.    * Called when user interaction begins.
  379.    * To be overridden by subclasses.
  380.    */
  381.   onChangeStart() {}
  383.   /**
  384.    * Called when a new value is set by user interaction.
  385.    * To be overridden by subclasses.
  386.    */
  387.   onChange() {}
  389.   /**
  390.    * Called when user interaction ends.
  391.    * To be overridden by subclasses.
  392.    */
  393.   onChangeEnd() {}
  395.   /** @return {number} */
  396.   getValue() {}
  398.   /** @param {number} value */
  399.   setValue(value) {}
  401.   /** @param {number} value */
  402.   changeTo(value) {}
  403. };
  405. /**
  406.  * Interface for UI settings menus.  UI settings menus should inherit from the
  407.  * concrete base class shaka.ui.SettingsMenu.  The members defined in this
  408.  * extern's constructor are all available from the base class, and are defined
  409.  * here to keep the compiler from renaming them.
  410.  *
  411.  * @extends {shaka.extern.IUIElement}
  412.  * @interface
  413.  * @exportDoc
  414.  */
  415. shaka.extern.IUISettingsMenu = class {
  416.   /**
  417.    * @param {!HTMLElement} parent
  418.    * @param {!shaka.ui.Controls} controls
  419.    * @param {string} iconText
  420.    */
  421.   constructor(parent, controls, iconText) {
  422.     /**
  423.      * @protected {!HTMLButtonElement}
  424.      * @exportDoc
  425.      */
  426.     this.button;
  428.     /**
  429.      * @protected {!HTMLElement}
  430.      * @exportDoc
  431.      */
  432.     this.icon;
  434.     /**
  435.      * @protected {!HTMLElement}
  436.      * @exportDoc
  437.      */
  438.     this.nameSpan;
  440.     /**
  441.      * @protected {!HTMLElement}
  442.      * @exportDoc
  443.      */
  444.     this.currentSelection;
  446.     /**
  447.      * @protected {!HTMLElement}
  448.      * @exportDoc
  449.      */
  450.     this.menu;
  452.     /**
  453.      * @protected {!HTMLButtonElement}
  454.      * @exportDoc
  455.      */
  456.     this.backButton;
  458.     /**
  459.      * @protected {!HTMLElement}
  460.      * @exportDoc
  461.      */
  462.     this.backSpan;
  463.   }
  464. };
  466. /**
  467.  * Interface for SeekBars. SeekBars should inherit from the concrete base
  468.  * class shaka.ui.Element. If you do not need to totaly rebuild the
  469.  * SeekBar, you should consider using shaka.ui.RangeElement or
  470.  * shaka.ui.SeekBar as your base class.
  471.  *
  472.  * @extends {shaka.extern.IUIRangeElement}
  473.  * @interface
  474.  * @exportDoc
  475.  */
  476. shaka.extern.IUISeekBar = class {
  477.   /** @return {number} */
  478.   getValue() {}
  480.   /** @param {number} value */
  481.   setValue(value) {}
  483.   /**
  484.    * Called by Controls on a timer to update the state of the seek bar.
  485.    * Also called internally when the user interacts with the input element.
  486.    */
  487.   update() {}
  489.   /** @return {boolean} */
  490.   isShowing() {}
  491. };
  493. /**
  494.  * A factory for creating a SeekBar element.
  495.  *
  496.  * @interface
  497.  * @exportDoc
  498.  */
  499. shaka.extern.IUISeekBar.Factory = class {
  500.   /**
  501.    * @param {!HTMLElement} rootElement
  502.    * @param {!shaka.ui.Controls} controls
  503.    * @return {!shaka.extern.IUISeekBar}
  504.    */
  505.   create(rootElement, controls) {}
  506. };
  508. /**
  509.  * @interface
  510.  * @exportDoc
  511.  */
  512. shaka.extern.IUIPlayButton = class {
  513.   /**
  514.    * @param {!HTMLElement} parent
  515.    * @param {!shaka.ui.Controls} controls
  516.    */
  517.   constructor(parent, controls) {
  518.     /**
  519.      * @protected {!HTMLButtonElement}
  520.      * @exportDoc
  521.      */
  522.     this.button;
  523.   }
  525.   /** @return {boolean} */
  526.   isPaused() {}
  528.   /** @return {boolean} */
  529.   isEnded() {}
  530. };