Source: externs/shaka/player.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.  *   timestamp: number,
  16.  *   id: number,
  17.  *   type: string,
  18.  *   fromAdaptation: boolean,
  19.  *   bandwidth: ?number
  20.  * }}
  21.  *
  22.  * @property {number} timestamp
  23.  *   The timestamp the choice was made, in seconds since 1970
  24.  *   (i.e. <code>Date.now() / 1000</code>).
  25.  * @property {number} id
  26.  *   The id of the track that was chosen.
  27.  * @property {string} type
  28.  *   The type of track chosen (<code>'variant'</code> or <code>'text'</code>).
  29.  * @property {boolean} fromAdaptation
  30.  *   <code>true</code> if the choice was made by AbrManager for adaptation;
  31.  *   <code>false</code> if it was made by the application through
  32.  *   <code>selectTrack</code>.
  33.  * @property {?number} bandwidth
  34.  *   The bandwidth of the chosen track (<code>null</code> for text).
  35.  * @exportDoc
  36.  */
  37. shaka.extern.TrackChoice;
  40. /**
  41.  * @typedef {{
  42.  *   timestamp: number,
  43.  *   state: string,
  44.  *   duration: number
  45.  * }}
  46.  *
  47.  * @property {number} timestamp
  48.  *   The timestamp the state was entered, in seconds since 1970
  49.  *   (i.e. <code>Date.now() / 1000</code>).
  50.  * @property {string} state
  51.  *   The state the player entered.  This could be <code>'buffering'</code>,
  52.  *   <code>'playing'</code>, <code>'paused'</code>, or <code>'ended'</code>.
  53.  * @property {number} duration
  54.  *   The number of seconds the player was in this state.  If this is the last
  55.  *   entry in the list, the player is still in this state, so the duration will
  56.  *   continue to increase.
  57.  * @exportDoc
  58.  */
  59. shaka.extern.StateChange;
  62. /**
  63.  * @typedef {{
  64.  *   width: number,
  65.  *   height: number,
  66.  *   streamBandwidth: number,
  67.  *
  68.  *   decodedFrames: number,
  69.  *   droppedFrames: number,
  70.  *   corruptedFrames: number,
  71.  *   estimatedBandwidth: number,
  72.  *
  73.  *   completionPercent: number,
  74.  *   loadLatency: number,
  75.  *   manifestTimeSeconds: number,
  76.  *   drmTimeSeconds: number,
  77.  *   playTime: number,
  78.  *   pauseTime: number,
  79.  *   bufferingTime: number,
  80.  *   licenseTime: number,
  81.  *   liveLatency: number,
  82.  *
  83.  *   maxSegmentDuration: number,
  84.  *
  85.  *   gapsJumped: number,
  86.  *   stallsDetected: number,
  87.  *
  88.  *   manifestSizeBytes: number,
  89.  *   bytesDownloaded: number,
  90.  *
  91.  *   nonFatalErrorCount: number,
  92.  *   manifestPeriodCount: number,
  93.  *   manifestGapCount: number,
  94.  *
  95.  *   switchHistory: !Array.<shaka.extern.TrackChoice>,
  96.  *   stateHistory: !Array.<shaka.extern.StateChange>
  97.  * }}
  98.  *
  99.  * @description
  100.  * Contains statistics and information about the current state of the player.
  101.  * This is meant for applications that want to log quality-of-experience (QoE)
  102.  * or other stats.  These values will reset when <code>load()</code> is called
  103.  * again.
  104.  *
  105.  * @property {number} width
  106.  *   The width of the current video track. If nothing is loaded or the content
  107.  *   is audio-only, NaN.
  108.  * @property {number} height
  109.  *   The height of the current video track. If nothing is loaded or the content
  110.  *   is audio-only, NaN.
  111.  * @property {number} streamBandwidth
  112.  *   The bandwidth required for the current streams (total, in bit/sec).
  113.  *   It takes into account the playbackrate. If nothing is loaded, NaN.
  114.  *
  115.  * @property {number} decodedFrames
  116.  *   The total number of frames decoded by the Player. If not reported by the
  117.  *   browser, NaN.
  118.  * @property {number} droppedFrames
  119.  *   The total number of frames dropped by the Player. If not reported by the
  120.  *   browser, NaN.
  121.  * @property {number} corruptedFrames
  122.  *   The total number of corrupted frames dropped by the browser. If not
  123.  *   reported by the browser, NaN.
  124.  * @property {number} estimatedBandwidth
  125.  *   The current estimated network bandwidth (in bit/sec). If no estimate
  126.  *   available, NaN.
  127.  *
  128.  * @property {number} gapsJumped
  129.  *   The total number of playback gaps jumped by the GapJumpingController.
  130.  *   If nothing is loaded, NaN.
  131.  * @property {number} stallsDetected
  132.  *   The total number of playback stalls detected by the StallDetector.
  133.  *   If nothing is loaded, NaN.
  134.  *
  135.  * @property {number} completionPercent
  136.  *   This is the greatest completion percent that the user has experienced in
  137.  *   playback. Also known as the "high water mark". If nothing is loaded, or
  138.  *   the stream is live (and therefore indefinite), NaN.
  139.  * @property {number} loadLatency
  140.  *   This is the number of seconds it took for the video element to have enough
  141.  *   data to begin playback.  This is measured from the time load() is called to
  142.  *   the time the <code>'loadeddata'</code> event is fired by the media element.
  143.  *   If nothing is loaded, NaN.
  144.  * @property {number} manifestTimeSeconds
  145.  *   The amount of time it took to download and parse the manifest.
  146.  *   If nothing is loaded, NaN.
  147.  * @property {number} drmTimeSeconds
  148.  *   The amount of time it took to download the first drm key, and load that key
  149.  *   into the drm system. If nothing is loaded or DRM is not in use, NaN.
  150.  * @property {number} playTime
  151.  *   The total time spent in a playing state in seconds. If nothing is loaded,
  152.  *   NaN.
  153.  * @property {number} pauseTime
  154.  *   The total time spent in a paused state in seconds. If nothing is loaded,
  155.  *   NaN.
  156.  * @property {number} bufferingTime
  157.  *   The total time spent in a buffering state in seconds. If nothing is
  158.  *   loaded, NaN.
  159.  * @property {number} licenseTime
  160.  *   The time spent on license requests during this session in seconds. If DRM
  161.  *   is not in use, NaN.
  162.  * @property {number} liveLatency
  163.  *   The time between the capturing of a frame and the end user having it
  164.  *   displayed on their screen. If nothing is loaded or the content is VOD,
  165.  *   NaN.
  166.  *
  167.  * @property {number} maxSegmentDuration
  168.  *   The presentation's max segment duration in seconds. If nothing is loaded,
  169.  *   NaN.
  170.  *
  171.  * @property {number} manifestSizeBytes
  172.  *   Size of the manifest payload. For DASH & MSS it will match the latest
  173.  *   downloaded manifest. For HLS, it will match the lastly downloaded playlist.
  174.  *   If nothing is loaded or in src= mode, NaN.
  175.  * @property {number} bytesDownloaded
  176.  *   The bytes downloaded during the playback. If nothing is loaded, NaN.
  177.  *
  178.  * @property {number} nonFatalErrorCount
  179.  *   The amount of non fatal errors that occurred.  If nothing is loaded, NaN.
  180.  * @property {number} manifestPeriodCount
  181.  *   The amount of periods occurred in the manifest. For DASH it represents
  182.  *   number of Period elements in a manifest. For HLS & MSS it is always 1.
  183.  *   In src= mode or if nothing is loaded, NaN.
  184.  * @property {number} manifestGapCount
  185.  *   The amount of gaps found in a manifest. For DASH, it represents number of
  186.  *   discontinuities found between periods. For HLS, it is a number of EXT-X-GAP
  187.  *   and GAP=YES occurrences. For MSS, it is always set to 0.
  188.  *   If in src= mode or nothing is loaded, NaN.
  189.  *
  190.  * @property {!Array.<shaka.extern.TrackChoice>} switchHistory
  191.  *   A history of the stream changes.
  192.  * @property {!Array.<shaka.extern.StateChange>} stateHistory
  193.  *   A history of the state changes.
  194.  * @exportDoc
  195.  */
  196. shaka.extern.Stats;
  199. /**
  200.  * @typedef {{
  201.  *   start: number,
  202.  *   end: number
  203.  * }}
  204.  *
  205.  * @description
  206.  * Contains the times of a range of buffered content.
  207.  *
  208.  * @property {number} start
  209.  *   The start time of the range, in seconds.
  210.  * @property {number} end
  211.  *   The end time of the range, in seconds.
  212.  * @exportDoc
  213.  */
  214. shaka.extern.BufferedRange;
  217. /**
  218.  * @typedef {{
  219.  *   total: !Array.<shaka.extern.BufferedRange>,
  220.  *   audio: !Array.<shaka.extern.BufferedRange>,
  221.  *   video: !Array.<shaka.extern.BufferedRange>,
  222.  *   text: !Array.<shaka.extern.BufferedRange>
  223.  * }}
  224.  *
  225.  * @description
  226.  * Contains information about the current buffered ranges.
  227.  *
  228.  * @property {!Array.<shaka.extern.BufferedRange>} total
  229.  *   The combined audio/video buffered ranges, reported by
  230.  *   <code>video.buffered</code>.
  231.  * @property {!Array.<shaka.extern.BufferedRange>} audio
  232.  *   The buffered ranges for audio content.
  233.  * @property {!Array.<shaka.extern.BufferedRange>} video
  234.  *   The buffered ranges for video content.
  235.  * @property {!Array.<shaka.extern.BufferedRange>} text
  236.  *   The buffered ranges for text content.
  237.  * @exportDoc
  238.  */
  239. shaka.extern.BufferedInfo;
  242. /**
  243.  * @typedef {{
  244.  *   id: number,
  245.  *   active: boolean,
  246.  *
  247.  *   type: string,
  248.  *   bandwidth: number,
  249.  *
  250.  *   language: string,
  251.  *   label: ?string,
  252.  *   kind: ?string,
  253.  *   width: ?number,
  254.  *   height: ?number,
  255.  *   frameRate: ?number,
  256.  *   pixelAspectRatio: ?string,
  257.  *   hdr: ?string,
  258.  *   colorGamut: ?string,
  259.  *   videoLayout: ?string,
  260.  *   mimeType: ?string,
  261.  *   audioMimeType: ?string,
  262.  *   videoMimeType: ?string,
  263.  *   codecs: ?string,
  264.  *   audioCodec: ?string,
  265.  *   videoCodec: ?string,
  266.  *   primary: boolean,
  267.  *   roles: !Array.<string>,
  268.  *   audioRoles: Array.<string>,
  269.  *   accessibilityPurpose: ?shaka.media.ManifestParser.AccessibilityPurpose,
  270.  *   forced: boolean,
  271.  *   videoId: ?number,
  272.  *   audioId: ?number,
  273.  *   channelsCount: ?number,
  274.  *   audioSamplingRate: ?number,
  275.  *   tilesLayout: ?string,
  276.  *   audioBandwidth: ?number,
  277.  *   videoBandwidth: ?number,
  278.  *   spatialAudio: boolean,
  279.  *   originalVideoId: ?string,
  280.  *   originalAudioId: ?string,
  281.  *   originalTextId: ?string,
  282.  *   originalImageId: ?string,
  283.  *   originalLanguage: ?string
  284.  * }}
  285.  *
  286.  * @description
  287.  * An object describing a media track.  This object should be treated as
  288.  * read-only as changing any values does not have any effect.  This is the
  289.  * public view of an audio/video paring (variant type) or text track (text
  290.  * type) or image track (image type).
  291.  *
  292.  * @property {number} id
  293.  *   The unique ID of the track.
  294.  * @property {boolean} active
  295.  *   If true, this is the track being streamed (another track may be
  296.  *   visible/audible in the buffer).
  297.  *
  298.  * @property {string} type
  299.  *   The type of track, either <code>'variant'</code> or <code>'text'</code>
  300.  *   or <code>'image'</code>.
  301.  * @property {number} bandwidth
  302.  *   The bandwidth required to play the track, in bits/sec.
  303.  *
  304.  * @property {string} language
  305.  *   The language of the track, or <code>'und'</code> if not given.  This value
  306.  *   is normalized as follows - language part is always lowercase and translated
  307.  *   to ISO-639-1 when possible, locale part is always uppercase,
  308.  *   i.e. <code>'en-US'</code>.
  309.  * @property {?string} label
  310.  *   The track label, which is unique text that should describe the track.
  311.  * @property {?string} kind
  312.  *   (only for text tracks) The kind of text track, either
  313.  *   <code>'caption'</code> or <code>'subtitle'</code>.
  314.  * @property {?number} width
  315.  *   The video width provided in the manifest, if present.
  316.  * @property {?number} height
  317.  *   The video height provided in the manifest, if present.
  318.  * @property {?number} frameRate
  319.  *   The video framerate provided in the manifest, if present.
  320.  * @property {?string} pixelAspectRatio
  321.  *   The video pixel aspect ratio provided in the manifest, if present.
  322.  * @property {?string} hdr
  323.  *   The video HDR provided in the manifest, if present.
  324.  * @property {?string} colorGamut
  325.  *   The video color gamut provided in the manifest, if present.
  326.  * @property {?string} videoLayout
  327.  *   The video layout provided in the manifest, if present.
  328.  * @property {?string} mimeType
  329.  *   The MIME type of the content provided in the manifest.
  330.  * @property {?string} audioMimeType
  331.  *   The audio MIME type of the content provided in the manifest.
  332.  * @property {?string} videoMimeType
  333.  *   The video MIME type of the content provided in the manifest.
  334.  * @property {?string} codecs
  335.  *   The audio/video codecs string provided in the manifest, if present.
  336.  * @property {?string} audioCodec
  337.  *   The audio codecs string provided in the manifest, if present.
  338.  * @property {?string} videoCodec
  339.  *   The video codecs string provided in the manifest, if present.
  340.  * @property {boolean} primary
  341.  *   True indicates that this in the primary language for the content.
  342.  *   This flag is based on signals from the manifest.
  343.  *   This can be a useful hint about which language should be the default, and
  344.  *   indicates which track Shaka will use when the user's language preference
  345.  *   cannot be satisfied.
  346.  * @property {!Array.<string>} roles
  347.  *   The roles of the track, e.g. <code>'main'</code>, <code>'caption'</code>,
  348.  *   or <code>'commentary'</code>.
  349.  * @property {Array.<string>} audioRoles
  350.  *   The roles of the audio in the track, e.g. <code>'main'</code> or
  351.  *   <code>'commentary'</code>. Will be null for text tracks or variant tracks
  352.  *   without audio.
  353.  * @property {?shaka.media.ManifestParser.AccessibilityPurpose}
  354.  *     accessibilityPurpose
  355.  *   The DASH accessibility descriptor, if one was provided for this track.
  356.  *   For text tracks, this describes the text; otherwise, this is for the audio.
  357.  * @property {boolean} forced
  358.  *   True indicates that this in the forced text language for the content.
  359.  *   This flag is based on signals from the manifest.
  360.  * @property {?number} videoId
  361.  *   (only for variant tracks) The video stream id.
  362.  * @property {?number} audioId
  363.  *   (only for variant tracks) The audio stream id.
  364.  * @property {?number} channelsCount
  365.  *   The count of the audio track channels.
  366.  * @property {?number} audioSamplingRate
  367.  *   Specifies the maximum sampling rate of the content.
  368.  * @property {?string} tilesLayout
  369.  *   The value is a grid-item-dimension consisting of two positive decimal
  370.  *   integers in the format: column-x-row ('4x3'). It describes the arrangement
  371.  *   of Images in a Grid. The minimum valid LAYOUT is '1x1'.
  372.  * @property {boolean} spatialAudio
  373.  *   True indicates that the content has spatial audio.
  374.  *   This flag is based on signals from the manifest.
  375.  * @property {?number} audioBandwidth
  376.  *   (only for variant tracks) The audio stream's bandwidth if known.
  377.  * @property {?number} videoBandwidth
  378.  *   (only for variant tracks) The video stream's bandwidth if known.
  379.  * @property {?string} originalVideoId
  380.  *   (variant tracks only) The original ID of the video part of the track, if
  381.  *   any, as it appeared in the original manifest.
  382.  * @property {?string} originalAudioId
  383.  *   (variant tracks only) The original ID of the audio part of the track, if
  384.  *   any, as it appeared in the original manifest.
  385.  * @property {?string} originalTextId
  386.  *   (text tracks only) The original ID of the text track, if any, as it
  387.  *   appeared in the original manifest.
  388.  * @property {?string} originalImageId
  389.  *   (image tracks only) The original ID of the image track, if any, as it
  390.  *   appeared in the original manifest.
  391.  * @property {?string} originalLanguage
  392.  *   The original language of the track, if any, as it appeared in the original
  393.  *   manifest.  This is the exact value provided in the manifest; for normalized
  394.  *   value use <code>language</code> property.
  395.  * @exportDoc
  396.  */
  397. shaka.extern.Track;
  400. /**
  401.  * @typedef {!Array.<!shaka.extern.Track>}
  402.  */
  403. shaka.extern.TrackList;
  406. /**
  407.  * @typedef {{
  408.  *   minWidth: number,
  409.  *   maxWidth: number,
  410.  *   minHeight: number,
  411.  *   maxHeight: number,
  412.  *   minPixels: number,
  413.  *   maxPixels: number,
  414.  *
  415.  *   minFrameRate: number,
  416.  *   maxFrameRate: number,
  417.  *
  418.  *   minBandwidth: number,
  419.  *   maxBandwidth: number,
  420.  *
  421.  *   minChannelsCount: number,
  422.  *   maxChannelsCount: number
  423.  * }}
  424.  *
  425.  * @description
  426.  * An object describing application restrictions on what tracks can play.  All
  427.  * restrictions must be fulfilled for a track to be playable/selectable.
  428.  * The restrictions system behaves somewhat differently at the ABR level and the
  429.  * player level, so please refer to the documentation for those specific
  430.  * settings.
  431.  *
  432.  * @see shaka.extern.PlayerConfiguration
  433.  * @see shaka.extern.AbrConfiguration
  434.  *
  435.  * @property {number} minWidth
  436.  *   The minimum width of a video track, in pixels.
  437.  *   <br>
  438.  *   Defaults to <code>0</code>.
  439.  * @property {number} maxWidth
  440.  *   The maximum width of a video track, in pixels.
  441.  *   <br>
  442.  *   Defaults to <code>Infinity</code>.
  443.  * @property {number} minHeight
  444.  *   The minimum height of a video track, in pixels.
  445.  *   <br>
  446.  *   Defaults to <code>0</code>.
  447.  * @property {number} maxHeight
  448.  *   The maximum height of a video track, in pixels.
  449.  *   <br>
  450.  *   Defaults to <code>Infinity</code>.
  451.  * @property {number} minPixels
  452.  *   The minimum number of total pixels in a video track (i.e.
  453.  *   <code>width * height</code>).
  454.  *   <br>
  455.  *   Defaults to <code>0</code>.
  456.  * @property {number} maxPixels
  457.  *   The maximum number of total pixels in a video track (i.e.
  458.  *   <code>width * height</code>).
  459.  *   <br>
  460.  *   Defaults to <code>Infinity</code>.
  461.  *
  462.  * @property {number} minFrameRate
  463.  *   The minimum framerate of a variant track.
  464.  *   <br>
  465.  *   Defaults to <code>0</code>.
  466.  * @property {number} maxFrameRate
  467.  *   The maximum framerate of a variant track.
  468.  *   <br>
  469.  *   Defaults to <code>Infinity</code>.
  470.  *
  471.  * @property {number} minBandwidth
  472.  *   The minimum bandwidth of a variant track, in bit/sec.
  473.  *   <br>
  474.  *   Defaults to <code>0</code>.
  475.  * @property {number} maxBandwidth
  476.  *   The maximum bandwidth of a variant track, in bit/sec.
  477.  *   <br>
  478.  *   Defaults to <code>Infinity</code>.
  479.  *
  480.  * @property {number} minChannelsCount
  481.  *   The minimum channels count of a variant track.
  482.  *   <br>
  483.  *   Defaults to <code>0</code>.
  484.  * @property {number} maxChannelsCount
  485.  *   The maximum channels count of a variant track.
  486.  *   <br>
  487.  *   Defaults to <code>Infinity</code>.
  488.  * @exportDoc
  489.  */
  490. shaka.extern.Restrictions;
  493. /**
  494.  * @typedef {{
  495.  *   persistentState: boolean,
  496.  *   encryptionSchemes: !Array<string|null>,
  497.  *   videoRobustnessLevels: !Array<string>,
  498.  *   audioRobustnessLevels: !Array<string>
  499.  * }}
  500.  *
  501.  * @property {boolean} persistentState
  502.  *   Whether this key system supports persistent state.
  503.  * @property {!Array<string|null>} encryptionSchemes
  504.  *   An array of encryption schemes that are reported to work, through either
  505.  *   EME or MCap APIs. An empty array indicates that encryptionScheme queries
  506.  *   are not supported. This should not happen if our polyfills are installed.
  507.  * @property {!Array<string>} videoRobustnessLevels
  508.  *   An array of video robustness levels that are reported to work. An empty
  509.  *   array indicates that none were tested. Not all key systems have a list of
  510.  *   known robustness levels built into probeSupport().
  511.  * @property {!Array<string>} audioRobustnessLevels
  512.  *   An array of audio robustness levels that are reported to work. An empty
  513.  *   array indicates that none were tested. Not all key systems have a list of
  514.  *   known robustness levels built into probeSupport().
  515.  * @exportDoc
  516.  */
  517. shaka.extern.DrmSupportType;
  520. /**
  521.  * @typedef {{
  522.  *   manifest: !Object.<string, boolean>,
  523.  *   media: !Object.<string, boolean>,
  524.  *   drm: !Object.<string, ?shaka.extern.DrmSupportType>,
  525.  *   hardwareResolution: shaka.extern.Resolution
  526.  * }}
  527.  *
  528.  * @description
  529.  * An object detailing browser support for various features.
  530.  *
  531.  * @property {!Object.<string, boolean>} manifest
  532.  *   A map of supported manifest types.
  533.  *   The keys are manifest MIME types and file extensions.
  534.  * @property {!Object.<string, boolean>} media
  535.  *   A map of supported media types.
  536.  *   The keys are media MIME types.
  537.  * @property {!Object.<string, ?shaka.extern.DrmSupportType>} drm
  538.  *   A map of supported key systems.
  539.  *   The keys are the key system names.  The value is <code>null</code> if it is
  540.  *   not supported.  Key systems not probed will not be in this dictionary.
  541.  * @property {shaka.extern.Resolution} hardwareResolution
  542.  *   The maximum detected hardware resolution, which may have
  543.  *   height==width==Infinity for devices without a maximum resolution or
  544.  *   without a way to detect the maximum.
  545.  *
  546.  * @exportDoc
  547.  */
  548. shaka.extern.SupportType;
  550. /**
  551.  * @typedef {{
  552.  *   cueTime: ?number,
  553.  *   data: !Uint8Array,
  554.  *   frames: !Array.<shaka.extern.MetadataFrame>,
  555.  *   dts: ?number,
  556.  *   pts: ?number
  557.  * }}
  558.  *
  559.  * @description
  560.  * ID3 metadata in format defined by
  561.  * https://id3.org/id3v2.3.0#Declared_ID3v2_frames
  562.  * The content of the field.
  563.  *
  564.  * @property {?number} cueTime
  565.  * @property {!Uint8Array} data
  566.  * @property {!Array.<shaka.extern.MetadataFrame>} frames
  567.  * @property {?number} dts
  568.  * @property {?number} pts
  569.  *
  570.  * @exportDoc
  571.  */
  572. shaka.extern.ID3Metadata;
  575. /**
  576.  * @typedef {{
  577.  *   type: string,
  578.  *   size: number,
  579.  *   data: Uint8Array
  580.  * }}
  581.  *
  582.  * @description metadata raw frame.
  583.  * @property {string} type
  584.  * @property {number} size
  585.  * @property {Uint8Array} data
  586.  * @exportDoc
  587.  */
  588. shaka.extern.MetadataRawFrame;
  591. /**
  592.  * @typedef {{
  593.  *   key: string,
  594.  *   data: (ArrayBuffer|string|number),
  595.  *   description: string,
  596.  *   mimeType: ?string,
  597.  *   pictureType: ?number
  598.  * }}
  599.  *
  600.  * @description metadata frame parsed.
  601.  * @property {string} key
  602.  * @property {ArrayBuffer|string|number} data
  603.  * @property {string} description
  604.  * @property {?string} mimeType
  605.  * @property {?number} pictureType
  606.  * @exportDoc
  607.  */
  608. shaka.extern.MetadataFrame;
  611. /**
  612.  * @typedef {{
  613.  *   video: ?shaka.extern.PlaybackStreamInfo,
  614.  *   audio: ?shaka.extern.PlaybackStreamInfo,
  615.  *   text: ?shaka.extern.PlaybackStreamInfo
  616.  * }}
  617.  *
  618.  * @description Represents the state of the current variant and text.
  619.  * @property {?shaka.extern.PlaybackStreamInfo} video
  620.  * @property {?shaka.extern.PlaybackStreamInfo} audio
  621.  * @property {?shaka.extern.PlaybackStreamInfo} text
  622.  * @exportDoc
  623.  */
  624. shaka.extern.PlaybackInfo;
  627. /**
  628.  * @typedef {{
  629.  *   codecs: string,
  630.  *   mimeType: string,
  631.  *   bandwidth: number,
  632.  *   width: ?number,
  633.  *   height: ?number
  634.  * }}
  635.  *
  636.  * @description Represents the state of the given stream.
  637.  * @property {string} codecs
  638.  * @property {string} mimeType
  639.  * @property {number} bandwidth
  640.  * @property {?number} width
  641.  * @property {?number} height
  642.  * @exportDoc
  643.  */
  644. shaka.extern.PlaybackStreamInfo;
  647. /**
  648.  * @typedef {{
  649.  *   startTime: number,
  650.  *   endTime: ?number,
  651.  *   values: !Array.<shaka.extern.MetadataFrame>
  652.  * }}
  653.  *
  654.  * @property {number} startTime
  655.  * @property {?number} endTime
  656.  * @property {!Array.<shaka.extern.MetadataFrame>} values
  657.  * @exportDoc
  658.  */
  659. shaka.extern.HLSInterstitial;
  662. /**
  663.  * @typedef {{
  664.  *   schemeIdUri: string,
  665.  *   value: string,
  666.  *   startTime: number,
  667.  *   endTime: number,
  668.  *   id: string,
  669.  *   eventElement: Element,
  670.  *   eventNode: ?shaka.extern.xml.Node
  671.  * }}
  672.  *
  673.  * @description
  674.  * Contains information about a region of the timeline that will cause an event
  675.  * to be raised when the playhead enters or exits it.  In DASH this is the
  676.  * EventStream element.
  677.  *
  678.  * @property {string} schemeIdUri
  679.  *   Identifies the message scheme.
  680.  * @property {string} value
  681.  *   Specifies the value for the region.
  682.  * @property {number} startTime
  683.  *   The presentation time (in seconds) that the region should start.
  684.  * @property {number} endTime
  685.  *   The presentation time (in seconds) that the region should end.
  686.  * @property {string} id
  687.  *   Specifies an identifier for this instance of the region.
  688.  * @property {Element} eventElement
  689.  *   <b>DEPRECATED</b>: Use eventNode instead.
  690.  *   The XML element that defines the Event.
  691.  * @property {?shaka.extern.xml.Node} eventNode
  692.  *   The XML element that defines the Event.
  693.  * @exportDoc
  694.  */
  695. shaka.extern.TimelineRegionInfo;
  697. /**
  698.  * @typedef {{
  699.  *   audioSamplingRate: ?number,
  700.  *   bandwidth: number,
  701.  *   codecs: string,
  702.  *   contentType: string,
  703.  *   frameRate: ?number,
  704.  *   height: ?number,
  705.  *   mimeType: ?string,
  706.  *   label: ?string,
  707.  *   roles: ?Array.<string>,
  708.  *   language: ?string,
  709.  *   channelsCount: ?number,
  710.  *   pixelAspectRatio: ?string,
  711.  *   width: ?number
  712.  * }}
  713.  *
  714.  * @description
  715.  * Contains information about the quality of an audio or video media stream.
  716.  *
  717.  * @property {?number} audioSamplingRate
  718.  *   Specifies the maximum sampling rate of the content.
  719.  * @property {number} bandwidth
  720.  *   The bandwidth in bits per second.
  721.  * @property {string} codecs
  722.  *   The Stream's codecs, e.g., 'avc1.4d4015' or 'vp9', which must be
  723.  * compatible with the Stream's MIME type.
  724.  * @property {string} contentType
  725.  *   The type of content, which may be "video" or "audio".
  726.  * @property {?number} frameRate
  727.  *   The video frame rate.
  728.  * @property {?number} height
  729.  *   The video height in pixels.
  730.  * @property {string} mimeType
  731.  *   The MIME type.
  732.  * @property {?string} label
  733.  *   The stream's label, when available.
  734.  * @property {?Array.<string>} roles
  735.  *   The stream's role, when available.
  736.  * @property {?string} language
  737.  *   The stream's language, when available.
  738.  * @property {?number} channelsCount
  739.  *   The number of audio channels, or null if unknown.
  740.  * @property {?string} pixelAspectRatio
  741.  *   The pixel aspect ratio value; e.g. "1:1".
  742.  * @property {?number} width
  743.  *   The video width in pixels.
  744.  * @exportDoc
  745.  */
  746. shaka.extern.MediaQualityInfo;
  749. /**
  750.  * @typedef {{
  751.  *   schemeIdUri: string,
  752.  *   value: string,
  753.  *   startTime: number,
  754.  *   endTime: number,
  755.  *   timescale: number,
  756.  *   presentationTimeDelta: number,
  757.  *   eventDuration: number,
  758.  *   id: number,
  759.  *   messageData: Uint8Array
  760.  * }}
  761.  *
  762.  * @description
  763.  * Contains information about an EMSG MP4 box.
  764.  *
  765.  * @property {string} schemeIdUri
  766.  *   Identifies the message scheme.
  767.  * @property {string} value
  768.  *   Specifies the value for the event.
  769.  * @property {number} startTime
  770.  *   The time that the event starts (in presentation time).
  771.  * @property {number} endTime
  772.  *   The time that the event ends (in presentation time).
  773.  * @property {number} timescale
  774.  *   Provides the timescale, in ticks per second.
  775.  * @property {number} presentationTimeDelta
  776.  *   The offset that the event starts, relative to the start of the segment
  777.  *   this is contained in (in units of timescale).
  778.  * @property {number} eventDuration
  779.  *   The duration of the event (in units of timescale).
  780.  * @property {number} id
  781.  *   A field identifying this instance of the message.
  782.  * @property {Uint8Array} messageData
  783.  *   Body of the message.
  784.  * @exportDoc
  785.  */
  786. shaka.extern.EmsgInfo;
  789. /**
  790.  * @typedef {{
  791.  *   wallClockTime: number,
  792.  *   programStartDate: Date
  793.  * }}
  794.  *
  795.  * @description
  796.  * Contains information about an PRFT MP4 box.
  797.  *
  798.  * @property {number} wallClockTime
  799.  *   A UTC timestamp corresponding to decoding time in milliseconds.
  800.  * @property {Date} programStartDate
  801.  *   The derived start date of the program.
  802.  * @exportDoc
  803.  */
  804. shaka.extern.ProducerReferenceTime;
  807. /**
  808.  * @typedef {{
  809.  *   distinctiveIdentifierRequired: boolean,
  810.  *   persistentStateRequired: boolean,
  811.  *   videoRobustness: string,
  812.  *   audioRobustness: string,
  813.  *   serverCertificate: Uint8Array,
  814.  *   serverCertificateUri: string,
  815.  *   individualizationServer: string,
  816.  *   sessionType: string,
  817.  *   headers: !Object.<string, string>
  818.  * }}
  819.  *
  820.  * @property {boolean} distinctiveIdentifierRequired
  821.  *   True if the application requires the key system to support distinctive
  822.  *   identifiers.
  823.  *   <br>
  824.  *   Defaults to <code>false</code>.
  825.  * @property {boolean} persistentStateRequired
  826.  *   True if the application requires the key system to support persistent
  827.  *   state, e.g., for persistent license storage.
  828.  *   <br>
  829.  *   Defaults to <code>false</code>.
  830.  * @property {string} videoRobustness
  831.  *   A key-system-specific string that specifies a required security level for
  832.  *   video.
  833.  *   <br>
  834.  *   Defaults to <code>''</code>, i.e., no specific robustness required.
  835.  * @property {string} audioRobustness
  836.  *   A key-system-specific string that specifies a required security level for
  837.  *   audio.
  838.  *   <br>
  839.  *   Defaults to <code>''</code>, i.e., no specific robustness required.
  840.  * @property {Uint8Array} serverCertificate
  841.  *   <i>An empty certificate (<code>byteLength==0</code>) will be treated as
  842.  *   <code>null</code>.</i> <br>
  843.  *   <i>A certificate will be requested from the license server if
  844.  *   required.</i> <br>
  845.  *   A key-system-specific server certificate used to encrypt license requests.
  846.  *   Its use is optional and is meant as an optimization to avoid a round-trip
  847.  *   to request a certificate.
  848.  *   <br>
  849.  *   Defaults to <code>null</code>.
  850.  * @property {string} serverCertificateUri
  851.  *   If given, will make a request to the given URI to get the server
  852.  *   certificate. This is ignored if <code>serverCertificate</code> is set.
  853.  *   <br>
  854.  *   Defaults to <code>''</code>.
  855.  * @property {string} individualizationServer
  856.  *   The server that handles an <code>'individualiation-request'</code>.  If the
  857.  *   server isn't given, it will default to the license server.
  858.  *   <br>
  859.  *   Defaults to <code>''</code>.
  860.  * @property {string} sessionType
  861.  *   The MediaKey session type to create streaming licenses with.  This doesn't
  862.  *   affect offline storage.
  863.  *   <br>
  864.  *   Defaults to <code>'temporary'</code>.
  865.  * @property {!Object.<string, string>} headers
  866.  *   The headers to use in the license request.
  867.  *   <br>
  868.  *   Defaults to <code>{}</code>.
  869.  *
  870.  * @exportDoc
  871.  */
  872. shaka.extern.AdvancedDrmConfiguration;
  875. /**
  876.  * @typedef {{
  877.  *   sessionId: string,
  878.  *   sessionType: string,
  879.  *   initData: ?Uint8Array,
  880.  *   initDataType: ?string
  881.  * }}
  882.  *
  883.  * @description
  884.  * DRM Session Metadata for an active session
  885.  *
  886.  * @property {string} sessionId
  887.  *   Session id
  888.  * @property {string} sessionType
  889.  *   Session type
  890.  * @property {?Uint8Array} initData
  891.  *   Initialization data in the format indicated by initDataType.
  892.  * @property {string} initDataType
  893.  *   A string to indicate what format initData is in.
  894.  * @exportDoc
  895.  */
  896. shaka.extern.DrmSessionMetadata;
  899. /**
  900.  * @typedef {{
  901.  *   sessionId: string,
  902.  *   initData: ?Uint8Array,
  903.  *   initDataType: ?string
  904.  * }}
  905.  *
  906.  * @description
  907.  * DRM Session Metadata for saved persistent session
  908.  *
  909.  * @property {string} sessionId
  910.  *   Session id
  911.  * @property {?Uint8Array} initData
  912.  *   Initialization data in the format indicated by initDataType.
  913.  * @property {?string} initDataType
  914.  *   A string to indicate what format initData is in.
  915.  * @exportDoc
  916.  */
  917. shaka.extern.PersistentSessionMetadata;
  920. /**
  921.  * @typedef {{
  922.  *   retryParameters: shaka.extern.RetryParameters,
  923.  *   servers: !Object.<string, string>,
  924.  *   clearKeys: !Object.<string, string>,
  925.  *   delayLicenseRequestUntilPlayed: boolean,
  926.  *   persistentSessionOnlinePlayback: boolean,
  927.  *   persistentSessionsMetadata:
  928.  *       !Array.<shaka.extern.PersistentSessionMetadata>,
  929.  *   advanced: Object.<string, shaka.extern.AdvancedDrmConfiguration>,
  930.  *   initDataTransform:(shaka.extern.InitDataTransform|undefined),
  931.  *   logLicenseExchange: boolean,
  932.  *   updateExpirationTime: number,
  933.  *   preferredKeySystems: !Array.<string>,
  934.  *   keySystemsMapping: !Object.<string, string>,
  935.  *   parseInbandPsshEnabled: boolean,
  936.  *   minHdcpVersion: string,
  937.  *   ignoreDuplicateInitData: boolean
  938.  * }}
  939.  *
  940.  * @property {shaka.extern.RetryParameters} retryParameters
  941.  *   Retry parameters for license requests.
  942.  * @property {!Object.<string, string>} servers
  943.  *   <i>Required for all but the clear key CDM.</i> <br>
  944.  *   A dictionary which maps key system IDs to their license servers.
  945.  *   For example,
  946.  *   <code>{'com.widevine.alpha': 'https://example.com/drm'}</code>.
  947.  *   <br>
  948.  *   Defaults to <code>{}</code>.
  949.  * @property {!Object.<string, string>} clearKeys
  950.  *   <i>Forces the use of the Clear Key CDM.</i>
  951.  *   A map of key IDs (hex or base64) to keys (hex or base64).
  952.  *   <br>
  953.  *   Defaults to <code>{}</code>.
  954.  * @property {boolean} delayLicenseRequestUntilPlayed
  955.  *   True to configure drm to delay sending a license request until a user
  956.  *   actually starts playing content.
  957.  *   <br>
  958.  *   Defaults to <code>false</code>.
  959.  * @property {boolean} persistentSessionOnlinePlayback
  960.  *   True to configure drm to try playback with given persistent session ids
  961.  *   before requesting a license. Also prevents the session removal at playback
  962.  *   stop, as-to be able to re-use it later.
  963.  *   <br>
  964.  *   Defaults to <code>false</code>.
  965.  * @property {!Array.<PersistentSessionMetadata>} persistentSessionsMetadata
  966.  *   Persistent sessions metadata to load before starting playback.
  967.  *   <br>
  968.  *   Defaults to <code>[]</code>.
  969.  * @property {Object.<string, shaka.extern.AdvancedDrmConfiguration>} advanced
  970.  *   <i>Optional.</i> <br>
  971.  *   A dictionary which maps key system IDs to advanced DRM configuration for
  972.  *   those key systems.
  973.  *   <br>
  974.  *   Defaults to <code>[]</code>.
  975.  * @property {shaka.extern.InitDataTransform|undefined} initDataTransform
  976.  *   <i>Optional.</i><br>
  977.  *   If given, this function is called with the init data from the
  978.  *   manifest/media and should return the (possibly transformed) init data to
  979.  *   pass to the browser.
  980.  * @property {boolean} logLicenseExchange
  981.  *   <i>Optional.</i><br>
  982.  *   If set to <code>true</code>, prints logs containing the license exchange.
  983.  *   This includes the init data, request, and response data, printed as base64
  984.  *   strings.  Don't use in production, for debugging only; has no affect in
  985.  *   release builds as logging is removed.
  986.  *   <br>
  987.  *   Defaults to <code>false</code>.
  988.  * @property {number} updateExpirationTime
  989.  *   The frequency in seconds with which to check the expiration of a session.
  990.  *   <br>
  991.  *   Defaults to <code>1</code>.
  992.  * @property {!Array.<string>} preferredKeySystems
  993.  *   Specifies the priorties of available DRM key systems.
  994.  *   <br>
  995.  *   Defaults <code>['com.microsoft.playready']</code> on Xbox One and
  996.  *   PlayStation 4, and <code>[]</code> for all other browsers.
  997.  * @property {Object.<string, string>} keySystemsMapping
  998.  *   A map of key system name to key system name.
  999.  *   <br>
  1000.  *   Defaults to <code>{}</code>.
  1001.  * @property {boolean} parseInbandPsshEnabled
  1002.  *   When true parse DRM init data from pssh boxes in media and init segments
  1003.  *   and ignore 'encrypted' events.
  1004.  *   This is required when using in-band key rotation on Xbox One.
  1005.  *   <br>
  1006.  *   Defaults to <code>true</code> on Xbox One, and <code>false</code> for all
  1007.  *   other browsers.
  1008.  * @property {string} minHdcpVersion
  1009.  *   Indicates the minimum version of HDCP to start the playback of encrypted
  1010.  *   streams. <b>May be ignored if not supported by the device.</b>
  1011.  *   <br>
  1012.  *   Defaults to <code>''</code>, do not check the HDCP version.
  1013.  * @property {boolean} ignoreDuplicateInitData
  1014.  *   When true indicate that the player doesn't ignore duplicate init data.
  1015.  *   Note: Tizen 2015 and 2016 models will send multiple webkitneedkey events
  1016.  *   with the same init data. If the duplicates are supressed, playback
  1017.  *   will stall without errors.
  1018.  *   <br>
  1019.  *   Defaults to <code>false</code> on Tizen 2, and <code>true</code> for all
  1020.  *   other browsers.
  1021.  * @exportDoc
  1022.  */
  1023. shaka.extern.DrmConfiguration;
  1025. /**
  1026.  * @typedef {function(!Uint8Array, string, ?shaka.extern.DrmInfo):!Uint8Array}
  1027.  *
  1028.  * @description
  1029.  * A callback function to handle custom content ID signaling for FairPlay
  1030.  * content.
  1031.  *
  1032.  * @exportDoc
  1033.  */
  1034. shaka.extern.InitDataTransform;
  1037. /**
  1038.  * @typedef {{
  1039.  *   tagName: !string,
  1040.  *   attributes: !Object<string, string>,
  1041.  *   children: !Array.<shaka.extern.xml.Node | string>,
  1042.  *   parent: ?shaka.extern.xml.Node
  1043.  * }}
  1044.  *
  1045.  * @description
  1046.  *   Data structure for xml nodes as simple objects
  1047.  *
  1048.  * @property {!string} tagName
  1049.  *   The name of the element
  1050.  * @property {!object} attributes
  1051.  *   The attributes of the element
  1052.  * @property {!Array.<shaka.extern.xml.Node | string>} children
  1053.  *   The child nodes or string body of the element
  1054.  * @property {?shaka.extern.xml.Node} parent
  1055.  *   The parent of the current element
  1056.  *
  1057.  * @exportDoc
  1058.  */
  1059. shaka.extern.xml.Node;
  1061. /**
  1062.  * @typedef {{
  1063.  *   clockSyncUri: string,
  1064.  *   ignoreDrmInfo: boolean,
  1065.  *   disableXlinkProcessing: boolean,
  1066.  *   xlinkFailGracefully: boolean,
  1067.  *   ignoreMinBufferTime: boolean,
  1068.  *   autoCorrectDrift: boolean,
  1069.  *   initialSegmentLimit: number,
  1070.  *   ignoreSuggestedPresentationDelay: boolean,
  1071.  *   ignoreEmptyAdaptationSet: boolean,
  1072.  *   ignoreMaxSegmentDuration: boolean,
  1073.  *   keySystemsByURI: !Object.<string, string>,
  1074.  *   manifestPreprocessor: function(!Element),
  1075.  *   manifestPreprocessorTXml: function(!shaka.extern.xml.Node),
  1076.  *   sequenceMode: boolean,
  1077.  *   enableAudioGroups: boolean,
  1078.  *   multiTypeVariantsAllowed: boolean,
  1079.  *   useStreamOnceInPeriodFlattening: boolean,
  1080.  *   updatePeriod: number,
  1081.  *   enableFastSwitching: boolean
  1082.  * }}
  1083.  *
  1084.  * @property {string} clockSyncUri
  1085.  *   A default clock sync URI to be used with live streams which do not
  1086.  *   contain any clock sync information.  The <code>Date</code> header from this
  1087.  *   URI will be used to determine the current time.
  1088.  *   <br>
  1089.  *   Defaults to <code>''</code>.
  1090.  * @property {boolean} ignoreDrmInfo
  1091.  *   If true will cause DASH parser to ignore DRM information specified
  1092.  *   by the manifest and treat it as if it signaled no particular key
  1093.  *   system and contained no init data.
  1094.  *   <br>
  1095.  *   Defaults to <code>false</code>.
  1096.  * @property {boolean} disableXlinkProcessing
  1097.  *   If true, xlink-related processing will be disabled.
  1098.  *   <br>
  1099.  *   Defaults to <code>false</code>.
  1100.  * @property {boolean} xlinkFailGracefully
  1101.  *   If true, xlink-related errors will result in a fallback to the tag's
  1102.  *   existing contents. If false, xlink-related errors will be propagated
  1103.  *   to the application and will result in a playback failure.
  1104.  *   <br>
  1105.  *   Defaults to <code>false</code>.
  1106.  * @property {boolean} ignoreMinBufferTime
  1107.  *   If true will cause DASH parser to ignore <code>minBufferTime</code> from
  1108.  *   manifest. It allows player config to take precedence over manifest for
  1109.  *   <code>rebufferingGoal</code>.
  1110.  *   <br>
  1111.  *   Defaults to <code>false</code>.
  1112.  * @property {boolean} autoCorrectDrift
  1113.  *   If <code>true</code>, ignore the <code>availabilityStartTime</code> in the
  1114.  *   manifest and instead use the segments to determine the live edge.  This
  1115.  *   allows us to play streams that have a lot of drift.  If <code>false</code>,
  1116.  *   we can't play content where the manifest specifies segments in the future.
  1117.  *   <br>
  1118.  *   Defaults to <code>true</code>.
  1119.  * @property {number} initialSegmentLimit
  1120.  *   The maximum number of initial segments to generate for
  1121.  *   <code>SegmentTemplate</code> with fixed-duration segments.  This is limited
  1122.  *   to avoid excessive memory consumption with very large
  1123.  *   <code>timeShiftBufferDepth</code> values.
  1124.  *   <br>
  1125.  *   Defaults to <code>1000</code>.
  1126.  * @property {boolean} ignoreSuggestedPresentationDelay
  1127.  *   If true will cause DASH parser to ignore
  1128.  *   <code>suggestedPresentationDelay</code> from manifest.
  1129.  *   <br>
  1130.  *   Defaults to <code>false</code>.
  1131.  * @property {boolean} ignoreEmptyAdaptationSet
  1132.  *   If true will cause DASH parser to ignore
  1133.  *   empty <code>AdaptationSet</code> from manifest.
  1134.  *   <br>
  1135.  *   Defaults to <code>false</code>.
  1136.  * @property {boolean} ignoreMaxSegmentDuration
  1137.  *   If true will cause DASH parser to ignore
  1138.  *   <code>maxSegmentDuration</code> from manifest.
  1139.  *   <br>
  1140.  *   Defaults to <code>false</code>.
  1141.  * @property {Object.<string, string>} keySystemsByURI
  1142.  *   A map of scheme URI to key system name. Defaults to default key systems
  1143.  *   mapping handled by Shaka.
  1144.  * @property {function(!Element)} manifestPreprocessor
  1145.  *   <b>DEPRECATED</b>: Use manifestPreprocessorTXml instead.
  1146.  *   Called immediately after the DASH manifest has been parsed into an
  1147.  *   XMLDocument. Provides a way for applications to perform efficient
  1148.  *   preprocessing of the manifest.
  1149.  * @property {function(!shaka.extern.xml.Node)} manifestPreprocessorTXml
  1150.  *   Called immediately after the DASH manifest has been parsed into an
  1151.  *   XMLDocument. Provides a way for applications to perform efficient
  1152.  *   preprocessing of the manifest.
  1153.  * @property {boolean} sequenceMode
  1154.  *   If true, the media segments are appended to the SourceBuffer in
  1155.  *   "sequence mode" (ignoring their internal timestamps).
  1156.  *   <br>
  1157.  *   Defaults to <code>false</code>.
  1158.  * @property {boolean} enableAudioGroups
  1159.  *   If set, audio streams will be grouped and filtered by their parent
  1160.  *   adaptation set ID.
  1161.  *   <br>
  1162.  *   Defaults to <code>false</code>.
  1163.  * @property {boolean} multiTypeVariantsAllowed
  1164.  *   If true, the manifest parser will create variants that have multiple
  1165.  *   mimeTypes or codecs for video or for audio if there is no other choice.
  1166.  *   Meant for content where some periods are only available in one mimeType or
  1167.  *   codec, and other periods are only available in a different mimeType or
  1168.  *   codec. For example, a stream with baked-in ads where the audio codec does
  1169.  *   not match the main content.
  1170.  *   Might result in undesirable behavior if mediaSource.codecSwitchingStrategy
  1171.  *   is not set to SMOOTH.
  1172.  *   <br>
  1173.  *   Defaults to true if SMOOTH codec switching is supported, RELOAD overwise.
  1174.  * @property {boolean} useStreamOnceInPeriodFlattening
  1175.  *   If period combiner is used, this option ensures every stream is used
  1176.  *   only once in period flattening. It speeds up underlying algorithm
  1177.  *   but may raise issues if manifest does not have stream consistency
  1178.  *   between periods.
  1179.  *   <br>
  1180.  *   Defaults to <code>false</code>.
  1181.  * @property {number} updatePeriod
  1182.  *   Override the minimumUpdatePeriod of the manifest. The value is in second
  1183.  *   if the value is greater than the minimumUpdatePeriod, it will update the
  1184.  *   manifest less frequently. if you update the value during for a dynamic
  1185.  *   manifest, it will directly trigger a new download of the manifest
  1186.  *   <br>
  1187.  *   Defaults to <code>-1</code>.
  1188.  * @property {boolean} enableFastSwitching
  1189.  *   If false, disables fast switching track recognition.
  1190.  *   <br>
  1191.  *   Defaults to <code>true</code>.
  1192.  * @exportDoc
  1193.  */
  1194. shaka.extern.DashManifestConfiguration;
  1197. /**
  1198.  * @typedef {{
  1199.  *   ignoreTextStreamFailures: boolean,
  1200.  *   ignoreImageStreamFailures: boolean,
  1201.  *   defaultAudioCodec: string,
  1202.  *   defaultVideoCodec: string,
  1203.  *   ignoreManifestProgramDateTime: boolean,
  1204.  *   ignoreManifestProgramDateTimeForTypes: !Array<string>,
  1205.  *   mediaPlaylistFullMimeType: string,
  1206.  *   liveSegmentsDelay: number,
  1207.  *   sequenceMode: boolean,
  1208.  *   ignoreManifestTimestampsInSegmentsMode: boolean,
  1209.  *   disableCodecGuessing: boolean,
  1210.  *   disableClosedCaptionsDetection: boolean,
  1211.  *   allowLowLatencyByteRangeOptimization: boolean
  1212.  * }}
  1213.  *
  1214.  * @property {boolean} ignoreTextStreamFailures
  1215.  *   If <code>true</code>, ignore any errors in a text stream and filter out
  1216.  *   those streams.
  1217.  *   <br>
  1218.  *   Defaults to <code>false</code>.
  1219.  * @property {boolean} ignoreImageStreamFailures
  1220.  *   If <code>true</code>, ignore any errors in a image stream and filter out
  1221.  *   those streams.
  1222.  *   <br>
  1223.  *   Defaults to <code>false</code>.
  1224.  * @property {string} defaultAudioCodec
  1225.  *   The default audio codec if it is not specified in the HLS playlist.
  1226.  *   <br>
  1227.  *   Defaults to <code>'mp4a.40.2'</code>.
  1228.  * @property {string} defaultVideoCodec
  1229.  *   The default video codec if it is not specified in the HLS playlist.
  1230.  *   <br>
  1231.  *   Defaults to <code>'avc1.42E01E'</code>.
  1232.  * @property {boolean} ignoreManifestProgramDateTime
  1233.  *   If <code>true</code>, the HLS parser will ignore the
  1234.  *   <code>EXT-X-PROGRAM-DATE-TIME</code> tags in the manifest and use media
  1235.  *   sequence numbers instead. It also causes EXT-X-DATERANGE tags to be
  1236.  *   ignored.  Meant for streams where <code>EXT-X-PROGRAM-DATE-TIME</code> is
  1237.  *   incorrect or malformed.
  1238.  *   <br>
  1239.  *   Defaults to <code>false</code>.
  1240.  * @property {!Array.<string>} ignoreManifestProgramDateTimeForTypes
  1241.  *   An array of strings representing types for which
  1242.  *   <code>EXT-X-PROGRAM-DATE-TIME</code> should be ignored. Only used if the
  1243.  *   the main ignoreManifestProgramDateTime is set to false.
  1244.  *   For example, setting this to ['text', 'video'] will cause the PDT values
  1245.  *   text and video streams to be ignored, while still using the PDT values for
  1246.  *   audio.
  1247.  *   <br>
  1248.  *   Defaults to <code>[]</code>.
  1249.  * @property {string} mediaPlaylistFullMimeType
  1250.  *   A string containing a full mime type, including both the basic mime type
  1251.  *   and also the codecs. Used when the HLS parser parses a media playlist
  1252.  *   directly, required since all of the mime type and codecs information is
  1253.  *   contained within the master playlist.
  1254.  *   You can use the <code>shaka.util.MimeUtils.getFullType()</code> utility to
  1255.  *   format this value.
  1256.  *   <br>
  1257.  *   Defaults to <code>'video/mp2t; codecs="avc1.42E01E, mp4a.40.2"'</code>.
  1258.  * @property {number} liveSegmentsDelay
  1259.  *   The default presentation delay will be calculated as a number of segments.
  1260.  *   This is the number of segments for this calculation.
  1261.  *   <br>
  1262.  *   Defaults to <code>3</code>.
  1263.  * @property {boolean} sequenceMode
  1264.  *   If true, the media segments are appended to the SourceBuffer in
  1265.  *   "sequence mode" (ignoring their internal timestamps).
  1266.  *   <br>
  1267.  *   Defaults to <code>true</code> except on WebOS 3, Tizen 2,
  1268.  *   Tizen 3 and PlayStation 4 whose default value is <code>false</code>.
  1269.  * @property {boolean} ignoreManifestTimestampsInSegmentsMode
  1270.  *   If true, don't adjust the timestamp offset to account for manifest
  1271.  *   segment durations being out of sync with segment durations. In other
  1272.  *   words, assume that there are no gaps in the segments when appending
  1273.  *   to the SourceBuffer, even if the manifest and segment times disagree.
  1274.  *   Only applies when sequenceMode is <code>false</code>.
  1275.  *   <br>
  1276.  *   Defaults to <code>false</code>.
  1277.  * @property {boolean} disableCodecGuessing
  1278.  *   If set to true, the HLS parser won't automatically guess or assume default
  1279.  *   codec for playlists with no "CODECS" attribute. Instead, it will attempt to
  1280.  *   extract the missing information from the media segment.
  1281.  *   As a consequence, lazy-loading media playlists won't be possible for this
  1282.  *   use case, which may result in longer video startup times.
  1283.  *   <br>
  1284.  *   Defaults to <code>false</code>.
  1285.  * @property {boolean} disableClosedCaptionsDetection
  1286.  *   If true, disables the automatic detection of closed captions.
  1287.  *   Otherwise, in the absence of a EXT-X-MEDIA tag with TYPE="CLOSED-CAPTIONS",
  1288.  *   Shaka Player will attempt to detect captions based on the media data.
  1289.  *   <br>
  1290.  *   Defaults to <code>false</code>.
  1291.  * @property {boolean} allowLowLatencyByteRangeOptimization
  1292.  *   If set to true, the HLS parser will optimize operation with LL and partial
  1293.  *   byte range segments. More info in
  1294.  *   https://www.akamai.com/blog/performance/-using-ll-hls-with-byte-range-addressing-to-achieve-interoperabi
  1295.  *   <br>
  1296.  *   Defaults to <code>true</code>.
  1297.  * @exportDoc
  1298.  */
  1299. shaka.extern.HlsManifestConfiguration;
  1302. /**
  1303.  * @typedef {{
  1304.  *   manifestPreprocessor: function(!Element),
  1305.  *   manifestPreprocessorTXml: function(!shaka.extern.xml.Node),
  1306.  *   sequenceMode: boolean,
  1307.  *   keySystemsBySystemId: !Object.<string, string>
  1308.  * }}
  1309.  *
  1310.  * @property {function(!Element)} manifestPreprocessor
  1311.  *   <b>DEPRECATED</b>: Use manifestPreprocessorTXml instead.
  1312.  *   Called immediately after the MSS manifest has been parsed into an
  1313.  *   XMLDocument. Provides a way for applications to perform efficient
  1314.  *   preprocessing of the manifest.
  1315.  * @property {function(!shaka.extern.xml.Node)} manifestPreprocessorTXml
  1316.  *   Called immediately after the MSS manifest has been parsed into an
  1317.  *   XMLDocument. Provides a way for applications to perform efficient
  1318.  *   preprocessing of the manifest.
  1319.  * @property {boolean} sequenceMode
  1320.  *   If true, the media segments are appended to the SourceBuffer in
  1321.  *   "sequence mode" (ignoring their internal timestamps).
  1322.  *   <br>
  1323.  *   Defaults to <code>false</code>.
  1324.  * @property {Object.<string, string>} keySystemsBySystemId
  1325.  *   A map of system id to key system name. Defaults to default key systems
  1326.  *   mapping handled by Shaka.
  1327.  * @exportDoc
  1328.  */
  1329. shaka.extern.MssManifestConfiguration;
  1332. /**
  1333.  * @typedef {{
  1334.  *   retryParameters: shaka.extern.RetryParameters,
  1335.  *   availabilityWindowOverride: number,
  1336.  *   disableAudio: boolean,
  1337.  *   disableVideo: boolean,
  1338.  *   disableText: boolean,
  1339.  *   disableThumbnails: boolean,
  1340.  *   defaultPresentationDelay: number,
  1341.  *   segmentRelativeVttTiming: boolean,
  1342.  *   dash: shaka.extern.DashManifestConfiguration,
  1343.  *   hls: shaka.extern.HlsManifestConfiguration,
  1344.  *   mss: shaka.extern.MssManifestConfiguration,
  1345.  *   raiseFatalErrorOnManifestUpdateRequestFailure: boolean,
  1346.  *   continueLoadingWhenPaused: boolean
  1347.  * }}
  1348.  *
  1349.  * @property {shaka.extern.RetryParameters} retryParameters
  1350.  *   Retry parameters for manifest requests.
  1351.  * @property {number} availabilityWindowOverride
  1352.  *   A number, in seconds, that overrides the availability window in the
  1353.  *   manifest, or <code>NaN</code> if the default value should be used.  This is
  1354.  *   enforced by the manifest parser, so custom manifest parsers should take
  1355.  *   care to honor this parameter.
  1356.  *   <br>
  1357.  *   Defaults to <code>NaN</code>.
  1358.  * @property {boolean} disableAudio
  1359.  *   If <code>true</code>, the audio tracks are ignored.
  1360.  *   <br>
  1361.  *   Defaults to <code>false</code>.
  1362.  * @property {boolean} disableVideo
  1363.  *   If <code>true</code>, the video tracks are ignored.
  1364.  *   <br>
  1365.  *   Defaults to <code>false</code>.
  1366.  * @property {boolean} disableText
  1367.  *   If <code>true</code>, the text tracks are ignored.
  1368.  *   <br>
  1369.  *   Defaults to <code>false</code>.
  1370.  * @property {boolean} disableThumbnails
  1371.  *   If <code>true</code>, the image tracks are ignored.
  1372.  *   <br>
  1373.  *   Defaults to <code>false</code>.
  1374.  * @property {number} defaultPresentationDelay
  1375.  *   For DASH, it's a default <code>presentationDelay</code> value if
  1376.  *   <code>suggestedPresentationDelay</code> is missing in the MPEG DASH
  1377.  *   manifest. The default value is <code>1.5 * minBufferTime</code> if not
  1378.  *   configured or set as 0.
  1379.  *   For HLS, the default value is 3 segments duration if not configured or
  1380.  *   set as 0.
  1381.  *   <br>
  1382.  *   Defaults to <code>0</code>.
  1383.  * @property {boolean} segmentRelativeVttTiming
  1384.  *   Option to calculate VTT text timings relative to the segment start
  1385.  *   instead of relative to the period start (which is the default).
  1386.  *   <br>
  1387.  *   Defaults to <code>false</code>.
  1388.  * @property {shaka.extern.DashManifestConfiguration} dash
  1389.  *   Advanced parameters used by the DASH manifest parser.
  1390.  * @property {shaka.extern.HlsManifestConfiguration} hls
  1391.  *   Advanced parameters used by the HLS manifest parser.
  1392.  * @property {shaka.extern.MssManifestConfiguration} mss
  1393.  *   Advanced parameters used by the MSS manifest parser.
  1394.  * @property {boolean} raiseFatalErrorOnManifestUpdateRequestFailure
  1395.  *   If true, manifest update request failures will cause a fatal error.
  1396.  *   <br>
  1397.  *   Defaults to <code>false</code>.
  1398.  * @property {boolean} continueLoadingWhenPaused
  1399.  *   If true, live manifest will be updated with the regular intervals even if
  1400.  *   the video is paused.
  1401.  *   <br>
  1402.  *   Defaults to <code>true</code>.
  1403.  * @exportDoc
  1404.  */
  1405. shaka.extern.ManifestConfiguration;
  1407. /**
  1408.  * @typedef {{
  1409.  *   enabled: boolean,
  1410.  *   stabilityThreshold: number,
  1411.  *   rebufferIncrement: number,
  1412.  *   maxAttempts: number,
  1413.  *   maxLatency: number,
  1414.  *   minLatency: number
  1415.  * }}
  1416.  *
  1417.  * @description
  1418.  * Dynamic Target Latency configuration options.
  1419.  *
  1420.  * @property {boolean} enabled
  1421.  *   If <code>true</code>, dynamic latency for live sync is enabled. When
  1422.  *   enabled, the target latency will be adjusted closer to the min latency
  1423.  *   when playback is stable (see <code>stabilityThreshold</code>). If
  1424.  *   there are rebuffering events, then the target latency will move towards
  1425.  *   the max latency value in increments of <code>rebufferIncrement</code>.
  1426.  *   <br>
  1427.  *   Defaults to <code>false</code>
  1428.  * @property {number} rebufferIncrement
  1429.  *   The value, in seconds, to increment the target latency towards
  1430.  *   <code>maxLatency</code> after a rebuffering event.
  1431.  *   <br>
  1432.  *   Defaults to <code>0.5</code>
  1433.  * @property {number} stabilityThreshold
  1434.  *   Number of seconds after a rebuffering before we are considered stable and
  1435.  *   will move the target latency towards <code>minLatency</code>
  1436.  *   value.
  1437.  *   <br>
  1438.  *   Defaults to <code>60</code>.
  1439.  * @property {number} maxAttempts
  1440.  *   Number of times that dynamic target latency will back off to
  1441.  *   <code>maxLatency</code> and attempt to adjust it closer to
  1442.  *   <code>minLatency</code>.
  1443.  *   <br>
  1444.  *   Defaults to <code>10</code>.
  1445.  * @property {number} maxLatency
  1446.  *   The latency to use when a rebuffering event causes us to back off from
  1447.  *   the live edge.
  1448.  *   <br>
  1449.  *   Defaults to <code>4</code>.
  1450.  * @property {number} minLatency
  1451.  *   The latency to work towards when the network is stable and we want to get
  1452.  *   closer to the live edge.
  1453.  *   <br>
  1454.  *   Defaults to <code>1</code>.
  1455.  * @exportDoc
  1456.  */
  1457. shaka.extern.DynamicTargetLatencyConfiguration;
  1460. /**
  1461.  * @typedef {{
  1462.  *   enabled: boolean,
  1463.  *   targetLatency: number,
  1464.  *   targetLatencyTolerance: number,
  1465.  *   maxPlaybackRate: number,
  1466.  *   minPlaybackRate: number,
  1467.  *   panicMode: boolean,
  1468.  *   panicThreshold: number,
  1469.  *   dynamicTargetLatency: shaka.extern.DynamicTargetLatencyConfiguration
  1470.  * }}
  1471.  *
  1472.  * @description
  1473.  * LiveSync configuration options.
  1474.  *
  1475.  * @property {boolean} enabled
  1476.  *   Enable the live stream sync against the live edge by changing the playback
  1477.  *   rate.
  1478.  *   Note: on some SmartTVs, if this is activated, it may not work or the sound
  1479.  *   may be lost when activated.
  1480.  *   <br>
  1481.  *   Defaults to <code>false</code>.
  1482.  * @property {number} targetLatency
  1483.  *   Preferred latency, in seconds. Effective only if liveSync is true.
  1484.  *   <br>
  1485.  *   Defaults to <code>0.5</code>.
  1486.  * @property {number} targetLatencyTolerance
  1487.  *   Latency tolerance for target latency, in seconds. Effective only if
  1488.  *   liveSync is enabled.
  1489.  *   <br>
  1490.  *   Defaults to <code>0.5</code>.
  1491.  * @property {number} maxPlaybackRate
  1492.  *   Max playback rate used for latency chasing. It is recommended to use a
  1493.  *   value between 1 and 2. Effective only if liveSync is enabled.
  1494.  *   <br>
  1495.  *   Defaults to <code>1.1</code>.
  1496.  * @property {number} minPlaybackRate
  1497.  *   Minimum playback rate used for latency chasing. It is recommended to use a
  1498.  *   value between 0 and 1. Effective only if liveSync is enabled.
  1499.  *   <br>
  1500.  *   Defaults to <code>0.95</code>.
  1501.  * @property {boolean} panicMode
  1502.  *   If <code>true</code>, panic mode for live sync is enabled. When enabled,
  1503.  *   will set the playback rate to the <code>minPlaybackRate</code>
  1504.  *   until playback has continued past a rebuffering for longer than the
  1505.  *   <code>panicThreshold</code>.
  1506.  *   <br>
  1507.  *   Defaults to <code>false</code>.
  1508.  * @property {number} panicThreshold
  1509.  *   Number of seconds that playback stays in panic mode after a rebuffering.
  1510.  *   <br>
  1511.  *   Defaults to <code>60</code>.
  1512.  * @property {shaka.extern.DynamicTargetLatencyConfiguration}
  1513.  * dynamicTargetLatency
  1514.  *
  1515.  *   The dynamic target latency config for dynamically adjusting the target
  1516.  *   latency to be closer to edge when network conditions are good and to back
  1517.  *   off when network conditions are bad.
  1518.  * @exportDoc
  1519.  */
  1520. shaka.extern.LiveSyncConfiguration;
  1523. /**
  1524.  * @typedef {{
  1525.  *   retryParameters: shaka.extern.RetryParameters,
  1526.  *   failureCallback: function(!shaka.util.Error),
  1527.  *   rebufferingGoal: number,
  1528.  *   bufferingGoal: number,
  1529.  *   bufferBehind: number,
  1530.  *   evictionGoal: number,
  1531.  *   ignoreTextStreamFailures: boolean,
  1532.  *   alwaysStreamText: boolean,
  1533.  *   startAtSegmentBoundary: boolean,
  1534.  *   gapDetectionThreshold: number,
  1535.  *   gapJumpTimerTime: number,
  1536.  *   durationBackoff: number,
  1537.  *   safeSeekOffset: number,
  1538.  *   stallEnabled: boolean,
  1539.  *   stallThreshold: number,
  1540.  *   stallSkip: number,
  1541.  *   useNativeHlsForFairPlay: boolean,
  1542.  *   inaccurateManifestTolerance: number,
  1543.  *   lowLatencyMode: boolean,
  1544.  *   autoLowLatencyMode: boolean,
  1545.  *   forceHTTP: boolean,
  1546.  *   forceHTTPS: boolean,
  1547.  *   minBytesForProgressEvents: number,
  1548.  *   preferNativeHls: boolean,
  1549.  *   updateIntervalSeconds: number,
  1550.  *   dispatchAllEmsgBoxes: boolean,
  1551.  *   observeQualityChanges: boolean,
  1552.  *   maxDisabledTime: number,
  1553.  *   parsePrftBox: boolean,
  1554.  *   segmentPrefetchLimit: number,
  1555.  *   prefetchAudioLanguages: !Array<string>,
  1556.  *   disableAudioPrefetch: boolean,
  1557.  *   disableTextPrefetch: boolean,
  1558.  *   disableVideoPrefetch: boolean,
  1559.  *   liveSync: shaka.extern.LiveSyncConfiguration,
  1560.  *   allowMediaSourceRecoveries: boolean,
  1561.  *   minTimeBetweenRecoveries: number,
  1562.  *   vodDynamicPlaybackRate: boolean,
  1563.  *   vodDynamicPlaybackRateLowBufferRate: number,
  1564.  *   vodDynamicPlaybackRateBufferRatio: number,
  1565.  *   infiniteLiveStreamDuration: boolean,
  1566.  *   preloadNextUrlWindow: number,
  1567.  *   loadTimeout: number,
  1568.  *   clearDecodingCache: boolean,
  1569.  *   dontChooseCodecs: boolean,
  1570.  *   shouldFixTimestampOffset: boolean
  1571.  * }}
  1572.  *
  1573.  * @description
  1574.  * The StreamingEngine's configuration options.
  1575.  *
  1576.  * @property {shaka.extern.RetryParameters} retryParameters
  1577.  *   Retry parameters for segment requests.
  1578.  * @property {function(!shaka.util.Error)} failureCallback
  1579.  *   A callback to decide what to do on a streaming failure.  Default behavior
  1580.  *   is to retry on live streams and not on VOD.
  1581.  * @property {number} rebufferingGoal
  1582.  *   The minimum number of seconds of content that the StreamingEngine must
  1583.  *   buffer before it can begin playback or can continue playback after it has
  1584.  *   entered into a buffering state (i.e., after it has depleted one more
  1585.  *   more of its buffers).
  1586.  *   <br>
  1587.  *   Defaults to <code>2</code>.
  1588.  * @property {number} bufferingGoal
  1589.  *   The number of seconds of content that the StreamingEngine will attempt to
  1590.  *   buffer ahead of the playhead. This value must be greater than or equal to
  1591.  *   the rebuffering goal.
  1592.  *   <br>
  1593.  *   Defaults to <code>10</code>.
  1594.  * @property {number} bufferBehind
  1595.  *   The maximum number of seconds of content that the StreamingEngine will keep
  1596.  *   in buffer behind the playhead when it appends a new media segment.
  1597.  *   The StreamingEngine will evict content to meet this limit.
  1598.  *   <br>
  1599.  *   Defaults to <code>30</code>.
  1600.  * @property {number} evictionGoal
  1601.  *   The minimum duration in seconds of buffer overflow the StreamingEngine
  1602.  *   requires to start removing content from the buffer.
  1603.  *   Values less than <code>1.0</code> are not recommended.
  1604.  *   <br>
  1605.  *   Defaults to <code>1.0</code>.
  1606.  * @property {boolean} ignoreTextStreamFailures
  1607.  *   If <code>true</code>, the player will ignore text stream failures and
  1608.  *   continue playing other streams.
  1609.  *   <br>
  1610.  *   Defaults to <code>false</code>.
  1611.  * @property {boolean} alwaysStreamText
  1612.  *   If <code>true</code>, always stream text tracks, regardless of whether or
  1613.  *   not they are shown.  This is necessary when using the browser's built-in
  1614.  *   controls, which are not capable of signaling display state changes back to
  1615.  *   Shaka Player.
  1616.  *   Defaults to <code>false</code>.
  1617.  * @property {boolean} startAtSegmentBoundary
  1618.  *   If <code>true</code>, adjust the start time backwards so it is at the start
  1619.  *   of a segment. This affects both explicit start times and calculated start
  1620.  *   time for live streams. This can put us further from the live edge.
  1621.  *   <br>
  1622.  *   Defaults to <code>false</code>.
  1623.  * @property {number} gapDetectionThreshold
  1624.  *   The maximum distance (in seconds) before a gap when we'll automatically
  1625.  *   jump.
  1626.  *   <br>
  1627.  *   Defaults to <code>0.5</code>.
  1628.  * @property {number} gapJumpTimerTime
  1629.  *   The polling time in seconds to check for gaps in the media.
  1630.  *   <br>
  1631.  *   Defaults to <code>0.25</code>.
  1632.  * @property {number} durationBackoff
  1633.  *   By default, we will not allow seeking to exactly the duration of a
  1634.  *   presentation.  This field is the number of seconds before duration we will
  1635.  *   seek to when the user tries to seek to or start playback at the duration.
  1636.  *   To disable this behavior, the config can be set to 0.  We recommend using
  1637.  *   the default value unless you have a good reason not to.
  1638.  *   <br>
  1639.  *   Defaults to <code>1</code>.
  1640.  * @property {number} safeSeekOffset
  1641.  *   The amount of seconds that should be added when repositioning the playhead
  1642.  *   after falling out of the availability window or seek. This gives the player
  1643.  *   more time to buffer before falling outside again, but increases the forward
  1644.  *   jump in the stream skipping more content. This is helpful for lower
  1645.  *   bandwidth scenarios.
  1646.  *   <br>
  1647.  *   Defaults to <code>5</code>.
  1648.  * @property {boolean} stallEnabled
  1649.  *   When set to <code>true</code>, the stall detector logic will run.  If the
  1650.  *   playhead stops moving for <code>stallThreshold</code> seconds, the player
  1651.  *   will either seek or pause/play to resolve the stall, depending on the value
  1652.  *   of <code>stallSkip</code>.
  1653.  *   <br>
  1654.  *   Defaults to <code>true</code>.
  1655.  * @property {number} stallThreshold
  1656.  *   The maximum number of seconds that may elapse without the playhead moving
  1657.  *   (when playback is expected) before it will be labeled as a stall.
  1658.  *   <br>
  1659.  *   Defaults to <code>1</code>.
  1660.  * @property {number} stallSkip
  1661.  *   The number of seconds that the player will skip forward when a stall has
  1662.  *   been detected.  If 0, the player will pause and immediately play instead of
  1663.  *   seeking.  A value of 0 is recommended and provided as default on TV
  1664.  *   platforms (WebOS, Tizen, Chromecast, etc).
  1665.  *   <br>
  1666.  *   Defaults to <code>0.1</code>  except on Tizen, WebOS, Chromecast,
  1667.  *   Hisense whose default value is <code>0</code>.
  1668.  * @property {boolean} useNativeHlsForFairPlay
  1669.  *   Desktop Safari has both MediaSource and their native HLS implementation.
  1670.  *   Depending on the application's needs, it may prefer one over the other.
  1671.  *   Warning when disabled: Where single-key DRM streams work fine, multi-keys
  1672.  *   streams is showing unexpected behaviours (stall, audio playing with video
  1673.  *   freezes, ...). Use with care.
  1674.  *   <br>
  1675.  *   Defaults to <code>true</code>.
  1676.  * @property {number} inaccurateManifestTolerance
  1677.  *   The maximum difference, in seconds, between the times in the manifest and
  1678.  *   the times in the segments.  Larger values allow us to compensate for more
  1679.  *   drift (up to one segment duration).  Smaller values reduce the incidence of
  1680.  *   extra segment requests necessary to compensate for drift.
  1681.  *   <br>
  1682.  *   Defaults to <code>2</code>.
  1683.  * @property {boolean} lowLatencyMode
  1684.  *   If <code>true</code>, low latency streaming mode is enabled. If
  1685.  *   lowLatencyMode is set to true, it changes the default config values for
  1686.  *   other things, see: docs/tutorials/config.md
  1687.  *   <br>
  1688.  *   Defaults to <code>false</code>.
  1689.  * @property {boolean} autoLowLatencyMode
  1690.  *   If the stream is low latency and the user has not configured the
  1691.  *   lowLatencyMode, but if it has been configured to activate the
  1692.  *   lowLatencyMode if a stream of this type is detected, we automatically
  1693.  *   activate the lowLatencyMode.
  1694.  *   <br>
  1695.  *   Defaults to <code>false</code>.
  1696.  * @property {boolean} forceHTTP
  1697.  *   If true, if the protocol is HTTPs change it to HTTP.
  1698.  *   If both forceHTTP and forceHTTPS are set, forceHTTPS wins.
  1699.  *   <br>
  1700.  *   Defaults to <code>false</code>.
  1701.  * @property {boolean} forceHTTPS
  1702.  *   If true, if the protocol is HTTP change it to HTTPs.
  1703.  *   If both forceHTTP and forceHTTPS are set, forceHTTPS wins.
  1704.  *   <br>
  1705.  *   Defaults to <code>false</code>.
  1706.  * @property {number} minBytesForProgressEvents
  1707.  *   Defines minimum number of bytes that should be used to emit progress event,
  1708.  *   if possible. To avoid issues around feeding ABR with request history, this
  1709.  *   value should be greater than or equal to `abr.advanced.minBytes`.
  1710.  *   By default equals 16e3 (the same value as `abr.advanced.minBytes`).
  1711.  * @property {boolean} preferNativeHls
  1712.  *   If true, prefer native HLS playback when possible, regardless of platform.
  1713.  *   <br>
  1714.  *   Defaults to <code>false</code>.
  1715.  * @property {number} updateIntervalSeconds
  1716.  *   The minimum number of seconds to see if the manifest has changes.
  1717.  *   <br>
  1718.  *   Defaults to <code>1</code>.
  1719.  * @property {boolean} dispatchAllEmsgBoxes
  1720.  *   If true, all emsg boxes are parsed and dispatched.
  1721.  *   <br>
  1722.  *   Defaults to <code>false</code>.
  1723.  * @property {boolean} observeQualityChanges
  1724.  *   If true, monitor media quality changes and emit
  1725.  *   <code>shaka.Player.MediaQualityChangedEvent</code>.
  1726.  *   <br>
  1727.  *   Defaults to <code>false</code>.
  1728.  * @property {number} maxDisabledTime
  1729.  *   The maximum time a variant can be disabled when NETWORK HTTP_ERROR
  1730.  *   is reached, in seconds.
  1731.  *   If all variants are disabled this way, NETWORK HTTP_ERROR will be thrown.
  1732.  *   <br>
  1733.  *   Defaults to <code>30</code>.
  1734.  * @property {boolean} parsePrftBox
  1735.  *   If <code>true</code>, will raise a shaka.extern.ProducerReferenceTime
  1736.  *   player event (event name 'prft').
  1737.  *   The event will be raised only once per playback session as program
  1738.  *   start date will not change, and would save parsing the segment multiple
  1739.  *   times needlessly.
  1740.  *   <br>
  1741.  *   Defaults to <code>false</code>.
  1742.  * @property {number} segmentPrefetchLimit
  1743.  *   The maximum number of segments for each active stream to be prefetched
  1744.  *   ahead of playhead in parallel.
  1745.  *   If <code>0</code>, the segments will be fetched sequentially.
  1746.  *   <br>
  1747.  *   Defaults to <code>0</code>.
  1748.  * @property {!Array<string>} prefetchAudioLanguages
  1749.  *   The audio languages to prefetch.
  1750.  *   <br>
  1751.  *   Defaults to <code>[]</code>.
  1752.  * @property {boolean} disableAudioPrefetch
  1753.  *   If set and prefetch limit is defined, it will prevent from prefetching data
  1754.  *   for audio.
  1755.  *   <br>
  1756.  *   Defaults to <code>false</code>.
  1757.  * @property {boolean} disableTextPrefetch
  1758.  *   If set and prefetch limit is defined, it will prevent from prefetching data
  1759.  *   for text.
  1760.  *   <br>
  1761.  *   Defaults to <code>false</code>.
  1762.  * @property {boolean} disableVideoPrefetch
  1763.  *   If set and prefetch limit is defined, it will prevent from prefetching data
  1764.  *   for video.
  1765.  *   <br>
  1766.  *   Defaults to <code>false</code>.
  1767.  * @property {shaka.extern.LiveSyncConfiguration} liveSync
  1768.  *   The live sync configuration for keeping near the live edge.
  1769.  * @property {boolean} allowMediaSourceRecoveries
  1770.  *   Indicate if we should recover from VIDEO_ERROR resetting Media Source.
  1771.  *   <br>
  1772.  *   Defaults to <code>true</code>.
  1773.  * @property {number} minTimeBetweenRecoveries
  1774.  *   The minimum time between recoveries when VIDEO_ERROR is reached, in
  1775.  *   seconds.
  1776.  *   <br>
  1777.  *   Defaults to <code>5</code>.
  1778.  * @property {boolean} vodDynamicPlaybackRate
  1779.  *   Adapt the playback rate of the player to keep the buffer full.
  1780.  *   <br>
  1781.  *   Defaults to <code>false</code>.
  1782.  * @property {number} vodDynamicPlaybackRateLowBufferRate
  1783.  *   Playback rate to use if the buffer is too small.
  1784.  *   <br>
  1785.  *   Defaults to <code>0.95</code>.
  1786.  * @property {number} vodDynamicPlaybackRateBufferRatio
  1787.  *   Ratio of the <code>bufferingGoal</code> as the low threshold for
  1788.  *   setting the playback rate to
  1789.  *   <code>vodDynamicPlaybackRateLowBufferRate</code>.
  1790.  *   <br>
  1791.  *   Defaults to <code>0.5</code>.
  1792.  * @property {boolean} infiniteLiveStreamDuration
  1793.  *   If <code>true</code>, the media source live duration
  1794.  *   set as a<code>Infinity</code>
  1795.  *   <br>
  1796.  *   Defaults to <code>false</code>.
  1797.  * @property {number} preloadNextUrlWindow
  1798.  *   The window of time at the end of the presentation to begin preloading the
  1799.  *   next URL, such as one specified by a urn:mpeg:dash:chaining:2016 element
  1800.  *   in DASH. Measured in seconds. If the value is 0, the next URL will not
  1801.  *   be preloaded at all.
  1802.  *   <br>
  1803.  *   Defaults to <code>30</code>.
  1804.  * @property {number} loadTimeout
  1805.  *   The maximum timeout to reject the load when using src= in case the content
  1806.  *   does not work correctly.  Measured in seconds.
  1807.  *   <br>
  1808.  *   Defaults to <code>30</code>.
  1809.  * @property {boolean} clearDecodingCache
  1810.  *   Clears decodingInfo and MediaKeySystemAccess cache during player unload
  1811.  *   as these objects may become corrupt and cause issues during subsequent
  1812.  *   playbacks on some platforms.
  1813.  *   <br>
  1814.  *   Defaults to <code>true</code> on PlayStation devices and to
  1815.  *   <code>false</code> on other devices.
  1816.  * @property {boolean} dontChooseCodecs
  1817.  *   If true, we don't choose codecs in the player, and keep all the variants.
  1818.  *   <br>
  1819.  *   Defaults to <code>false</code>.
  1820.  * @property {boolean} shouldFixTimestampOffset
  1821.  *   If true, we will try to fix problems when the timestampOffset is less than
  1822.  *   the baseMediaDecodeTime. This only works when the manifest is DASH with
  1823.  *   MP4 segments.
  1824.  *   <br>
  1825.  *   Defaults to <code>false</code> except on Tizen, WebOS whose default value
  1826.  *   is <code>true</code>.
  1827.  * @exportDoc
  1828.  */
  1829. shaka.extern.StreamingConfiguration;
  1832. /**
  1833.  * @typedef {{
  1834.  *   codecSwitchingStrategy: shaka.config.CodecSwitchingStrategy,
  1835.  *   addExtraFeaturesToSourceBuffer: function(string): string,
  1836.  *   forceTransmux: boolean,
  1837.  *   insertFakeEncryptionInInit: boolean,
  1838.  *   modifyCueCallback: shaka.extern.TextParser.ModifyCueCallback
  1839.  * }}
  1840.  *
  1841.  * @description
  1842.  *   Media source configuration.
  1843.  *
  1844.  * @property {shaka.config.CodecSwitchingStrategy} codecSwitchingStrategy
  1845.  *   Allow codec switching strategy. SMOOTH loading uses
  1846.  *   SourceBuffer.changeType. RELOAD uses cycling of MediaSource.
  1847.  *   <br>
  1848.  *   Defaults to SMOOTH if SMOOTH codec switching is supported, RELOAD
  1849.  *   overwise.
  1850.  * @property {function(string): string} addExtraFeaturesToSourceBuffer
  1851.  *   Callback to generate extra features string based on used MIME type.
  1852.  *   Some platforms may need to pass features when initializing the
  1853.  *   sourceBuffer.
  1854.  *   This string is ultimately appended to a MIME type in addSourceBuffer() &
  1855.  *   changeType().
  1856.  * @property {boolean} forceTransmux
  1857.  *   If this is <code>true</code>, we will transmux AAC and TS content even if
  1858.  *   not strictly necessary for the assets to be played.
  1859.  *   <br>
  1860.  *   Defaults to <code>false</code>.
  1861.  * @property {boolean} insertFakeEncryptionInInit
  1862.  *   If true, will apply a work-around for non-encrypted init segments on
  1863.  *   encrypted content for some platforms.
  1864.  *   <br><br>
  1865.  *   See https://github.com/shaka-project/shaka-player/issues/2759.
  1866.  *   <br><br>
  1867.  *   If you know you don't need this, you canset this value to
  1868.  *   <code>false</code> to gain a few milliseconds on loading time and seek
  1869.  *   time.
  1870.  *   <br><br>
  1871.  *   <br>
  1872.  *   Defaults to <code>true</code>.
  1873.  * @property {shaka.extern.TextParser.ModifyCueCallback} modifyCueCallback
  1874.  *    A callback called for each cue after it is parsed, but right before it
  1875.  *    is appended to the presentation.
  1876.  *    Gives a chance for client-side editing of cue text, cue timing, etc.
  1877.  * @exportDoc
  1878.  */
  1879. shaka.extern.MediaSourceConfiguration;
  1882. /**
  1883.  * @typedef {{
  1884.  *   customPlayheadTracker: boolean,
  1885.  *   skipPlayDetection: boolean,
  1886.  *   supportsMultipleMediaElements: boolean
  1887.  * }}
  1888.  *
  1889.  * @description
  1890.  *   Ads configuration.
  1891.  *
  1892.  * @property {boolean} customPlayheadTracker
  1893.  *   If this is <code>true</code>, we create a custom playhead tracker for
  1894.  *   Client Side. This is useful because it allows you to implement the use of
  1895.  *   IMA on platforms that do not support multiple video elements.
  1896.  *   <br>
  1897.  *   Defaults to <code>false</code> except on Tizen, WebOS, Chromecast,
  1898.  *   Hisense, PlayStation 4, PlayStation5, Xbox whose default value is
  1899.  *   <code>true</code>.
  1900.  * @property {boolean} skipPlayDetection
  1901.  *   If this is true, we will load Client Side ads without waiting for a play
  1902.  *   event.
  1903.  *   <br>
  1904.  *   Defaults to <code>false</code> except on Tizen, WebOS, Chromecast,
  1905.  *   Hisense, PlayStation 4, PlayStation5, Xbox whose default value is
  1906.  *   <code>true</code>.
  1907.  * @property {boolean} supportsMultipleMediaElements
  1908.  *   If this is true, the browser supports multiple media elements.
  1909.  *   <br>
  1910.  *   Defaults to <code>true</code> except on Tizen, WebOS, Chromecast,
  1911.  *   Hisense, PlayStation 4, PlayStation5, Xbox whose default value is
  1912.  *   <code>false</code>.
  1913.  *
  1914.  * @exportDoc
  1915.  */
  1916. shaka.extern.AdsConfiguration;
  1919. /**
  1920.  * @typedef {{
  1921.  *   enabled: boolean,
  1922.  *   useNetworkInformation: boolean,
  1923.  *   defaultBandwidthEstimate: number,
  1924.  *   restrictions: shaka.extern.Restrictions,
  1925.  *   switchInterval: number,
  1926.  *   bandwidthUpgradeTarget: number,
  1927.  *   bandwidthDowngradeTarget: number,
  1928.  *   advanced: shaka.extern.AdvancedAbrConfiguration,
  1929.  *   restrictToElementSize: boolean,
  1930.  *   restrictToScreenSize: boolean,
  1931.  *   ignoreDevicePixelRatio: boolean,
  1932.  *   clearBufferSwitch: boolean,
  1933.  *   safeMarginSwitch: number,
  1934.  *   cacheLoadThreshold: number,
  1935.  *   minTimeToSwitch: number,
  1936.  *   preferNetworkInformationBandwidth: boolean
  1937.  * }}
  1938.  *
  1939.  * @property {boolean} enabled
  1940.  *   If true, enable adaptation by the current AbrManager.
  1941.  *   <br>
  1942.  *   Defaults to <code>true</code>.
  1943.  * @property {boolean} useNetworkInformation
  1944.  *   If true, use the Network Information API in the current AbrManager, if it
  1945.  *   is available in the browser environment.  If the Network Information API is
  1946.  *   used, Shaka Player will ignore the defaultBandwidthEstimate config.
  1947.  *   <br>
  1948.  *   Defaults to <code>true</code>.
  1949.  * @property {number} defaultBandwidthEstimate
  1950.  *   The default bandwidth estimate to use if there is not enough data, in
  1951.  *   bit/sec.  Only used if useNetworkInformation is false, or if the Network
  1952.  *   Information API is not available.
  1953.  *   <br>
  1954.  *   Defaults to <code>1e6</code>.
  1955.  * @property {shaka.extern.Restrictions} restrictions
  1956.  *   The restrictions to apply to ABR decisions.  These are "soft" restrictions.
  1957.  *   Any track that fails to meet these restrictions will not be selected
  1958.  *   automatically, but will still appear in the track list and can still be
  1959.  *   selected via <code>selectVariantTrack()</code>.  If no tracks meet these
  1960.  *   restrictions, AbrManager should not fail, but choose a low-res or
  1961.  *   low-bandwidth variant instead.  It is the responsibility of AbrManager
  1962.  *   implementations to follow these rules and implement this behavior.
  1963.  * @property {number} switchInterval
  1964.  *   The minimum amount of time that must pass between switches, in
  1965.  *   seconds. This keeps us from changing too often and annoying the user.
  1966.  *   <br>
  1967.  *   Defaults to <code>8</code>.
  1968.  * @property {number} bandwidthUpgradeTarget
  1969.  *   The fraction of the estimated bandwidth which we should try to use when
  1970.  *   upgrading.
  1971.  *   <br>
  1972.  *   Defaults to <code>0.85</code>.
  1973.  * @property {number} bandwidthDowngradeTarget
  1974.  *   The largest fraction of the estimated bandwidth we should use. We should
  1975.  *   downgrade to avoid this.
  1976.  *   <br>
  1977.  *   Defaults to <code>0.95</code>.
  1978.  * @property {shaka.extern.AdvancedAbrConfiguration} advanced
  1979.  *   Advanced ABR configuration
  1980.  * @property {boolean} restrictToElementSize
  1981.  *   If true, restrict the quality to media element size.
  1982.  *   Note: The use of ResizeObserver is required for it to work properly. If
  1983.  *   true without ResizeObserver, it behaves as false.
  1984.  *   <br>
  1985.  *   Defaults to <code>false</code>.
  1986.  * @property {boolean} restrictToScreenSize
  1987.  *   If true, restrict the quality to screen size.
  1988.  *   <br>
  1989.  *   Defaults to <code>false</code>.
  1990.  * @property {boolean} ignoreDevicePixelRatio
  1991.  *   If true,device pixel ratio is ignored when restricting the quality to
  1992.  *   media element size or screen size.
  1993.  *   <br>
  1994.  *   Defaults to <code>false</code>.
  1995.  * @property {boolean} clearBufferSwitch
  1996.  *   If true, the buffer will be cleared during the switch.
  1997.  *   The default automatic behavior is false to have a smoother transition.
  1998.  *   On some device it's better to clear buffer.
  1999.  *   <br>
  2000.  *   Defaults to <code>false</code>.
  2001.  * @property {number} safeMarginSwitch
  2002.  *   Optional amount of buffer (in seconds) to
  2003.  *   retain when clearing the buffer during the automatic switch.
  2004.  *   Useful for switching variant quickly without causing a buffering event.
  2005.  *   Ignored if clearBuffer is false.
  2006.  *   Can cause hiccups on some browsers if chosen too small, e.g.
  2007.  *   The amount of two segments is a fair minimum to consider as safeMargin
  2008.  *   value.
  2009.  *   <br>
  2010.  *   Defaults to <code>o</code>.
  2011.  * @property {number} cacheLoadThreshold
  2012.  *   Indicates the value in milliseconds from which a request is not
  2013.  *   considered cached.
  2014.  *   <br>
  2015.  *   Defaults to <code>20</code>.
  2016.  * @property {number} minTimeToSwitch
  2017.  *   Indicates the minimum time to change quality once the real bandwidth is
  2018.  *   available, in seconds. This time is only used on the first load.
  2019.  *   <br>
  2020.  *   Defaults to <code>0</code> seconds except in Apple browsers whose default
  2021.  *   value  is <code>0.5</code> seconds.
  2022.  * @property {boolean} preferNetworkInformationBandwidth
  2023.  *   If true, use the Network Information API bandwidth estimation in the
  2024.  *   current AbrManager, if it is available in the browser environment. This
  2025.  *   way Shaka Player will never estimate the bandwidth and we will always
  2026.  *   trust the information provided by the browser.
  2027.  *   <br>
  2028.  *   Defaults to <code>false</code>.
  2029.  * @exportDoc
  2030.  */
  2031. shaka.extern.AbrConfiguration;
  2034. /**
  2035.  * @typedef {{
  2036.  *   minTotalBytes: number,
  2037.  *   minBytes: number,
  2038.  *   fastHalfLife: number,
  2039.  *   slowHalfLife: number
  2040.  * }}
  2041.  *
  2042.  * @property {number} minTotalBytes
  2043.  *   Minimum number of bytes sampled before we trust the estimate.  If we have
  2044.  *   not sampled much data, our estimate may not be accurate enough to trust.
  2045.  *   <br>
  2046.  *   Defaults to <code>128e3</code>.
  2047.  * @property {number} minBytes
  2048.  *   Minimum number of bytes, under which samples are discarded.  Our models
  2049.  *   do not include latency information, so connection startup time (time to
  2050.  *   first byte) is considered part of the download time.  Because of this, we
  2051.  *   should ignore very small downloads which would cause our estimate to be
  2052.  *   too low.
  2053.  *   <br>
  2054.  *   Defaults to <code>16e3</code>.
  2055.  * @property {number} fastHalfLife
  2056.  *   The quantity of prior samples (by weight) used when creating a new
  2057.  *   estimate, in seconds.  Those prior samples make up half of the
  2058.  *   new estimate.
  2059.  *   <br>
  2060.  *   Defaults to <code>2</code>.
  2061.  * @property {number} slowHalfLife
  2062.  *   The quantity of prior samples (by weight) used when creating a new
  2063.  *   estimate, in seconds.  Those prior samples make up half of the
  2064.  *   new estimate.
  2065.  *   <br>
  2066.  *   Defaults to <code>5</code>.
  2067.  * @exportDoc
  2068.  */
  2069. shaka.extern.AdvancedAbrConfiguration;
  2072. /**
  2073.  * @typedef {{
  2074.  *   enabled: boolean,
  2075.  *   useHeaders: boolean,
  2076.  *   sessionId: string,
  2077.  *   contentId: string,
  2078.  *   rtpSafetyFactor: number,
  2079.  *   includeKeys: !Array<string>
  2080.  * }}
  2081.  *
  2082.  * @description
  2083.  *   Common Media Client Data (CMCD) configuration.
  2084.  *
  2085.  * @property {boolean} enabled
  2086.  *   If <code>true</code>, enable CMCD data to be sent with media requests.
  2087.  *   <br>
  2088.  *   Defaults to <code>false</code>.
  2089.  * @property {boolean} useHeaders
  2090.  *   If <code>true</code>, send CMCD data using the header transmission mode
  2091.  *   instead of query args.
  2092.  *   <br>
  2093.  *   Defaults to <code>false</code>.
  2094.  * @property {string} sessionId
  2095.  *   A GUID identifying the current playback session. A playback session
  2096.  *   typically ties together segments belonging to a single media asset.
  2097.  *   Maximum length is 64 characters. It is RECOMMENDED to conform to the UUID
  2098.  *   specification.
  2099.  *   <br>
  2100.  *   By default the sessionId is automatically generated on each
  2101.  *   <code>load()</code> call.
  2102.  * @property {string} contentId
  2103.  *   A unique string identifying the current content. Maximum length is 64
  2104.  *   characters. This value is consistent across multiple different sessions and
  2105.  *   devices and is defined and updated at the discretion of the service
  2106.  *   provider.
  2107.  *   <br>
  2108.  *   Defaults to <code>'false'</code>.
  2109.  * @property {number} rtpSafetyFactor
  2110.  *   RTP safety factor.
  2111.  *   <br>
  2112.  *   Defaults to <code>5</code>.
  2113.  * @property {!Array<string>} includeKeys
  2114.  *   An array of keys to include in the CMCD data. If not provided, all keys
  2115.  *   will be included.
  2116.  *   <br>
  2117.  *   Defaults to <code>[]</code>.
  2118.  * @exportDoc
  2119.  */
  2120. shaka.extern.CmcdConfiguration;
  2123. /**
  2124.  * @typedef {{
  2125.  *   enabled: boolean,
  2126.  *   applyMaximumSuggestedBitrate: boolean,
  2127.  *   estimatedThroughputWeightRatio: number
  2128.  * }}
  2129.  *
  2130.  * @description
  2131.  *   Common Media Server Data (CMSD) configuration.
  2132.  *
  2133.  * @property {boolean} enabled
  2134.  *   If <code>true</code>, enables reading CMSD data in media requests.
  2135.  *   <br>
  2136.  *   Defaults to <code>true</code>.
  2137.  * @property {boolean} applyMaximumSuggestedBitrate
  2138.  *   If true, we must apply the maximum suggested bitrate. If false, we ignore
  2139.  *   this.
  2140.  *   <br>
  2141.  *   Defaults to <code>true</code>.
  2142.  * @property {number} estimatedThroughputWeightRatio
  2143.  *   How much the estimatedThroughput of the CMSD data should be weighted
  2144.  *   against the default estimate, between 0 and 1.
  2145.  *   <br>
  2146.  *   Defaults to <code>0.5</code>.
  2147.  * @exportDoc
  2148.  */
  2149. shaka.extern.CmsdConfiguration;
  2151. /**
  2152.  * @typedef {{
  2153.  *   enabled: boolean,
  2154.  *   dynamicPerformanceScaling: boolean,
  2155.  *   logLevel: number,
  2156.  *   drawLogo: boolean
  2157.  * }}
  2158.  *
  2159.  * @description
  2160.  *   Decoding for MPEG-5 Part2 LCEVC.
  2161.  *
  2162.  * @property {boolean} enabled
  2163.  *   If <code>true</code>, enable LCEVC.
  2164.  *   Defaults to <code>false</code>.
  2165.  * @property {boolean} dynamicPerformanceScaling
  2166.  *   If <code>true</code>, LCEVC Dynamic Performance Scaling or dps is enabled
  2167.  *   to be triggered, when the system is not able to decode frames within a
  2168.  *   specific tolerance of the fps of the video and disables LCEVC decoding
  2169.  *   for some time. The base video will be shown upscaled to target resolution.
  2170.  *   If it is triggered again within a short period of time, the disabled
  2171.  *   time will be higher and if it is triggered three times in a row the LCEVC
  2172.  *   decoding will be disabled for that playback session.
  2173.  *   If dynamicPerformanceScaling is false, LCEVC decode will be forced
  2174.  *   and will drop frames appropriately if performance is sub optimal.
  2175.  *   <br>
  2176.  *   Defaults to <code>true</code>.
  2177.  * @property {number} logLevel
  2178.  *   Loglevel 0-5 for logging.
  2179.  *   NONE = 0
  2180.  *   ERROR = 1
  2181.  *   WARNING = 2
  2182.  *   INFO = 3
  2183.  *   DEBUG = 4
  2184.  *   VERBOSE = 5
  2185.  *   <br>
  2186.  *   Defaults to <code>0</code>.
  2187.  * @property {boolean} drawLogo
  2188.  *   If <code>true</code>, LCEVC Logo is placed on the top left hand corner
  2189.  *   which only appears when the LCEVC enhanced frames are being rendered.
  2190.  *   Defaults to true for the lib but is forced to false in this integration
  2191.  *   unless explicitly set to true through config.
  2192.  *   <br>
  2193.  *   Defaults to <code>false</code>.
  2194.  * @exportDoc
  2195.  */
  2196. shaka.extern.LcevcConfiguration;
  2198. /**
  2199.  * @typedef {{
  2200.  *   trackSelectionCallback:
  2201.  *       function(shaka.extern.TrackList):!Promise<shaka.extern.TrackList>,
  2202.  *   downloadSizeCallback: function(number):!Promise<boolean>,
  2203.  *   progressCallback: function(shaka.extern.StoredContent,number),
  2204.  *   usePersistentLicense: boolean,
  2205.  *   numberOfParallelDownloads: number
  2206.  * }}
  2207.  *
  2208.  * @property {function(shaka.extern.TrackList):!Promise<shaka.extern.TrackList>}
  2209.  *     trackSelectionCallback
  2210.  *   Called inside <code>store()</code> to determine which tracks to save from a
  2211.  *   manifest. It is passed an array of Tracks from the manifest and it should
  2212.  *   return an array of the tracks to store.
  2213.  * @property {function(number):!Promise<boolean>} downloadSizeCallback
  2214.  *   Called inside <code>store()</code> to determine if the content can be
  2215.  *   downloaded due to its estimated size. The estimated size of the download is
  2216.  *   passed and it must return if the download is allowed or not.
  2217.  * @property {function(shaka.extern.StoredContent,number)} progressCallback
  2218.  *   Called inside <code>store()</code> to give progress info back to the app.
  2219.  *   It is given the current manifest being stored and the progress of it being
  2220.  *   stored.
  2221.  * @property {boolean} usePersistentLicense
  2222.  *   If <code>true</code>, store protected content with a persistent license so
  2223.  *   that no network is required to view.
  2224.  *   If <code>false</code>, store protected content without a persistent
  2225.  *   license.  A network will be required to retrieve a temporary license to
  2226.  *   view.
  2227.  *   <br>
  2228.  *   Defaults to <code>true</code>.
  2229.  * @property {number} numberOfParallelDownloads
  2230.  *   Number of parallel downloads.
  2231.  *   Note: normally browsers limit to 5 request in parallel, so putting a
  2232.  *   number higher than this will not help it download faster.
  2233.  *   <br>
  2234.  *   Defaults to <code>5</code>.
  2235.  * @exportDoc
  2236.  */
  2237. shaka.extern.OfflineConfiguration;
  2240. /**
  2241.  * @typedef {{
  2242.  *   captionsUpdatePeriod: number
  2243.  * }}
  2244.  *
  2245.  * @description
  2246.  *   Text displayer configuration.
  2247.  *
  2248.  * @property {number} captionsUpdatePeriod
  2249.  *   The number of seconds to see if the captions should be updated.
  2250.  *   <br>
  2251.  *   Defaults to <code>0.25</code>.
  2252.  *
  2253.  * @exportDoc
  2254.  */
  2255. shaka.extern.TextDisplayerConfiguration;
  2258. /**
  2259.  * @typedef {{
  2260.  *   ads: shaka.extern.AdsConfiguration,
  2261.  *   autoShowText: shaka.config.AutoShowText,
  2262.  *   drm: shaka.extern.DrmConfiguration,
  2263.  *   manifest: shaka.extern.ManifestConfiguration,
  2264.  *   streaming: shaka.extern.StreamingConfiguration,
  2265.  *   mediaSource: shaka.extern.MediaSourceConfiguration,
  2266.  *   abrFactory: shaka.extern.AbrManager.Factory,
  2267.  *   abr: shaka.extern.AbrConfiguration,
  2268.  *   cmcd: shaka.extern.CmcdConfiguration,
  2269.  *   cmsd: shaka.extern.CmsdConfiguration,
  2270.  *   lcevc: shaka.extern.LcevcConfiguration,
  2271.  *   offline: shaka.extern.OfflineConfiguration,
  2272.  *   preferredAudioLanguage: string,
  2273.  *   preferredAudioLabel: string,
  2274.  *   preferredTextLanguage: string,
  2275.  *   preferredVariantRole: string,
  2276.  *   preferredTextRole: string,
  2277.  *   preferredVideoCodecs: !Array.<string>,
  2278.  *   preferredAudioCodecs: !Array.<string>,
  2279.  *   preferredAudioChannelCount: number,
  2280.  *   preferredVideoHdrLevel: string,
  2281.  *   preferredVideoLayout: string,
  2282.  *   preferredVideoLabel: string,
  2283.  *   preferredDecodingAttributes: !Array.<string>,
  2284.  *   preferForcedSubs: boolean,
  2285.  *   preferSpatialAudio: boolean,
  2286.  *   restrictions: shaka.extern.Restrictions,
  2287.  *   playRangeStart: number,
  2288.  *   playRangeEnd: number,
  2289.  *   textDisplayer: shaka.extern.TextDisplayerConfiguration,
  2290.  *   textDisplayFactory: shaka.extern.TextDisplayer.Factory
  2291.  * }}
  2292.  *
  2293.  * @property {shaka.extern.AdsConfiguration} ads
  2294.  *   Ads configuration and settings.
  2295.  * @property {shaka.config.AutoShowText} autoShowText
  2296.  *   Controls behavior of auto-showing text tracks on load().
  2297.  *   <br>
  2298.  *   Defaults to
  2299.  *   {@link shaka.config.AutoShowText#IF_SUBTITLES_MAY_BE_NEEDED}.
  2300.  * @property {shaka.extern.DrmConfiguration} drm
  2301.  *   DRM configuration and settings.
  2302.  * @property {shaka.extern.ManifestConfiguration} manifest
  2303.  *   Manifest configuration and settings.
  2304.  * @property {shaka.extern.StreamingConfiguration} streaming
  2305.  *   Streaming configuration and settings.
  2306.  * @property {shaka.extern.MediaSourceConfiguration} mediaSource
  2307.  *   Media source configuration and settings.
  2308.  * @property {shaka.extern.AbrManager.Factory} abrFactory
  2309.  *   A factory to construct an abr manager.
  2310.  * @property {shaka.extern.AbrConfiguration} abr
  2311.  *   ABR configuration and settings.
  2312.  * @property {shaka.extern.CmcdConfiguration} cmcd
  2313.  *   CMCD configuration and settings. (Common Media Client Data)
  2314.  * @property {shaka.extern.CmsdConfiguration} cmsd
  2315.  *   CMSD configuration and settings. (Common Media Server Data)
  2316.  * @property {shaka.extern.LcevcConfiguration} lcevc
  2317.  *   MPEG-5 LCEVC configuration and settings.
  2318.  *   (Low Complexity Enhancement Video Codec)
  2319.  * @property {shaka.extern.OfflineConfiguration} offline
  2320.  *   Offline configuration and settings.
  2321.  * @property {string} preferredAudioLanguage
  2322.  *   The preferred language to use for audio tracks.  If not given it will use
  2323.  *   the <code>'main'</code> track.
  2324.  *   Changing this during playback will not affect the current playback.
  2325.  *   <br>
  2326.  *   Defaults to <code>''</code>.
  2327.  * @property {string} preferredAudioLabel
  2328.  *   The preferred label to use for audio tracks.
  2329.  *   <br>
  2330.  *   Defaults to <code>''</code>.
  2331.  * @property {string} preferredVideoLabel
  2332.  *   The preferred label to use for video tracks.
  2333.  *   <br>
  2334.  *   Defaults to <code>''</code>.
  2335.  * @property {string} preferredTextLanguage
  2336.  *   The preferred language to use for text tracks.  If a matching text track
  2337.  *   is found, and the selected audio and text tracks have different languages,
  2338.  *   the text track will be shown.
  2339.  *   Changing this during playback will not affect the current playback.
  2340.  *   <br>
  2341.  *   Defaults to <code>''</code>.
  2342.  * @property {string} preferredVariantRole
  2343.  *   The preferred role to use for variants.
  2344.  *   <br>
  2345.  *   Defaults to <code>''</code>.
  2346.  * @property {string} preferredTextRole
  2347.  *   The preferred role to use for text tracks.
  2348.  *   <br>
  2349.  *   Defaults to <code>''</code>.
  2350.  * @property {!Array.<string>} preferredVideoCodecs
  2351.  *   The list of preferred video codecs, in order of highest to lowest priority.
  2352.  *   <br>
  2353.  *   Defaults to <code>[]</code>.
  2354.  * @property {!Array.<string>} preferredAudioCodecs
  2355.  *   The list of preferred audio codecs, in order of highest to lowest priority.
  2356.  *   <br>
  2357.  *   Defaults to <code>[]</code>.
  2358.  * @property {number} preferredAudioChannelCount
  2359.  *   The preferred number of audio channels.
  2360.  *   <br>
  2361.  *   Defaults to <code>2</code>.
  2362.  * @property {string} preferredVideoHdrLevel
  2363.  *   The preferred HDR level of the video. If possible, this will cause the
  2364.  *   player to filter to assets that either have that HDR level, or no HDR level
  2365.  *   at all.
  2366.  *   Can be 'SDR', 'PQ', 'HLG', 'AUTO' for auto-detect, or '' for no preference.
  2367.  *   Note that one some platforms, such as Chrome, attempting to play PQ content
  2368.  *   may cause problems.
  2369.  *   <br>
  2370.  *   Defaults to <code>'AUTO'</code>.
  2371.  * @property {string} preferredVideoLayout
  2372.  *   The preferred video layout of the video.
  2373.  *   Can be 'CH-STEREO', 'CH-MONO', or '' for no preference.
  2374.  *   If the content is predominantly stereoscopic you should use 'CH-STEREO'.
  2375.  *   If the content is predominantly monoscopic you should use 'CH-MONO'.
  2376.  *   <br>
  2377.  *   Defaults to <code>''</code>.
  2378.  * @property {!Array.<string>} preferredDecodingAttributes
  2379.  *   The list of preferred attributes of decodingInfo, in the order of their
  2380.  *   priorities.
  2381.  *   <br>
  2382.  *   Defaults to <code>[]</code>.
  2383.  * @property {boolean} preferForcedSubs
  2384.  *   If true, a forced text track is preferred.
  2385.  *   If the content has no forced captions and the value is true,
  2386.  *   no text track is chosen.
  2387.  *   Changing this during playback will not affect the current playback.
  2388.  *   <br>
  2389.  *   Defaults to <code>false</code>.
  2390.  * @property {boolean} preferSpatialAudio
  2391.  *   If true, a spatial audio track is preferred.
  2392.  *   <br>
  2393.  *   Defaults to <code>false</code>.
  2394.  * @property {shaka.extern.Restrictions} restrictions
  2395.  *   The application restrictions to apply to the tracks.  These are "hard"
  2396.  *   restrictions.  Any track that fails to meet these restrictions will not
  2397.  *   appear in the track list.  If no tracks meet these restrictions, playback
  2398.  *   will fail.
  2399.  * @property {number} playRangeStart
  2400.  *   Optional playback and seek start time in seconds. Defaults to 0 if
  2401.  *   not provided.
  2402.  *   <br>
  2403.  *   Defaults to <code>0</code>.
  2404.  * @property {number} playRangeEnd
  2405.  *   Optional playback and seek end time in seconds. Defaults to the end of
  2406.  *   the presentation if not provided.
  2407.  *   <br>
  2408.  *   Defaults to <code>Infinity</code>.
  2409.  * @property {shaka.extern.TextDisplayerConfiguration} textDisplayer
  2410.  *   Text displayer configuration and settings.
  2411.  * @property {shaka.extern.TextDisplayer.Factory} textDisplayFactory
  2412.  *   A factory to construct a text displayer. Note that, if this is changed
  2413.  *   during playback, it will cause the text tracks to be reloaded.
  2414.  * @exportDoc
  2415.  */
  2416. shaka.extern.PlayerConfiguration;
  2419. /**
  2420.  * @typedef {{
  2421.  *   language: string,
  2422.  *   role: string,
  2423.  *   label: ?string
  2424.  * }}
  2425.  *
  2426.  * @property {string} language
  2427.  *    The language code for the stream.
  2428.  * @property {string} role
  2429.  *    The role name for the stream. If the stream has no role, <code>role</code>
  2430.  *    will be <code>''</code>.
  2431.  * @property {?string} label
  2432.  *    The label of the audio stream, if it has one.
  2433.  * @exportDoc
  2434.  */
  2435. shaka.extern.LanguageRole;
  2438. /**
  2439.  * @typedef {{
  2440.  *   segment: shaka.media.SegmentReference,
  2441.  *   imageHeight: number,
  2442.  *   imageWidth: number,
  2443.  *   height: number,
  2444.  *   positionX: number,
  2445.  *   positionY: number,
  2446.  *   startTime: number,
  2447.  *   duration: number,
  2448.  *   uris: !Array.<string>,
  2449.  *   width: number,
  2450.  *   sprite: boolean
  2451.  * }}
  2452.  *
  2453.  * @property {shaka.media.SegmentReference} segment
  2454.  *    The segment of this thumbnail.
  2455.  * @property {number} imageHeight
  2456.  *    The image height in px. The image height could be different to height if
  2457.  *    the layout is different to 1x1.
  2458.  * @property {number} imageWidth
  2459.  *    The image width in px. The image width could be different to width if
  2460.  *    the layout is different to 1x1.
  2461.  * @property {number} height
  2462.  *    The thumbnail height in px.
  2463.  * @property {number} positionX
  2464.  *    The thumbnail left position in px.
  2465.  * @property {number} positionY
  2466.  *    The thumbnail top position in px.
  2467.  * @property {number} startTime
  2468.  *    The start time of the thumbnail in the presentation timeline, in seconds.
  2469.  * @property {number} duration
  2470.  *    The duration of the thumbnail, in seconds.
  2471.  * @property {!Array.<string>} uris
  2472.  *   An array of URIs to attempt.  They will be tried in the order they are
  2473.  *   given.
  2474.  * @property {number} width
  2475.  *    The thumbnail width in px.
  2476.  * @property {boolean} sprite
  2477.  *    Indicate if the thumbnail is a sprite.
  2478.  * @exportDoc
  2479.  */
  2480. shaka.extern.Thumbnail;
  2483. /**
  2484.  * @typedef {{
  2485.  *   id: string,
  2486.  *   title: string,
  2487.  *   startTime: number,
  2488.  *   endTime: number
  2489.  * }}
  2490.  *
  2491.  * @property {string} id
  2492.  *    The id of the chapter.
  2493.  * @property {string} title
  2494.  *    The title of the chapter.
  2495.  * @property {number} startTime
  2496.  *    The time that describes the beginning of the range of the chapter.
  2497.  * @property {number} endTime
  2498.  *    The time that describes the end of the range of chapter.
  2499.  * @exportDoc
  2500.  */
  2501. shaka.extern.Chapter;