Source: lib/util/error.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  7. goog.provide('shaka.util.Error');
  10. /**
  11.  * @summary
  12.  * Describes an error that happened.
  13.  *
  14.  * @description
  15.  * This uses numerical codes to describe
  16.  * which error happened.
  17.  *
  18.  * Some error are caused by errors from the browser.  In these cases, the error
  19.  * object is provided as part of the <code>data</code> field.  System codes come
  20.  * from the browser and may or may not be documented.  Here are some places
  21.  * where the errors may be documented:
  22.  * <ul>
  23.  *   <li><a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaError">MediaError</a>
  24.  *   <li><a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status">HTTP Codes</a>
  25.  *   <li><a href="https://hresult.info">Edge/PlayReady errors</a>
  26.  * </ul>
  27.  *
  28.  * @export
  29.  * @implements {shaka.extern.Error}
  30.  * @extends {Error}
  31.  */
  32. shaka.util.Error = class {
  33.   /**
  34.    * @param {shaka.util.Error.Severity} severity
  35.    * @param {shaka.util.Error.Category} category
  36.    * @param {shaka.util.Error.Code} code
  37.    * @param {...*} varArgs
  38.    */
  39.   constructor(severity, category, code, ...varArgs) {
  40.     /**
  41.      * @override
  42.      * @exportInterface
  43.      */
  44.     this.severity = severity;
  45.     /**
  46.      * @override
  47.      * @exportInterface
  48.      */
  49.     this.category = category;
  50.     /**
  51.      * @override
  52.      * @exportInterface
  53.      */
  54.     this.code = code;
  55.     /**
  56.      * @override
  57.      * @exportInterface
  58.      */
  59.     this.data = varArgs;
  60.     /**
  61.      * @override
  62.      * @exportInterface
  63.      */
  64.     this.handled = false;
  66.     // A basic message for compiled mode.
  67.     let formattedMessage = 'Shaka Error ' + this.code;
  68.     if (goog.DEBUG) {
  69.       // This improves the formatting of Errors in failure messages in the
  70.       // tests in debug mode.
  71.       let categoryName = 'UNKNOWN';
  72.       let codeName = 'UNKNOWN';
  74.       for (const k in shaka.util.Error.Category) {
  75.         if (shaka.util.Error.Category[k] == this.category) {
  76.           categoryName = k;
  77.         }
  78.       }
  79.       for (const k in shaka.util.Error.Code) {
  80.         if (shaka.util.Error.Code[k] == this.code) {
  81.           codeName = k;
  82.         }
  83.       }
  85.       formattedMessage = 'Shaka Error ' + categoryName + '.' + codeName +
  86.                          ' (' + this.data.toString() + ')';
  87.     }
  89.     /**
  90.      * In compiled mode, contains a basic message string with the error code.
  91.      * In uncompiled and debug modes, contains a human-readable version of the
  92.      * category and code as enums.
  93.      *
  94.      * @const {string}
  95.      * @exportDoc
  96.      */
  97.     this.message = formattedMessage;
  99.     if (shaka.util.Error.createStack) {
  100.       try {
  101.         throw new Error(this.message || 'Shaka Error');
  102.       } catch (e) {
  103.         /**
  104.          * A stack-trace showing where the error occurred.
  105.          *
  106.          * @const {string}
  107.          * @exportDoc
  108.          */
  109.         this.stack = e.stack;
  110.       }
  111.     }
  112.   }
  115.   /**
  116.    * @return {string}
  117.    * @override
  118.    */
  119.   toString() {
  120.     return 'shaka.util.Error ' + JSON.stringify(this, null, '  ');
  121.   }
  122. };
  125. /**
  126.  * If true, create a stack trace in Error objects.
  127.  *
  128.  * Disabled in tests to avoid issues with karma-jasmine.
  129.  * See comments in test/test/boot.js for details.
  130.  *
  131.  * @type {boolean}
  132.  */
  133. shaka.util.Error.createStack = true;
  135. /**
  136.  * @enum {number}
  137.  * @export
  138.  */
  139. shaka.util.Error.Severity = {
  140.   /**
  141.    * An error occurred, but the Player is attempting to recover from the error.
  142.    *
  143.    * If the Player cannot ultimately recover, it still may not throw a CRITICAL
  144.    * error.  For example, retrying for a media segment will never result in
  145.    * a CRITICAL error (the Player will just retry forever).
  146.    */
  147.   'RECOVERABLE': 1,
  149.   /**
  150.    * A critical error that the library cannot recover from.  These usually cause
  151.    * the Player to stop loading or updating.  A new manifest must be loaded
  152.    * to reset the library.
  153.    */
  154.   'CRITICAL': 2,
  155. };
  158. /**
  159.  * @enum {number}
  160.  * @export
  161.  */
  162. shaka.util.Error.Category = {
  163.   /** Errors from the network stack. */
  164.   'NETWORK': 1,
  166.   /** Errors parsing text streams. */
  167.   'TEXT': 2,
  169.   /** Errors parsing or processing audio or video streams. */
  170.   'MEDIA': 3,
  172.   /** Errors parsing the Manifest. */
  173.   'MANIFEST': 4,
  175.   /** Errors related to streaming. */
  176.   'STREAMING': 5,
  178.   /** Errors related to DRM. */
  179.   'DRM': 6,
  181.   /** Miscellaneous errors from the player. */
  182.   'PLAYER': 7,
  184.   /** Errors related to cast. */
  185.   'CAST': 8,
  187.   /** Errors in the database storage (offline). */
  188.   'STORAGE': 9,
  190.   /** Errors related to ad insertion. */
  191.   'ADS': 10,
  192. };
  195. /**
  196.  * @enum {number}
  197.  * @export
  198.  */
  199. shaka.util.Error.Code = {
  200.   /**
  201.    * A network request was made using an unsupported URI scheme.
  202.    * <br> error.data[0] is the URI.
  203.    */
  204.   'UNSUPPORTED_SCHEME': 1000,
  206.   /**
  207.    * An HTTP network request returned an HTTP status that indicated a failure.
  208.    * <br> error.data[0] is the URI.
  209.    * <br> error.data[1] is the status code.
  210.    * <br> error.data[2] is the response text, or null if the response could not
  211.    *   be interpretted as text.
  212.    * <br> error.data[3] is the map of response headers.
  213.    * <br> error.data[4] is the NetworkingEngine.RequestType of the request,
  214.    *   if one was provided.
  215.    * <br> error.data[5] is the final URI. This may be different if the initial
  216.    *   URI (error.data[0]) issued a redirect.
  217.    */
  218.   'BAD_HTTP_STATUS': 1001,
  220.   /**
  221.    * An HTTP network request failed with an error, but not from the server.
  222.    * <br> error.data[0] is the URI.
  223.    * <br> error.data[1] is the original error.
  224.    * <br> error.data[2] is the NetworkingEngine.RequestType of the request.
  225.    */
  226.   'HTTP_ERROR': 1002,
  228.   /**
  229.    * A network request timed out.
  230.    * <br> error.data[0] is the URI.
  231.    * <br> error.data[1] is the NetworkingEngine.RequestType of the request,
  232.    *   if one was provided.
  233.    */
  234.   'TIMEOUT': 1003,
  236.   /**
  237.    * A network request was made with a malformed data URI.
  238.    * <br> error.data[0] is the URI.
  239.    */
  240.   'MALFORMED_DATA_URI': 1004,
  242.   // RETIRED: 'UNKNOWN_DATA_URI_ENCODING': 1005,
  244.   /**
  245.    * A request filter threw an error.
  246.    * <br> error.data[0] is the original error.
  247.    */
  248.   'REQUEST_FILTER_ERROR': 1006,
  250.   /**
  251.    * A response filter threw an error.
  252.    * <br> error.data[0] is the original error.
  253.    */
  254.   'RESPONSE_FILTER_ERROR': 1007,
  256.   /**
  257.    * A testing network request was made with a malformed URI.
  258.    * This error is only used by unit and integration tests.
  259.    */
  260.   'MALFORMED_TEST_URI': 1008,
  262.   /**
  263.    * An unexpected network request was made to the FakeNetworkingEngine.
  264.    * This error is only used by unit and integration tests.
  265.    */
  266.   'UNEXPECTED_TEST_REQUEST': 1009,
  268.   /**
  269.    * The number of retry attempts have run out.
  270.    * This is an internal error and shouldn't be propagated.
  271.    */
  272.   'ATTEMPTS_EXHAUSTED': 1010,
  274.   /**
  275.    * The segment is missing.
  276.    * <br> error.data[0] is the URI.
  277.    */
  278.   'SEGMENT_MISSING': 1011,
  281.   /** The text parser failed to parse a text stream due to an invalid header. */
  282.   'INVALID_TEXT_HEADER': 2000,
  284.   /**
  285.    * The text parser failed to parse a text stream due to an invalid cue.
  286.    * <br> error.data[0] is extra context, if available.
  287.    */
  288.   'INVALID_TEXT_CUE': 2001,
  290.   // RETIRED: 'INVALID_TEXT_SETTINGS': 2002,
  292.   /**
  293.    * Was unable to detect the encoding of the response text.  Suggest adding
  294.    * byte-order-markings to the response data.
  295.    */
  296.   'UNABLE_TO_DETECT_ENCODING': 2003,
  298.   /** The response data contains invalid Unicode character encoding. */
  299.   'BAD_ENCODING': 2004,
  301.   /**
  302.    * The XML parser failed to parse an xml stream, or the XML lacks mandatory
  303.    * elements for TTML.
  304.    * <br> error.data[0] is extra context, if available.
  305.    */
  306.   'INVALID_XML': 2005,
  308.   // RETIRED: 'INVALID_TTML': 2006,
  310.   /**
  311.    * MP4 segment does not contain TTML.
  312.    */
  313.   'INVALID_MP4_TTML': 2007,
  315.   /**
  316.    * MP4 segment does not contain VTT.
  317.    */
  318.   'INVALID_MP4_VTT': 2008,
  320.   /**
  321.    * When examining media in advance, we were unable to extract the cue time.
  322.    * This should only be possible with HLS, where we do not have explicit
  323.    * segment start times.
  324.    * <br> error.data[0] is the underlying exception or Error object.
  325.    */
  326.   'UNABLE_TO_EXTRACT_CUE_START_TIME': 2009,
  328.   /**
  329.    * MP4 segment for CEA data is invalid.
  330.    */
  331.   'INVALID_MP4_CEA': 2010,
  333.   /**
  334.    * Unable to guess mime type of the text.
  335.    * <br> error.data[0] is the text file's uri.
  336.    */
  337.   'TEXT_COULD_NOT_GUESS_MIME_TYPE': 2011,
  339.   /**
  340.    * External text tracks cannot be added in src= because native platform
  341.    * doesn't support it.
  342.    */
  343.   'CANNOT_ADD_EXTERNAL_TEXT_TO_SRC_EQUALS': 2012,
  345.   /**
  346.    * Only WebVTT is supported when using src=.
  347.    * <br> error.data[0] is the text MIME type.
  348.    */
  349.   'TEXT_ONLY_WEBVTT_SRC_EQUALS': 2013,
  351.   /**
  352.    * The compilation does not contain a required text plugin for this
  353.    * operation.
  354.    * <br> error.data[0] is the text MIME type.
  355.    */
  356.   'MISSING_TEXT_PLUGIN': 2014,
  358.   /**
  359.    * The chapters track failed to load.  The browser does not provide any
  360.    * information in this case to identify why it failed, but there may be
  361.    * details in the JavaScript console.
  362.    */
  363.   'CHAPTERS_TRACK_FAILED': 2015,
  365.   // RETIRED: 'CANNOT_ADD_EXTERNAL_THUMBNAILS_TO_SRC_EQUALS': 2016,
  367.   /**
  368.    * Only external urls of WebVTT type are supported.
  369.    * <br> error.data[0] is the uri.
  370.    */
  371.   'UNSUPPORTED_EXTERNAL_THUMBNAILS_URI': 2017,
  373.   /**
  374.    * Some component tried to read past the end of a buffer.  The segment index,
  375.    * init segment, or PSSH may be malformed.
  376.    */
  377.   'BUFFER_READ_OUT_OF_BOUNDS': 3000,
  379.   /**
  380.    * Some component tried to parse an integer that was too large to fit in a
  381.    * JavaScript number without rounding error.  JavaScript can only natively
  382.    * represent integers up to 53 bits.
  383.    */
  384.   'JS_INTEGER_OVERFLOW': 3001,
  386.   /**
  387.    * The EBML parser used to parse the WebM container encountered an integer,
  388.    * ID, or other field larger than the maximum supported by the parser.
  389.    */
  390.   'EBML_OVERFLOW': 3002,
  392.   /**
  393.    * The EBML parser used to parse the WebM container encountered a floating-
  394.    * point field of a size not supported by the parser.
  395.    */
  396.   'EBML_BAD_FLOATING_POINT_SIZE': 3003,
  398.   /**
  399.    * The MP4 SIDX parser found the wrong box type.
  400.    * Either the segment index range is incorrect or the data is corrupt.
  401.    */
  402.   'MP4_SIDX_WRONG_BOX_TYPE': 3004,
  404.   /**
  405.    * The MP4 SIDX parser encountered an invalid timescale.
  406.    * The segment index data may be corrupt.
  407.    */
  408.   'MP4_SIDX_INVALID_TIMESCALE': 3005,
  410.   /** The MP4 SIDX parser encountered a type of SIDX that is not supported. */
  411.   'MP4_SIDX_TYPE_NOT_SUPPORTED': 3006,
  413.   /**
  414.    * The WebM Cues parser was unable to locate the Cues element.
  415.    * The segment index data may be corrupt.
  416.    */
  417.   'WEBM_CUES_ELEMENT_MISSING': 3007,
  419.   /**
  420.    * The WebM header parser was unable to locate the Ebml element.
  421.    * The init segment data may be corrupt.
  422.    */
  423.   'WEBM_EBML_HEADER_ELEMENT_MISSING': 3008,
  425.   /**
  426.    * The WebM header parser was unable to locate the Segment element.
  427.    * The init segment data may be corrupt.
  428.    */
  429.   'WEBM_SEGMENT_ELEMENT_MISSING': 3009,
  431.   /**
  432.    * The WebM header parser was unable to locate the Info element.
  433.    * The init segment data may be corrupt.
  434.    */
  435.   'WEBM_INFO_ELEMENT_MISSING': 3010,
  437.   /**
  438.    * The WebM header parser was unable to locate the Duration element.
  439.    * The init segment data may be corrupt or may have been incorrectly encoded.
  440.    * Shaka requires a duration in WebM DASH content.
  441.    */
  442.   'WEBM_DURATION_ELEMENT_MISSING': 3011,
  444.   /**
  445.    * The WebM Cues parser was unable to locate the Cue Track Positions element.
  446.    * The segment index data may be corrupt.
  447.    */
  448.   'WEBM_CUE_TRACK_POSITIONS_ELEMENT_MISSING': 3012,
  450.   /**
  451.    * The WebM Cues parser was unable to locate the Cue Time element.
  452.    * The segment index data may be corrupt.
  453.    */
  454.   'WEBM_CUE_TIME_ELEMENT_MISSING': 3013,
  456.   /**
  457.    * A MediaSource operation failed.
  458.    * <br> error.data[0] is a MediaError code from the video element.
  459.    * <br> error.data[1] is the segment URI that triggered the error, if any.
  460.    */
  461.   'MEDIA_SOURCE_OPERATION_FAILED': 3014,
  463.   /**
  464.    * A MediaSource operation threw an exception.
  465.    * <br> error.data[0] is the exception that was thrown.
  466.    * <br> error.data[1] is the error object from the video element.
  467.    * <br> error.data[2] is the segment URI that triggered the error, if any.
  468.    */
  469.   'MEDIA_SOURCE_OPERATION_THREW': 3015,
  471.   /**
  472.    * The video element reported an error.
  473.    * <br> error.data[0] is a MediaError code from the video element.
  474.    * <br> On Edge, error.data[1] is a Microsoft extended error code in hex.
  475.    * <br> On Chrome, error.data[2] is a string with details on the error.
  476.    * <br> See top of file for links to browser error codes.
  477.    */
  478.   'VIDEO_ERROR': 3016,
  480.   /**
  481.    * A MediaSource operation threw QuotaExceededError and recovery failed. The
  482.    * content cannot be played correctly because the segments are too large for
  483.    * the browser/platform. This may occur when attempting to play very high
  484.    * quality, very high bitrate content on low-end devices.
  485.    * <br> error.data[0] is the type of content which caused the error.
  486.    */
  487.   'QUOTA_EXCEEDED_ERROR': 3017,
  489.   /**
  490.    * Transmuxing with our internal transmuxer failed.
  491.    * <br> error.data[0] is the segment URI that triggered the error, if any.
  492.    */
  493.   'TRANSMUXING_FAILED': 3018,
  495.   /**
  496.    * Content transformations required by the platform could not be performed for
  497.    * some reason (unsupported container, etc.)
  498.    * <br> @see https://github.com/shaka-project/shaka-player/issues/2759
  499.    * <br> error.data[0] is the segment URI that triggered the error, if any.
  500.    */
  501.   'CONTENT_TRANSFORMATION_FAILED': 3019,
  503.   /**
  504.    * Important data is missing to be able to do the transmuxing of MSS.
  505.    * <br> error.data[0] is the segment URI that triggered the error, if any.
  506.    */
  507.   'MSS_MISSING_DATA_FOR_TRANSMUXING': 3020,
  509.   // RETIRED: 'MSS_TRANSMUXING_CODEC_UNKNOWN': 3021,
  511.   /**
  512.    * MSS transmuing failed for unknown reason.
  513.    * <br> error.data[0] is the segment URI that triggered the error, if any.
  514.    */
  515.   'MSS_TRANSMUXING_FAILED': 3022,
  517.   /**
  518.    * An internal error which indicates that transmuxing operation has no video
  519.    * data. This should not be seen by applications.
  520.    * <br> error.data[0] is the segment URI that triggered the error, if any.
  521.    */
  522.   'TRANSMUXING_NO_VIDEO_DATA': 3023,
  525.   /**
  526.    * The Player was unable to guess the manifest type based on file extension
  527.    * or MIME type.  To fix, try one of the following:
  528.    * <br><ul>
  529.    *   <li>Rename the manifest so that the URI ends in a well-known extension.
  530.    *   <li>Configure the server to send a recognizable Content-Type header.
  531.    *   <li>Configure the server to accept a HEAD request for the manifest.
  532.    * </ul>
  533.    * <br> error.data[0] is the manifest URI.
  534.    * <br> error.data[1] is the detected or specified MIME type.
  535.    */
  536.   'UNABLE_TO_GUESS_MANIFEST_TYPE': 4000,
  538.   /**
  539.    * The DASH Manifest contained invalid XML markup.
  540.    * <br> error.data[0] is the URI associated with the XML.
  541.    */
  542.   'DASH_INVALID_XML': 4001,
  544.   /**
  545.    * The DASH Manifest contained a Representation with insufficient segment
  546.    * information.
  547.    */
  548.   'DASH_NO_SEGMENT_INFO': 4002,
  550.   /** The DASH Manifest contained an AdaptationSet with no Representations. */
  551.   'DASH_EMPTY_ADAPTATION_SET': 4003,
  553.   /** The DASH Manifest contained an Period with no AdaptationSets. */
  554.   'DASH_EMPTY_PERIOD': 4004,
  556.   /**
  557.    * The DASH Manifest does not specify an init segment with a WebM container.
  558.    */
  559.   'DASH_WEBM_MISSING_INIT': 4005,
  561.   /** The DASH Manifest contained an unsupported container format. */
  562.   'DASH_UNSUPPORTED_CONTAINER': 4006,
  564.   /** The embedded PSSH data has invalid encoding. */
  565.   'DASH_PSSH_BAD_ENCODING': 4007,
  567.   /**
  568.    * There is an AdaptationSet whose Representations do not have any common
  569.    * key-systems.
  570.    */
  571.   'DASH_NO_COMMON_KEY_SYSTEM': 4008,
  573.   /** Having multiple key IDs per Representation is not supported. */
  574.   'DASH_MULTIPLE_KEY_IDS_NOT_SUPPORTED': 4009,
  576.   /** The DASH Manifest specifies conflicting key IDs. */
  577.   'DASH_CONFLICTING_KEY_IDS': 4010,
  579.   // RETIRED: 'UNPLAYABLE_PERIOD': 4011,
  581.   /**
  582.    * There exist some streams that could be decoded, but restrictions imposed
  583.    * by the application or the key system prevent us from playing.  This may
  584.    * happen under the following conditions:
  585.    * <ul>
  586.    *   <li>The application has given restrictions to the Player that restrict
  587.    *       at least one content type completely (e.g. no playable audio).
  588.    *   <li>The manifest specifies different keys than were given to us from the
  589.    *       license server.
  590.    *   <li>The key system has imposed output restrictions that cannot be met
  591.    *       (such as HDCP) and there are no unrestricted alternatives.
  592.    * </ul>
  593.    * <br> error.data[0] is a {@link shaka.extern.RestrictionInfo} object
  594.    * describing the kinds of restrictions that caused this error.
  595.    */
  596.   'RESTRICTIONS_CANNOT_BE_MET': 4012,
  598.   // RETIRED: 'INTERNAL_ERROR_KEY_STATUS': 4013,
  600.   // RETIRED: 'NO_PERIODS': 4014,
  602.   /**
  603.    * HLS playlist doesn't start with a mandory #EXTM3U tag.
  604.    */
  605.   'HLS_PLAYLIST_HEADER_MISSING': 4015,
  607.   /**
  608.    * HLS tag has an invalid name that doesn't start with '#EXT'
  609.    * <br> error.data[0] is the invalid tag.
  610.    */
  611.   'INVALID_HLS_TAG': 4016,
  613.   /**
  614.    * HLS playlist has both Master and Media/Segment tags.
  615.    */
  616.   'HLS_INVALID_PLAYLIST_HIERARCHY': 4017,
  618.   /**
  619.    * A Representation has an id that is the same as another Representation in
  620.    * the same Period.  This makes manifest updates impossible since we cannot
  621.    * map the updated Representation to the old one.
  622.    */
  623.   'DASH_DUPLICATE_REPRESENTATION_ID': 4018,
  625.   // RETIRED: 'HLS_MEDIA_INIT_SECTION_INFO_MISSING': 4019,
  627.   /**
  628.    * HLS manifest has several #EXT-X-MAP tags. We can only
  629.    * support one at the moment.
  630.    */
  631.   'HLS_MULTIPLE_MEDIA_INIT_SECTIONS_FOUND': 4020,
  633.   // RETIRED: 'HLS_COULD_NOT_GUESS_MIME_TYPE': 4021,
  635.   // RETIRED: 'HLS_MASTER_PLAYLIST_NOT_PROVIDED': 4022,
  637.   /**
  638.    * One of the required attributes was not provided, so the
  639.    * HLS manifest is invalid.
  640.    * <br> error.data[0] is the missing attribute's name.
  641.    */
  642.   'HLS_REQUIRED_ATTRIBUTE_MISSING': 4023,
  644.   /**
  645.    * One of the required tags was not provided, so the
  646.    * HLS manifest is invalid.
  647.    * <br> error.data[0] is the missing tag's name.
  648.    */
  649.   'HLS_REQUIRED_TAG_MISSING': 4024,
  651.   /**
  652.    * The HLS parser was unable to guess codecs of a stream.
  653.    * <br> error.data[0] is the list of all codecs for the variant.
  654.    */
  655.   'HLS_COULD_NOT_GUESS_CODECS': 4025,
  657.   /**
  658.    * The HLS parser has encountered encrypted content with unsupported
  659.    * KEYFORMAT attributes.
  660.    */
  661.   'HLS_KEYFORMATS_NOT_SUPPORTED': 4026,
  663.   /**
  664.    * The manifest parser only supports xlink links with xlink:actuate="onLoad".
  665.    */
  666.   'DASH_UNSUPPORTED_XLINK_ACTUATE': 4027,
  668.   /**
  669.    * The manifest parser has hit its depth limit on xlink link chains.
  670.    */
  671.   'DASH_XLINK_DEPTH_LIMIT': 4028,
  673.   // RETIRED: 'HLS_LIVE_CONTENT_NOT_SUPPORTED': 4029,
  675.   // RETIRED: 'HLS_COULD_NOT_PARSE_SEGMENT_START_TIME': 4030,
  677.   // RETIRED: 'HLS_MEDIA_SEQUENCE_REQUIRED_IN_LIVE_STREAMS': 4031,
  679.   /**
  680.    * The content container or codecs are not supported by this browser. For
  681.    * example, this could happen if the content is WebM, but your browser does
  682.    * not support the WebM container, or if the content uses HEVC, but your
  683.    * browser does not support the HEVC codec.  This can also occur for
  684.    * multicodec or multicontainer manifests if none of the codecs or containers
  685.    * are supported by the browser.
  686.    *
  687.    * To see what your browser supports, you can check the JSON data dumped by
  688.    * http://support.shaka-player-demo.appspot.com/
  689.    */
  690.   'CONTENT_UNSUPPORTED_BY_BROWSER': 4032,
  692.   /**
  693.    * External text tracks cannot be added to live streams.
  694.    */
  695.   'CANNOT_ADD_EXTERNAL_TEXT_TO_LIVE_STREAM': 4033,
  697.   // RETIRED: 'HLS_AES_128_ENCRYPTION_NOT_SUPPORTED': 4034,
  698.   // RETIRED: 'HLS_INTERNAL_SKIP_STREAM': 4035,
  700.   /** The Manifest contained no Variants. */
  701.   'NO_VARIANTS': 4036,
  703.   /**
  704.    * We failed to find matching streams across DASH Periods, and the
  705.    * period-flattening aglorithm introduced in v3.0 has failed.
  706.    */
  707.   'PERIOD_FLATTENING_FAILED': 4037,
  709.   /**
  710.    * We failed to find matching streams across DASH Periods due to inconsistent
  711.    * DRM systems across periods.
  712.    */
  713.   'INCONSISTENT_DRM_ACROSS_PERIODS': 4038,
  715.   /**
  716.    * The HLS manifest refers to an undeclared variables.
  717.    * <br> error.data[0] is the variable undeclared.
  718.    */
  719.   'HLS_VARIABLE_NOT_FOUND': 4039,
  721.   /**
  722.    * We do not support playing encrypted mp2t with MSE
  723.    */
  724.   'HLS_MSE_ENCRYPTED_MP2T_NOT_SUPPORTED': 4040,
  726.   /**
  727.    * We do not support playing encrypted content (different than mp2t) with MSE
  728.    * and legacy Apple MediaKeys API.
  729.    */
  730.   'HLS_MSE_ENCRYPTED_LEGACY_APPLE_MEDIA_KEYS_NOT_SUPPORTED': 4041,
  732.   /**
  733.    * Web Crypto API is not available (to decrypt AES-128 streams). Web Crypto
  734.    * only exists in secure origins like https.
  735.    */
  736.   'NO_WEB_CRYPTO_API': 4042,
  738.   // RETIRED: 'HLS_AES_128_INVALID_IV_LENGTH': 4043,
  739.   // RETIRED: 'HLS_AES_128_INVALID_KEY_LENGTH': 4044,
  741.   /**
  742.    * External thumbnails tracks cannot be added to live streams.
  743.    */
  744.   'CANNOT_ADD_EXTERNAL_THUMBNAILS_TO_LIVE_STREAM': 4045,
  746.   /**
  747.    * The MSS Manifest contained invalid XML markup.
  748.    * <br> error.data[0] is the URI associated with the XML.
  749.    */
  750.   'MSS_INVALID_XML': 4046,
  752.   /**
  753.    * MSS parser encountered a live playlist.
  754.    */
  755.   'MSS_LIVE_CONTENT_NOT_SUPPORTED': 4047,
  757.   /**
  758.    * AES-128 iv length should be 16 bytes.
  759.    */
  760.   'AES_128_INVALID_IV_LENGTH': 4048,
  762.   /**
  763.    * AES-128 encryption key length should be 16 bytes.
  764.    */
  765.   'AES_128_INVALID_KEY_LENGTH': 4049,
  767.   /**
  768.    * The DASH Manifest specifies conflicting AES-128 keys.
  769.    */
  770.   'DASH_CONFLICTING_AES_128': 4050,
  772.   /**
  773.    * The DASH Manifest specifies a unsupported AES-128 encryption.
  774.    */
  775.   'DASH_UNSUPPORTED_AES_128': 4051,
  777.   /**
  778.    * Patch requested during an update did not match original manifest.
  779.    */
  780.   'DASH_INVALID_PATCH': 4052,
  783.   // RETIRED: 'INCONSISTENT_BUFFER_STATE': 5000,
  784.   // RETIRED: 'INVALID_SEGMENT_INDEX': 5001,
  785.   // RETIRED: 'SEGMENT_DOES_NOT_EXIST': 5002,
  786.   // RETIRED: 'CANNOT_SATISFY_BYTE_LIMIT': 5003,
  787.   // RETIRED: 'BAD_SEGMENT': 5004,
  788.   // RETIRED: 'INVALID_STREAMS_CHOSEN': 5005,
  790.   /**
  791.    * This would only happen if StreamingEngine were not started correctly, and
  792.    * should not be seen in production.
  793.    */
  794.   'STREAMING_ENGINE_STARTUP_INVALID_STATE': 5006,
  797.   /**
  798.    * The manifest indicated protected content, but the manifest parser was
  799.    * unable to determine what key systems should be used.
  800.    */
  801.   'NO_RECOGNIZED_KEY_SYSTEMS': 6000,
  803.   /**
  804.    * None of the requested key system configurations are available.  This may
  805.    * happen under the following conditions:
  806.    * <ul>
  807.    *   <li> The key system is not supported.
  808.    *   <li> The key system does not support the features requested (e.g.
  809.    *        persistent state).
  810.    *   <li> A user prompt was shown and the user denied access.
  811.    *   <li> The key system is not available from unsecure contexts. (i.e.
  812.             requires HTTPS) See https://bit.ly/2K9X1nY
  813.    * </ul>
  814.    */
  815.   'REQUESTED_KEY_SYSTEM_CONFIG_UNAVAILABLE': 6001,
  817.   /**
  818.    * The browser found one of the requested key systems, but it failed to
  819.    * create an instance of the CDM for some unknown reason.
  820.    * <br> error.data[0] is an error message string from the browser.
  821.    */
  822.   'FAILED_TO_CREATE_CDM': 6002,
  824.   /**
  825.    * The browser found one of the requested key systems and created an instance
  826.    * of the CDM, but it failed to attach the CDM to the video for some unknown
  827.    * reason.
  828.    * <br> error.data[0] is an error message string from the browser.
  829.    */
  830.   'FAILED_TO_ATTACH_TO_VIDEO': 6003,
  832.   /**
  833.    * The CDM rejected the server certificate supplied by the application.
  834.    * The certificate may be malformed or in an unsupported format.
  835.    * <br> error.data[0] is an error message string from the browser.
  836.    */
  837.   'INVALID_SERVER_CERTIFICATE': 6004,
  839.   /**
  840.    * The CDM refused to create a session for some unknown reason.
  841.    * <br> error.data[0] is an error message string from the browser.
  842.    */
  843.   'FAILED_TO_CREATE_SESSION': 6005,
  845.   /**
  846.    * The CDM was unable to generate a license request for the init data it was
  847.    * given.  The init data may be malformed or in an unsupported format.
  848.    * <br> error.data[0] is an error message string from the browser.
  849.    * <br> error.data[1] is the error object from the browser.
  850.    * <br> error.data[2] is a string with the extended error code, if available.
  851.    * <br> See top of file for links to browser error codes.
  852.    */
  853.   'FAILED_TO_GENERATE_LICENSE_REQUEST': 6006,
  855.   /**
  856.    * The license request failed.  This could be a timeout, a network failure, or
  857.    * a rejection by the server.
  858.    * <br> error.data[0] is a shaka.util.Error from the networking engine.
  859.    */
  860.   'LICENSE_REQUEST_FAILED': 6007,
  862.   /**
  863.    * The license response was rejected by the CDM.  The server's response may be
  864.    * invalid or malformed for this CDM.
  865.    * <br> error.data[0] is an error message string from the browser.
  866.    * <br> See top of file for links to browser error codes.
  867.    */
  868.   'LICENSE_RESPONSE_REJECTED': 6008,
  870.   // RETIRED: 'NO_LICENSE_SERVER_SPECIFIED': 6009,
  872.   /**
  873.    * The manifest does not specify any DRM info, but the content is encrypted.
  874.    * Either the manifest or the manifest parser are broken.
  875.    */
  876.   'ENCRYPTED_CONTENT_WITHOUT_DRM_INFO': 6010,
  878.   // RETIRED: 'WRONG_KEYS': 6011,
  880.   /**
  881.    * No license server was given for the key system signaled by the manifest.
  882.    * A license server URI is required for every key system.
  883.    * <br> error.data[0] is the key system identifier.
  884.    */
  885.   'NO_LICENSE_SERVER_GIVEN': 6012,
  887.   /**
  888.    * A required offline session was removed. The content might not be playable
  889.    * depending of the playback context.
  890.    */
  891.   'OFFLINE_SESSION_REMOVED': 6013,
  893.   /**
  894.    * The license has expired.  This is triggered when all keys in the key
  895.    * status map have a status of 'expired'.
  896.    */
  897.   'EXPIRED': 6014,
  899.   /**
  900.    * A server certificate wasn't given when it is required.  FairPlay requires
  901.    * setting an explicit server certificate in the configuration.
  902.    */
  903.   'SERVER_CERTIFICATE_REQUIRED': 6015,
  905.   /**
  906.    * An error was thrown while executing the init data transformation.
  907.    * <br> error.data[0] is the original error.
  908.    */
  909.   'INIT_DATA_TRANSFORM_ERROR': 6016,
  911.   /**
  912.    * The server certificate request failed.
  913.    * <br> error.data[0] is a shaka.util.Error from the networking engine.
  914.    */
  915.   'SERVER_CERTIFICATE_REQUEST_FAILED': 6017,
  917.   /**
  918.    * The HDCP version does not meet the requirements.
  919.    */
  920.   'MIN_HDCP_VERSION_NOT_MATCH': 6018,
  922.   /**
  923.    * Error when checking HDCP version.
  924.    * <br> error.data[0] is an error message string from the browser.
  925.    */
  926.   'ERROR_CHECKING_HDCP_VERSION': 6019,
  929.   /**
  930.    * The call to Player.load() was interrupted by a call to Player.unload()
  931.    * or another call to Player.load().
  932.    */
  933.   'LOAD_INTERRUPTED': 7000,
  935.   /**
  936.    * An internal error which indicates that an operation was aborted.  This
  937.    * should not be seen by applications.
  938.    */
  939.   'OPERATION_ABORTED': 7001,
  941.   /**
  942.    * The call to Player.load() failed because the Player does not have a video
  943.    * element.  The video element must either be provided to the constructor or
  944.    * to Player.attach() before Player.load() is called.
  945.    */
  946.   'NO_VIDEO_ELEMENT': 7002,
  948.   /**
  949.    * The operation failed because the object has been destroyed.
  950.    */
  951.   'OBJECT_DESTROYED': 7003,
  953.   /**
  954.    * The content has not been loaded in the Player.
  955.    */
  956.   'CONTENT_NOT_LOADED': 7004,
  958.   /**
  959.    * The call to preload failed, due to being called on src= content.
  960.    */
  961.   'SRC_EQUALS_PRELOAD_NOT_SUPPORTED': 7005,
  963.   /**
  964.    * The Cast API is unavailable.  This may be because of one of the following:
  965.    *  1. The browser may not have Cast support
  966.    *  2. The browser may be missing a necessary Cast extension
  967.    *  3. The Cast sender library may not be loaded in your app
  968.    */
  969.   'CAST_API_UNAVAILABLE': 8000,
  971.   /**
  972.    * No cast receivers are available at this time.
  973.    */
  974.   'NO_CAST_RECEIVERS': 8001,
  976.   /**
  977.    * The library is already casting.
  978.    */
  979.   'ALREADY_CASTING': 8002,
  981.   /**
  982.    * A Cast SDK error that we did not explicitly plan for has occurred.
  983.    * Check data[0] and refer to the Cast SDK documentation for details.
  984.    * <br> error.data[0] is an error object from the Cast SDK.
  985.    */
  986.   'UNEXPECTED_CAST_ERROR': 8003,
  988.   /**
  989.    * The cast operation was canceled by the user.
  990.    * <br> error.data[0] is an error object from the Cast SDK.
  991.    */
  992.   'CAST_CANCELED_BY_USER': 8004,
  994.   /**
  995.    * The cast connection timed out.
  996.    * <br> error.data[0] is an error object from the Cast SDK.
  997.    */
  998.   'CAST_CONNECTION_TIMED_OUT': 8005,
  1000.   /**
  1001.    * The requested receiver app ID does not exist or is unavailable.
  1002.    * Check the requested app ID for typos.
  1003.    * <br> error.data[0] is an error object from the Cast SDK.
  1004.    */
  1005.   'CAST_RECEIVER_APP_UNAVAILABLE': 8006,
  1008.   // RETIRED: CAST_RECEIVER_APP_ID_MISSING': 8007,
  1011.   /**
  1012.    * Offline storage is not supported on this browser; it is required for
  1013.    * offline support.
  1014.    */
  1015.   'STORAGE_NOT_SUPPORTED': 9000,
  1017.   /**
  1018.    * An unknown error occurred in the IndexedDB.
  1019.    * <br> On Firefox, one common source for UnknownError calls is reverting
  1020.    * Firefox to an old version. This makes the IndexedDB storage inaccessible
  1021.    * for older versions. The only way to fix this is to delete the storage
  1022.    * data in your profile. See https://mzl.la/2yCGWCm
  1023.    * <br> error.data[0] is the error object.
  1024.    */
  1025.   'INDEXED_DB_ERROR': 9001,
  1027.   /**
  1028.    * The storage operation was aborted.  Deprecated in favor of more general
  1029.    * OPERATION_ABORTED.
  1030.    */
  1031.   'DEPRECATED_OPERATION_ABORTED': 9002,
  1033.   /**
  1034.    * The specified item was not found in the IndexedDB.
  1035.    * <br> error.data[0] is the offline URI.
  1036.    */
  1037.   'REQUESTED_ITEM_NOT_FOUND': 9003,
  1039.   /**
  1040.    * A network request was made with a malformed offline URI.
  1041.    * <br> error.data[0] is the URI.
  1042.    */
  1043.   'MALFORMED_OFFLINE_URI': 9004,
  1045.   /**
  1046.    * The specified content is live or in-progress.
  1047.    * Live and in-progress streams cannot be stored offline.
  1048.    * <br> error.data[0] is the URI.
  1049.    */
  1050.   'CANNOT_STORE_LIVE_OFFLINE': 9005,
  1052.   // RETIRED: 'STORE_ALREADY_IN_PROGRESS': 9006,
  1054.   /**
  1055.    * There was no init data available for offline storage.  This happens when
  1056.    * there is no init data in the manifest nor could we find any in the
  1057.    * segments.  We currently only support searching MP4 init segments for init
  1058.    * data.
  1059.    */
  1060.   'NO_INIT_DATA_FOR_OFFLINE': 9007,
  1062.   /**
  1063.    * shaka.offline.Storage was constructed with a Player proxy instead of a
  1064.    * local player instance.  To fix this, use Player directly with Storage
  1065.    * instead of the results of CastProxy.prototype.getPlayer().
  1066.    */
  1067.   'LOCAL_PLAYER_INSTANCE_REQUIRED': 9008,
  1069.   // RETIRED/MOVED TO 4000's: 'CONTENT_UNSUPPORTED_BY_BROWSER': 9009,
  1071.   // RETIRED: 'UNSUPPORTED_UPGRADE_REQUEST': 9010,
  1073.   /**
  1074.    * The storage cell does not allow new operations that require new keys.
  1075.    */
  1076.   'NEW_KEY_OPERATION_NOT_SUPPORTED': 9011,
  1078.   /**
  1079.    * A key was not found in a storage cell.
  1080.    */
  1081.   'KEY_NOT_FOUND': 9012,
  1083.   /**
  1084.    * A storage cell was not found.
  1085.    */
  1086.   'MISSING_STORAGE_CELL': 9013,
  1088.   /**
  1089.    * The storage limit defined in <code>downloadSizeCallback</code> has been
  1090.    * reached.
  1091.    */
  1092.   'STORAGE_LIMIT_REACHED': 9014,
  1094.   /**
  1095.    * <code>downloadSizeCallback</code> has produced an unexpected error.
  1096.    */
  1097.   'DOWNLOAD_SIZE_CALLBACK_ERROR': 9015,
  1099.   /**
  1100.    * The storage cell does not allow new operations that significantly change
  1101.    * existing data.
  1102.    */
  1103.   'MODIFY_OPERATION_NOT_SUPPORTED': 9016,
  1105.   /**
  1106.    * When attempting to open an indexedDB instance, nothing happened for long
  1107.    * enough for us to time out.  This keeps the storage mechanism from hanging
  1108.    * indefinitely, if neither the success nor error callbacks are called.
  1109.    */
  1110.   'INDEXED_DB_INIT_TIMED_OUT': 9017,
  1112.   /**
  1113.    * CS IMA SDK, required for ad insertion, has not been included on the page.
  1114.    */
  1115.   'CS_IMA_SDK_MISSING': 10000,
  1117.   /**
  1118.    * Client Side Ad Manager needs to be initialized to enable Client Side
  1119.    * Ad Insertion. Call adManager.initClientSide() to do it.
  1120.    */
  1121.   'CS_AD_MANAGER_NOT_INITIALIZED': 10001,
  1123.   /**
  1124.    * SS IMA SDK, required for ad insertion, has not been included on the page.
  1125.    */
  1126.   'SS_IMA_SDK_MISSING': 10002,
  1128.   /**
  1129.    * Server Side Ad Manager needs to be initialized to enable Server Side
  1130.    * Ad Insertion. Call adManager.initServerSide() to do it.
  1131.    */
  1132.   'SS_AD_MANAGER_NOT_INITIALIZED': 10003,
  1134.   /**
  1135.    * A new DAI steam was requested before the previous request had been
  1136.    * resolved. Only one stream request at a time is supported. Please wait
  1137.    * for the previous request to complete before initiating a new one.
  1138.    */
  1139.   'CURRENT_DAI_REQUEST_NOT_FINISHED': 10004,
  1141.   /**
  1142.    * MediaTailor Ad Manager needs to be initialized to enable MediaTailor
  1143.    * Ad Insertion. Call adManager.initMediaTailor() to do it.
  1144.    */
  1145.   'MT_AD_MANAGER_NOT_INITIALIZED': 10005,
  1146. };