Source: lib/text/cue_region.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  7. goog.provide('shaka.text.CueRegion');
  10. /**
  11.  * @export
  12.  */
  13. shaka.text.CueRegion = class {
  14.   /** */
  15.   constructor() {
  16.     const CueRegion = shaka.text.CueRegion;
  18.     /**
  19.      * Region identifier.
  20.      * @type {string}
  21.      * @export
  22.      */
  23.     this.id = '';
  25.     /**
  26.      * The X offset to start the rendering area in viewportAnchorUnits of the
  27.      * video width.
  28.      * @type {number}
  29.      * @export
  30.      */
  31.     this.viewportAnchorX = 0;
  33.     /**
  34.      * The X offset to start the rendering area in viewportAnchorUnits of the
  35.      * video height.
  36.      * @type {number}
  37.      * @export
  38.      */
  39.     this.viewportAnchorY = 0;
  41.     /**
  42.      * The X offset to start the rendering area in percentage (0-100) of this
  43.      * region width.
  44.      * @type {number}
  45.      * @export
  46.      */
  47.     this.regionAnchorX = 0;
  49.     /**
  50.      * The Y offset to start the rendering area in percentage (0-100) of the
  51.      * region height.
  52.      * @type {number}
  53.      * @export
  54.      */
  55.     this.regionAnchorY = 0;
  57.     /**
  58.      * The width of the rendering area in widthUnits.
  59.      * @type {number}
  60.      * @export
  61.      */
  62.     this.width = 100;
  64.     /**
  65.      * The width of the rendering area in heightUnits.
  66.      * @type {number}
  67.      * @export
  68.      */
  69.     this.height = 100;
  71.     /**
  72.      * The units (percentage, pixels or lines) the region height is in.
  73.      * @type {shaka.text.CueRegion.units}
  74.      * @export
  75.      */
  76.     this.heightUnits = CueRegion.units.PERCENTAGE;
  78.     /**
  79.      * The units (percentage or pixels) the region width is in.
  80.      * @type {shaka.text.CueRegion.units}
  81.      * @export
  82.      */
  83.     this.widthUnits = CueRegion.units.PERCENTAGE;
  85.     /**
  86.      * The units (percentage or pixels) the region viewportAnchors are in.
  87.      * @type {shaka.text.CueRegion.units}
  88.      * @export
  89.      */
  90.     this.viewportAnchorUnits = CueRegion.units.PERCENTAGE;
  92.     /**
  93.      * If scroll=UP, it means that cues in the region will be added to the
  94.      * bottom of the region and will push any already displayed cues in the
  95.      * region up.  Otherwise (scroll=NONE) cues will stay fixed at the location
  96.      * they were first painted in.
  97.      * @type {shaka.text.CueRegion.scrollMode}
  98.      * @export
  99.      */
  100.     this.scroll = CueRegion.scrollMode.NONE;
  101.   }
  102. };
  105. /**
  106.  * @enum {number}
  107.  * @export
  108.  */
  109. shaka.text.CueRegion.units = {
  110.   'PX': 0,
  111.   'PERCENTAGE': 1,
  112.   'LINES': 2,
  113. };
  116. /**
  117.  * @enum {string}
  118.  * @export
  119.  */
  120. shaka.text.CueRegion.scrollMode = {
  121.   'NONE': '',
  122.   'UP': 'up',
  123. };