Source: lib/media/adaptation_set_criteria.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  7. goog.provide('shaka.media.AdaptationSetCriteria');
  9. goog.require('shaka.media.AdaptationSet');
  10. goog.require('shaka.config.CodecSwitchingStrategy');
  13. /**
  14.  * An adaptation set criteria is a unit of logic that can take a set of
  15.  * variants and return a subset of variants that should (and can) be
  16.  * adapted between.
  17.  *
  18.  * @interface
  19.  * @export
  20.  */
  21. shaka.media.AdaptationSetCriteria = class {
  22.   /**
  23.    * Take a set of variants, and return a subset of variants that can be
  24.    * adapted between.
  25.    *
  26.    * @param {!Array<shaka.extern.Variant>} variants
  27.    * @return {!shaka.media.AdaptationSet}
  28.    * @exportInterface
  29.    */
  30.   create(variants) {}
  32.   /**
  33.    * Sets the AdaptationSetCriteria configuration.
  34.    *
  35.    * @param {shaka.media.AdaptationSetCriteria.Configuration} config
  36.    * @exportInterface
  37.    */
  38.   configure(config) {}
  39. };
  41. /**
  42.  * A factory for creating the AdaptationSetCriteria.
  43.  *
  44.  * @typedef {function():!shaka.media.AdaptationSetCriteria}
  45.  * @export
  46.  */
  47. shaka.media.AdaptationSetCriteria.Factory;
  49. /**
  50.  * @typedef {{
  51.  *   language: string,
  52.  *   role: string,
  53.  *   channelCount: number,
  54.  *   hdrLevel: string,
  55.  *   spatialAudio: boolean,
  56.  *   videoLayout: string,
  57.  *   audioLabel: string,
  58.  *   videoLabel: string,
  59.  *   codecSwitchingStrategy: shaka.config.CodecSwitchingStrategy,
  60.  *   audioCodec: string
  61.  * }}
  62.  *
  63.  * @property {string} language
  64.  *   The language used to filter variants.
  65.  * @property {string} role
  66.  *   The adaptation role used to filter variants.
  67.  * @property {string} channelCount
  68.  *   The audio channel count used to filter variants.
  69.  * @property {string} hdrLevel
  70.  *   The HDR level used to filter variants.
  71.  * @property {boolean} spatialAudio
  72.  *   Whether should prefer audio tracks with spatial audio.
  73.  * @property {string} videoLayout
  74.  *   The video layout used to filter variants.
  75.  * @property {string} audioLabel
  76.  *   The audio label used to filter variants.
  77.  * @property {string} videoLabel
  78.  *   The video label used to filter variants.
  79.  * @property {shaka.config.CodecSwitchingStrategy} codecSwitchingStrategy
  80.  *   The codec switching strategy used to filter variants.
  81.  * @property {string} audioCodec
  82.  *   The audio codec used to filter variants.
  83.  * @export
  84.  */
  85. shaka.media.AdaptationSetCriteria.Configuration;