Source: externs/shaka/drm_info.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.  *   initData: !Uint8Array,
  16.  *   initDataType: string,
  17.  *   keyId: ?string
  18.  * }}
  19.  *
  20.  * @description
  21.  * Explicit initialization data, which override any initialization data in the
  22.  * content. The initDataType values and the formats that they correspond to
  23.  * are specified {@link https://bit.ly/EmeInitTypes here}.
  24.  *
  25.  * @property {!Uint8Array} initData
  26.  *   Initialization data in the format indicated by initDataType.
  27.  * @property {string} initDataType
  28.  *   A string to indicate what format initData is in.
  29.  * @property {?string} keyId
  30.  *   The key Id that corresponds to this initData.
  31.  *
  32.  * @exportDoc
  33.  */
  34. shaka.extern.InitDataOverride;
  37. /**
  38.  * @typedef {{
  39.  *   keySystem: string,
  40.  *   encryptionScheme: string,
  41.  *   keySystemUris: (Set.<string>|undefined),
  42.  *   licenseServerUri: string,
  43.  *   distinctiveIdentifierRequired: boolean,
  44.  *   persistentStateRequired: boolean,
  45.  *   audioRobustness: string,
  46.  *   videoRobustness: string,
  47.  *   serverCertificate: Uint8Array,
  48.  *   serverCertificateUri: string,
  49.  *   sessionType: string,
  50.  *   initData: Array.<!shaka.extern.InitDataOverride>,
  51.  *   keyIds: Set.<string>
  52.  * }}
  53.  *
  54.  * @description
  55.  * DRM configuration for a single key system.
  56.  *
  57.  * @property {string} keySystem
  58.  *   <i>Required.</i> <br>
  59.  *   The key system, e.g., "com.widevine.alpha".
  60.  * @property {string} encryptionScheme
  61.  *   <i>Required.</i> <br>
  62.  *   The encryption scheme, e.g., "cenc", "cbcs", "cbcs-1-9".
  63.  * @property {(Set.<string>|undefined)} keySystemUris
  64.  *   <i>Optional.</i> <br>
  65.  *   The key system uri, e.g., "skd://" for fairplay.
  66.  * @property {string} licenseServerUri
  67.  *   <i>Filled in by DRM config if missing.</i> <br>
  68.  *   The license server URI.
  69.  * @property {boolean} distinctiveIdentifierRequired
  70.  *   <i>Defaults to false.  Can be filled in by advanced DRM config.</i> <br>
  71.  *   True if the application requires the key system to support distinctive
  72.  *   identifiers.
  73.  * @property {boolean} persistentStateRequired
  74.  *   <i>Defaults to false.  Can be filled in by advanced DRM config.</i> <br>
  75.  *   True if the application requires the key system to support persistent
  76.  *   state, e.g., for persistent license storage.
  77.  * @property {string} sessionType
  78.  *   <i>Defaults to 'temporary' if Shaka wasn't initiated for storage.
  79.  *   Can be filled in by advanced DRM config sessionType parameter.</i> <br>
  80.  * @property {string} audioRobustness
  81.  *   <i>Defaults to '', e.g., no specific robustness required.  Can be filled in
  82.  *   by advanced DRM config.</i> <br>
  83.  *   A key-system-specific string that specifies a required security level.
  84.  * @property {string} videoRobustness
  85.  *   <i>Defaults to '', e.g., no specific robustness required.  Can be filled in
  86.  *   by advanced DRM config.</i> <br>
  87.  *   A key-system-specific string that specifies a required security level.
  88.  * @property {Uint8Array} serverCertificate
  89.  *   <i>Defaults to null, e.g., certificate will be requested from the license
  90.  *   server if required.  Can be filled in by advanced DRM config.</i> <br>
  91.  *   A key-system-specific server certificate used to encrypt license requests.
  92.  *   Its use is optional and is meant as an optimization to avoid a round-trip
  93.  *   to request a certificate.
  94.  * @property {string} serverCertificateUri
  95.  *   <i>Defaults to '', e.g., server certificate will be requested from the
  96.  *   given URI if serverCertificate is not provided. Can be filled in by
  97.  *   advanced DRM config.</i>
  98.  * @property {Array.<!shaka.extern.InitDataOverride>} initData
  99.  *   <i>Defaults to [], e.g., no override.</i> <br>
  100.  *   A list of initialization data which override any initialization data found
  101.  *   in the content.  See also shaka.extern.InitDataOverride.
  102.  * @property {Set.<string>} keyIds
  103.  *   <i>Defaults to the empty Set</i> <br>
  104.  *   If not empty, contains the default key IDs for this key system, as
  105.  *   lowercase hex strings.
  106.  * @exportDoc
  107.  */
  108. shaka.extern.DrmInfo;