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.   constructor() {
  15.     const CueRegion = shaka.text.CueRegion;
  17.     /**
  18.      * Region identifier.
  19.      * @type {string}
  20.      * @export
  21.      */
  22.     this.id = '';
  24.     /**
  25.      * The X offset to start the rendering area in viewportAnchorUnits of the
  26.      * video width.
  27.      * @type {number}
  28.      * @export
  29.      */
  30.     this.viewportAnchorX = 0;
  32.     /**
  33.      * The X offset to start the rendering area in viewportAnchorUnits of the
  34.      * video height.
  35.      * @type {number}
  36.      * @export
  37.      */
  38.     this.viewportAnchorY = 0;
  40.     /**
  41.      * The X offset to start the rendering area in percentage (0-100) of this
  42.      * region width.
  43.      * @type {number}
  44.      * @export
  45.      */
  46.     this.regionAnchorX = 0;
  48.     /**
  49.      * The Y offset to start the rendering area in percentage (0-100) of the
  50.      * region height.
  51.      * @type {number}
  52.      * @export
  53.      */
  54.     this.regionAnchorY = 0;
  56.     /**
  57.      * The width of the rendering area in widthUnits.
  58.      * @type {number}
  59.      * @export
  60.      */
  61.     this.width = 100;
  63.     /**
  64.      * The width of the rendering area in heightUnits.
  65.      * @type {number}
  66.      * @export
  67.      */
  68.     this.height = 100;
  70.     /**
  71.      * The units (percentage, pixels or lines) the region height is in.
  72.      * @type {shaka.text.CueRegion.units}
  73.      * @export
  74.      */
  75.     this.heightUnits = CueRegion.units.PERCENTAGE;
  77.     /**
  78.      * The units (percentage or pixels) the region width is in.
  79.      * @type {shaka.text.CueRegion.units}
  80.      * @export
  81.      */
  82.     this.widthUnits = CueRegion.units.PERCENTAGE;
  84.     /**
  85.      * The units (percentage or pixels) the region viewportAnchors are in.
  86.      * @type {shaka.text.CueRegion.units}
  87.      * @export
  88.      */
  89.     this.viewportAnchorUnits = CueRegion.units.PERCENTAGE;
  91.     /**
  92.      * If scroll=UP, it means that cues in the region will be added to the
  93.      * bottom of the region and will push any already displayed cues in the
  94.      * region up.  Otherwise (scroll=NONE) cues will stay fixed at the location
  95.      * they were first painted in.
  96.      * @type {shaka.text.CueRegion.scrollMode}
  97.      * @export
  98.      */
  99.     this.scroll = CueRegion.scrollMode.NONE;
  100.   }
  101. };
  104. /**
  105.  * @enum {number}
  106.  * @export
  107.  */
  108. shaka.text.CueRegion.units = {
  109.   'PX': 0,
  110.   'PERCENTAGE': 1,
  111.   'LINES': 2,
  112. };
  115. /**
  116.  * @enum {string}
  117.  * @export
  118.  */
  119. shaka.text.CueRegion.scrollMode = {
  120.   'NONE': '',
  121.   'UP': 'up',
  122. };