Source: externs/shaka/queue.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. /**
  9.  * @externs
  10.  */
  13. /**
  14.  * @typedef {{
  15.  *   manifestUri: string,
  16.  *   startTime: ?(number|Date),
  17.  *   mimeType: ?string,
  18.  *   config: ?shaka.extern.PlayerConfiguration,
  19.  *   extraText: ?Array<!shaka.extern.ExtraText>,
  20.  *   extraThumbnail: ?Array<string>,
  21.  *   extraChapter: ?Array<!shaka.extern.ExtraChapter>
  22.  * }}
  23.  *
  24.  * @property {string} manifestUri
  25.  * @property {?(number|Date)} startTime
  26.  * @property {?string} mimeType
  27.  * @property {?shaka.extern.PlayerConfiguration} config
  28.  * @property {?Array<!shaka.extern.ExtraText>} extraText
  29.  * @property {?Array<string>} extraThumbnail
  30.  * @property {?Array<!shaka.extern.ExtraChapter>} extraChapter
  31.  * @exportDoc
  32.  */
  33. shaka.extern.QueueItem;
  35. /**
  36.  * An object that's responsible for all the queue-related logic
  37.  * in the player.
  38.  *
  39.  * @interface
  40.  * @extends {shaka.util.IDestroyable}
  41.  * @exportDoc
  42.  */
  43. shaka.extern.IQueueManager = class extends EventTarget {
  44.   /**
  45.    * @return {!Promise}
  46.    */
  47.   destroy() {}
  49.   /**
  50.    * Called by the Player to provide an updated configuration any time it
  51.    * changes.
  52.    *
  53.    * @param {shaka.extern.QueueConfiguration} config
  54.    */
  55.   configure(config) {}
  57.   /**
  58.    * Returns the current configuration.
  59.    *
  60.    * @return {?shaka.extern.QueueConfiguration}
  61.    */
  62.   getConfiguration() {}
  64.   /**
  65.    * Returns the current item.
  66.    *
  67.    * @return {?shaka.extern.QueueItem}
  68.    */
  69.   getCurrentItem() {}
  71.   /**
  72.    * Returns the index of the current playing item.
  73.    *
  74.    * @return {number}
  75.    */
  76.   getCurrentItemIndex() {}
  78.   /**
  79.    * Returns all items.
  80.    *
  81.    * @return {!Array<shaka.extern.QueueItem>}
  82.    */
  83.   getItems() {}
  85.   /**
  86.    * Insert new items in the current queue.
  87.    *
  88.    * @param {!Array<shaka.extern.QueueItem>} items
  89.    */
  90.   insertItems(items) {}
  92.   /**
  93.    * Remove all items.
  94.    *
  95.    * @return {!Promise}
  96.    */
  97.   removeAllItems() {}
  99.   /**
  100.    * Plays a item number in the queue.
  101.    *
  102.    * @param {number} itemIndex
  103.    * @return {!Promise}
  104.    */
  105.   playItem(itemIndex) {}
  106. };
  109. /**
  110.  * A factory for creating the queue manager.
  111.  *
  112.  * @typedef {function(shaka.Player):!shaka.extern.IQueueManager}
  113.  * @exportDoc
  114.  */
  115. shaka.extern.IQueueManager.Factory;