shaka-player 4.4.2 → 4.5.0

package/dist/shaka-player.ui.externs.js

@@ -282,11 +282,13 @@ shaka.util.Error.Code = {
   'HLS_MSE_ENCRYPTED_MP2T_NOT_SUPPORTED': 4040,
   'HLS_MSE_ENCRYPTED_LEGACY_APPLE_MEDIA_KEYS_NOT_SUPPORTED': 4041,
   'NO_WEB_CRYPTO_API': 4042,
-  'HLS_AES_128_INVALID_IV_LENGTH': 4043,
-  'HLS_AES_128_INVALID_KEY_LENGTH': 4044,
   'CANNOT_ADD_EXTERNAL_THUMBNAILS_TO_LIVE_STREAM': 4045,
   'MSS_INVALID_XML': 4046,
   'MSS_LIVE_CONTENT_NOT_SUPPORTED': 4047,
+  'AES_128_INVALID_IV_LENGTH': 4048,
+  'AES_128_INVALID_KEY_LENGTH': 4049,
+  'DASH_CONFLICTING_AES_128': 4050,
+  'DASH_UNSUPPORTED_AES_128': 4051,
   'STREAMING_ENGINE_STARTUP_INVALID_STATE': 5006,
   'NO_RECOGNIZED_KEY_SYSTEMS': 6000,
   'REQUESTED_KEY_SYSTEM_CONFIG_UNAVAILABLE': 6001,
@@ -337,7 +339,8 @@ shaka.util.Error.Code = {
   'CS_AD_MANAGER_NOT_INITIALIZED': 10001,
   'SS_IMA_SDK_MISSING': 10002,
   'SS_AD_MANAGER_NOT_INITIALIZED': 10003,
-  'CURRENT_DAI_REQUEST_NOT_FINISHED': 10004
+  'CURRENT_DAI_REQUEST_NOT_FINISHED': 10004,
+  'MT_AD_MANAGER_NOT_INITIALIZED': 10005
 };
 /**
  * @summary A set of language utility functions.
@@ -587,6 +590,13 @@ shaka.ui.Localization.LOCALE_CHANGED;
  * @const {string}
  */
 shaka.ui.Localization.LOCALE_UPDATED;
+/**
+ * @enum {string}
+ */
+shaka.config.CodecSwitchingStrategy = {
+  RELOAD: 'reload',
+  SMOOTH: 'smooth'
+};
 /**
  * @summary A set of BufferSource utility functions.
  */
@@ -700,6 +710,223 @@ shaka.text.Cue = class {
    */
   static equal(cue1, cue2) {}
 };
+/**
+     * The start time of the cue in seconds, relative to the start of the
+     * presentation.
+     * @type {number}
+     */
+shaka.text.Cue.prototype.startTime;
+/**
+     * The end time of the cue in seconds, relative to the start of the
+     * presentation.
+     * @type {number}
+     */
+shaka.text.Cue.prototype.endTime;
+/**
+     * The text payload of the cue.  If nestedCues is non-empty, this should be
+     * empty.  Top-level block containers should have no payload of their own.
+     * @type {string}
+     */
+shaka.text.Cue.prototype.payload;
+/**
+     * The region to render the cue into.  Only supported on top-level cues,
+     * because nested cues are inline elements.
+     * @type {shaka.text.CueRegion}
+     */
+shaka.text.Cue.prototype.region;
+/**
+     * The indent (in percent) of the cue box in the direction defined by the
+     * writing direction.
+     * @type {?number}
+     */
+shaka.text.Cue.prototype.position;
+/**
+     * Position alignment of the cue.
+     * @type {shaka.text.Cue.positionAlign}
+     */
+shaka.text.Cue.prototype.positionAlign;
+/**
+     * Size of the cue box (in percents), where 0 means "auto".
+     * @type {number}
+     */
+shaka.text.Cue.prototype.size;
+/**
+     * Alignment of the text inside the cue box.
+     * @type {shaka.text.Cue.textAlign}
+     */
+shaka.text.Cue.prototype.textAlign;
+/**
+     * Text direction of the cue.
+     * @type {shaka.text.Cue.direction}
+     */
+shaka.text.Cue.prototype.direction;
+/**
+     * Text writing mode of the cue.
+     * @type {shaka.text.Cue.writingMode}
+     */
+shaka.text.Cue.prototype.writingMode;
+/**
+     * The way to interpret line field. (Either as an integer line number or
+     * percentage from the display box).
+     * @type {shaka.text.Cue.lineInterpretation}
+     */
+shaka.text.Cue.prototype.lineInterpretation;
+/**
+     * The offset from the display box in either number of lines or
+     * percentage depending on the value of lineInterpretation.
+     * @type {?number}
+     */
+shaka.text.Cue.prototype.line;
+/**
+     * Separation between line areas inside the cue box in px or em
+     * (e.g. '100px'/'100em'). If not specified, this should be no less than
+     * the largest font size applied to the text in the cue.
+     * @type {string}.
+     */
+shaka.text.Cue.prototype.lineHeight;
+/**
+     * Line alignment of the cue box.
+     * Start alignment means the cue box’s top side (for horizontal cues), left
+     * side (for vertical growing right), or right side (for vertical growing
+     * left) is aligned at the line.
+     * Center alignment means the cue box is centered at the line.
+     * End alignment The cue box’s bottom side (for horizontal cues), right side
+     * (for vertical growing right), or left side (for vertical growing left) is
+     * aligned at the line.
+     * @type {shaka.text.Cue.lineAlign}
+     */
+shaka.text.Cue.prototype.lineAlign;
+/**
+     * Vertical alignments of the cues within their extents.
+     * 'BEFORE' means displaying the captions at the top of the text display
+     * container box, 'CENTER' means in the middle, 'AFTER' means at the bottom.
+     * @type {shaka.text.Cue.displayAlign}
+     */
+shaka.text.Cue.prototype.displayAlign;
+/**
+     * Text color as a CSS color, e.g. "#FFFFFF" or "white".
+     * @type {string}
+     */
+shaka.text.Cue.prototype.color;
+/**
+     * Text background color as a CSS color, e.g. "#FFFFFF" or "white".
+     * @type {string}
+     */
+shaka.text.Cue.prototype.backgroundColor;
+/**
+     * The URL of the background image, e.g. "data:[mime type];base64,[data]".
+     * @type {string}
+     */
+shaka.text.Cue.prototype.backgroundImage;
+/**
+     * The border around this cue as a CSS border.
+     * @type {string}
+     */
+shaka.text.Cue.prototype.border;
+/**
+     * Text font size in px or em (e.g. '100px'/'100em').
+     * @type {string}
+     */
+shaka.text.Cue.prototype.fontSize;
+/**
+     * Text font weight. Either normal or bold.
+     * @type {shaka.text.Cue.fontWeight}
+     */
+shaka.text.Cue.prototype.fontWeight;
+/**
+     * Text font style. Normal, italic or oblique.
+     * @type {shaka.text.Cue.fontStyle}
+     */
+shaka.text.Cue.prototype.fontStyle;
+/**
+     * Text font family.
+     * @type {string}
+     */
+shaka.text.Cue.prototype.fontFamily;
+/**
+     * Text letter spacing as a CSS letter-spacing value.
+     * @type {string}
+     */
+shaka.text.Cue.prototype.letterSpacing;
+/**
+     * Text line padding as a CSS line-padding value.
+     * @type {string}
+     */
+shaka.text.Cue.prototype.linePadding;
+/**
+     * Opacity of the cue element, from 0-1.
+     * @type {number}
+     */
+shaka.text.Cue.prototype.opacity;
+/**
+     * Text combine upright as a CSS text-combine-upright value.
+     * @type {string}
+     */
+shaka.text.Cue.prototype.textCombineUpright;
+/**
+     * Text decoration. A combination of underline, overline
+     * and line through. Empty array means no decoration.
+     * @type {!Array.<!shaka.text.Cue.textDecoration>}
+     */
+shaka.text.Cue.prototype.textDecoration;
+/**
+     * Text shadow color as a CSS text-shadow value.
+     * @type {string}
+     */
+shaka.text.Cue.prototype.textShadow;
+/**
+     * Text stroke color as a CSS color, e.g. "#FFFFFF" or "white".
+     * @type {string}
+     */
+shaka.text.Cue.prototype.textStrokeColor;
+/**
+     * Text stroke width as a CSS stroke-width value.
+     * @type {string}
+     */
+shaka.text.Cue.prototype.textStrokeWidth;
+/**
+     * Whether or not line wrapping should be applied to the cue.
+     * @type {boolean}
+     */
+shaka.text.Cue.prototype.wrapLine;
+/**
+     * Id of the cue.
+     * @type {string}
+     */
+shaka.text.Cue.prototype.id;
+/**
+     * Nested cues, which should be laid out horizontally in one block.
+     * Top-level cues are blocks, and nested cues are inline elements.
+     * Cues can be nested arbitrarily deeply.
+     * @type {!Array.<!shaka.text.Cue>}
+     */
+shaka.text.Cue.prototype.nestedCues;
+/**
+     * If true, this represents a container element that is "above" the main
+     * cues. For example, the <body> and <div> tags that contain the <p> tags
+     * in a TTML file. This controls the flow of the final cues; any nested cues
+     * within an "isContainer" cue will be laid out as separate lines.
+     * @type {boolean}
+     */
+shaka.text.Cue.prototype.isContainer;
+/**
+     * Whether or not the cue only acts as a line break between two nested cues.
+     * Should only appear in nested cues.
+     * @type {boolean}
+     */
+shaka.text.Cue.prototype.lineBreak;
+/**
+     * Used to indicate the type of ruby tag that should be used when rendering
+     * the cue. Valid values: ruby, rp, rt.
+     * @type {?string}
+     */
+shaka.text.Cue.prototype.rubyTag;
+/**
+     * The number of horizontal and vertical cells into which the Root Container
+     * Region area is divided.
+     * @type {{ columns: number, rows: number }}
+     */
+shaka.text.Cue.prototype.cellResolution;
 /**
  * @enum {string}
  */
@@ -821,6 +1048,68 @@ shaka.text.CueRegion = class {
   /** */
   constructor() {}
 };
+/**
+     * Region identifier.
+     * @type {string}
+     */
+shaka.text.CueRegion.prototype.id;
+/**
+     * The X offset to start the rendering area in viewportAnchorUnits of the
+     * video width.
+     * @type {number}
+     */
+shaka.text.CueRegion.prototype.viewportAnchorX;
+/**
+     * The X offset to start the rendering area in viewportAnchorUnits of the
+     * video height.
+     * @type {number}
+     */
+shaka.text.CueRegion.prototype.viewportAnchorY;
+/**
+     * The X offset to start the rendering area in percentage (0-100) of this
+     * region width.
+     * @type {number}
+     */
+shaka.text.CueRegion.prototype.regionAnchorX;
+/**
+     * The Y offset to start the rendering area in percentage (0-100) of the
+     * region height.
+     * @type {number}
+     */
+shaka.text.CueRegion.prototype.regionAnchorY;
+/**
+     * The width of the rendering area in widthUnits.
+     * @type {number}
+     */
+shaka.text.CueRegion.prototype.width;
+/**
+     * The width of the rendering area in heightUnits.
+     * @type {number}
+     */
+shaka.text.CueRegion.prototype.height;
+/**
+     * The units (percentage, pixels or lines) the region height is in.
+     * @type {shaka.text.CueRegion.units}
+     */
+shaka.text.CueRegion.prototype.heightUnits;
+/**
+     * The units (percentage or pixels) the region width is in.
+     * @type {shaka.text.CueRegion.units}
+     */
+shaka.text.CueRegion.prototype.widthUnits;
+/**
+     * The units (percentage or pixels) the region viewportAnchors are in.
+     * @type {shaka.text.CueRegion.units}
+     */
+shaka.text.CueRegion.prototype.viewportAnchorUnits;
+/**
+     * If scroll=UP, it means that cues in the region will be added to the
+     * bottom of the region and will push any already displayed cues in the
+     * region up.  Otherwise (scroll=NONE) cues will stay fixed at the location
+     * they were first painted in.
+     * @type {shaka.text.CueRegion.scrollMode}
+     */
+shaka.text.CueRegion.prototype.scroll;
 /**
  * @enum {number}
  */
@@ -1300,7 +1589,8 @@ shaka.net.NetworkingEngine.RequestType = {
   'APP': 3,
   'TIMING': 4,
   'SERVER_CERTIFICATE': 5,
-  'KEY': 6
+  'KEY': 6,
+  'ADS': 7
 };
 /**
  * A more advanced form of the RequestType structure, meant to describe
@@ -1732,8 +2022,10 @@ shaka.media.InitSegmentReference = class {
    *   the quality of the media associated with this init segment.
    * @param {(null|number)=} timescale
    * @param {(null|BufferSource)=} segmentData
+   * @param {?shaka.extern.aes128Key=} aes128Key
+   *  The segment's AES-128-CBC full segment encryption key and iv.
    */
-  constructor(uris, startByte, endByte, mediaQuality, timescale, segmentData) {}
+  constructor(uris, startByte, endByte, mediaQuality, timescale, segmentData, aes128Key) {}
   /**
    * Returns the offset from the start of the resource to the
    * start of the segment.
@@ -1806,10 +2098,10 @@ shaka.media.SegmentReference = class {
    * @param {shaka.media.SegmentReference.Status=} status
    *  The segment status is used to indicate that a segment does not exist or is
    *  not available.
-   * @param {?shaka.extern.HlsAes128Key=} hlsAes128Key
+   * @param {?shaka.extern.aes128Key=} aes128Key
    *  The segment's AES-128-CBC full segment encryption key and iv.
    */
-  constructor(startTime, endTime, uris, startByte, endByte, initSegmentReference, timestampOffset, appendWindowStart, appendWindowEnd, partialReferences, tilesLayout, tileDuration, syncTime, status, hlsAes128Key) {}
+  constructor(startTime, endTime, uris, startByte, endByte, initSegmentReference, timestampOffset, appendWindowStart, appendWindowEnd, partialReferences, tilesLayout, tileDuration, syncTime, status, aes128Key) {}
   /**
    * Creates and returns the URIs of the resource containing the segment.
    * @return {!Array.<string>}
@@ -1965,8 +2257,9 @@ shaka.util.Id3Utils = class {
 shaka.util.ExpGolomb = class {
   /**
    * @param {!Uint8Array} data
+   * @param {boolean=} convertEbsp2rbsp
    */
-  constructor(data) {}
+  constructor(data, convertEbsp2rbsp) {}
 };
 /**
  * @see https://en.wikipedia.org/wiki/MPEG_transport_stream
@@ -1993,6 +2286,16 @@ shaka.util.TsParser = class {
    * @return {!Array.<shaka.extern.VideoNalu>}
    */
   parseAvcNalus(pes, nextPes) {}
+  /**
+   * Parse AVC and HVC Nalus
+   * The code is based on hls.js
+   * Credit to https://github.com/video-dev/hls.js/blob/master/src/demux/tsdemuxer.ts
+   * @param {shaka.extern.MPEG_PES} pes
+   * @param {?shaka.extern.MPEG_PES=} nextPes
+   * @param {?shaka.extern.VideoNalu=} lastNalu
+   * @return {!Array.<shaka.extern.VideoNalu>}
+   */
+  parseNalus(pes, nextPes, lastNalu) {}
   /**
    * Return the ID3 metadata
    * @return {!Array.<shaka.extern.ID3Metadata>}
@@ -2052,23 +2355,23 @@ shaka.util.TsParser = class {
 shaka.util.TsParser.Timescale;
 /**
  * @summary
- *  lcevcDil - (MPEG-5 Part 2 LCEVC - Decoder Integration Layer) provides
+ *  lcevcDec - (MPEG-5 Part 2 LCEVC - Decoder) provides
  *  all the operations related to the enhancement and rendering
  *  of LCEVC enabled streams and on to a canvas.
  * @implements {shaka.util.IReleasable}
  */
-shaka.lcevc.Dil = class {
+shaka.lcevc.Dec = class {
   /**
    * @param {HTMLVideoElement} media The video element that will be attached to
-   * LCEVC Dil for input.
+   * LCEVC Decoder for input.
    * @param {HTMLCanvasElement} canvas The canvas element that will be attached
-   * to LCEVC Dil to render the enhanced frames.
-   * @param {shaka.extern.LcevcConfiguration} dilConfig The LCEVC DIL
-   * config object to initialize the LCEVC DIL.
+   * to LCEVC Decoder to render the enhanced frames.
+   * @param {shaka.extern.LcevcConfiguration} lcevcConfig LCEVC configuration
+   * object to initialize the LCEVC Decoder.
    */
-  constructor(media, canvas, dilConfig) {}
+  constructor(media, canvas, lcevcConfig) {}
   /**
-   * Close LCEVC Dil.
+   * Close LCEVC Decoder.
    * @override
    */
   release() {}
@@ -2792,9 +3095,10 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    * <code>load</code> but cannot interrupt calls to <code>attach</code>,
    * <code>detach</code>, or <code>unload</code>.
    * @param {boolean=} initializeMediaSource
+   * @param {boolean=} keepAdManager
    * @return {!Promise}
    */
-  unload(initializeMediaSource) {}
+  unload(initializeMediaSource, keepAdManager) {}
   /**
    * Provides a way to update the stream start position during the media loading
    * process. Can for example be called from the <code>manifestparsed</code>
@@ -3397,6 +3701,138 @@ shaka.ads.ClientSideAd = class {
    */
   release() {}
 };
+/**
+ * @implements {shaka.extern.IAd}
+ */
+shaka.ads.MediaTailorAd = class {
+  /**
+   * @param {mediaTailor.Ad} mediaTailorAd
+   * @param {number} adPosition
+   * @param {number} totalAds
+   * @param {HTMLMediaElement} video
+   */
+  constructor(mediaTailorAd, adPosition, totalAds, isLinear, video) {}
+  /**
+   * @override
+   */
+  getDuration() {}
+  /**
+   * @override
+   */
+  getMinSuggestedDuration() {}
+  /**
+   * @override
+   */
+  getRemainingTime() {}
+  /**
+   * @override
+   */
+  isPaused() {}
+  /**
+   * @override
+   */
+  isSkippable() {}
+  /**
+   * @override
+   */
+  getTimeUntilSkippable() {}
+  /**
+   * @override
+   */
+  canSkipNow() {}
+  /**
+   * @override
+   */
+  skip() {}
+  /**
+   * @override
+   */
+  pause() {}
+  /**
+   * @override
+   */
+  play() {}
+  /**
+   * @override
+   */
+  getVolume() {}
+  /**
+   * @override
+   */
+  setVolume(volume) {}
+  /**
+   * @override
+   */
+  isMuted() {}
+  /**
+   * @override
+   */
+  isLinear() {}
+  /**
+   * @override
+   */
+  resize(width, height) {}
+  /**
+   * @override
+   */
+  setMuted(muted) {}
+  /**
+   * @override
+   */
+  getSequenceLength() {}
+  /**
+   * @override
+   */
+  getPositionInSequence() {}
+  /**
+   * @override
+   */
+  getTitle() {}
+  /**
+   * @override
+   */
+  getDescription() {}
+  /**
+   * @override
+   */
+  getVastMediaBitrate() {}
+  /**
+   * @override
+   */
+  getVastMediaHeight() {}
+  /**
+   * @override
+   */
+  getVastMediaWidth() {}
+  /**
+   * @override
+   */
+  getAdId() {}
+  /**
+   * @override
+   */
+  getCreativeAdId() {}
+  /**
+   * @override
+   */
+  getAdvertiserName() {}
+  /**
+   * @override
+   */
+  getMediaUrl() {}
+  /**
+   * @override
+   */
+  getTimeOffset() {}
+  /**
+   * @override
+   */
+  getPodIndex() {}
+  /**
+   * @override
+   */
+  release() {}
+};
 /**
  * @implements {shaka.extern.IAd}
  */
@@ -3563,6 +3999,18 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
    * @override
    */
   updateClientSideAdsRenderingSettings(adsRenderingSettings) {}
+  /**
+   * @override
+   */
+  initMediaTailor(adContainer, networkingEngine, video) {}
+  /**
+   * @param {string} url
+   * @param {Object} adsParams
+   * @param {string=} backupUrl
+   * @return {!Promise.<string>}
+   * @override
+   */
+  requestMediaTailorStream(url, adsParams, backupUrl) {}
   /**
    * @override
    */
@@ -3583,11 +4031,20 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
    * @override
    */
   getServerSideCuePoints() {}
+  /**
+   * @return {!Array.<!shaka.extern.AdCuePoint>}
+   * @override
+   */
+  getCuePoints() {}
   /**
    * @return {shaka.extern.AdsStats}
    * @override
    */
   getStats() {}
+  /**
+   * @override
+   */
+  onManifestUpdated(isLive) {}
   /**
    * @override
    */
@@ -4863,7 +5320,7 @@ shaka.transmuxer.MpegTsTransmuxer = class {
   /**
    * @override
    */
-  transmux(data) {}
+  transmux(data, stream, reference, duration, contentType) {}
 };
 /**
  * @implements {shaka.extern.Transmuxer}
@@ -4898,39 +5355,6 @@ shaka.transmuxer.MssTransmuxer = class {
    */
   transmux(data, stream, reference) {}
 };
-/**
- * @implements {shaka.extern.Transmuxer}
- */
-shaka.transmuxer.MuxjsTransmuxer = class {
-  /**
-   * @param {string} mimeType
-   */
-  constructor(mimeType) {}
-  /**
-   * @override
-   */
-  destroy() {}
-  /**
-   * Check if the mime type and the content type is supported.
-   * @param {string} mimeType
-   * @param {string=} contentType
-   * @return {boolean}
-   * @override
-   */
-  isSupported(mimeType, contentType) {}
-  /**
-   * @override
-   */
-  convertCodecs(contentType, mimeType) {}
-  /**
-   * @override
-   */
-  getOrginalMimeType() {}
-  /**
-   * @override
-   */
-  transmux(data) {}
-};
 /**
  * @implements {shaka.extern.Transmuxer}
  */
@@ -5278,6 +5702,16 @@ shaka.ui.Controls = class extends shaka.util.FakeEventTarget {
   isFullScreenEnabled() {}
   /**  */
   toggleFullScreen() {}
+  /**
+   * @return {boolean}
+   */
+  isPiPAllowed() {}
+  /**
+   * @return {boolean}
+   */
+  isPiPEnabled() {}
+  /**  */
+  togglePiP() {}
   /**  */
   showAdUI() {}
   /**  */
@@ -5486,6 +5920,17 @@ shaka.ui.PresentationTimeTracker = class extends shaka.ui.Element {
    */
   constructor(parent, controls) {}
 };
+/**
+ * @extends {shaka.ui.Element}
+ * @final
+ */
+shaka.ui.RemoteButton = class extends shaka.ui.Element {
+  /**
+   * @param {!HTMLElement} parent
+   * @param {!shaka.ui.Controls} controls
+   */
+  constructor(parent, controls) {}
+};
 /**
  * @extends {shaka.ui.SettingsMenu}
  * @final