Skip to content

Commit

Permalink
feat: Use shaka.text.Cue everywhere instead of shaka.extern.Cue (#5529)
Browse files Browse the repository at this point in the history 
Closes #2818
  • Loading branch information
@avelad
avelad authored Aug 25, 2023
1 parent 47224ff commit 62156ba
Show file tree
Hide file tree
Showing 12 changed files with 228 additions and 531 deletions.
383 changes: 1 addition & 382 deletions externs/shaka/text.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,387 +10,6 @@
*/


/**
* @interface
* @exportDoc
*/
shaka.extern.CueRegion = class {
constructor() {
/**
* Region identifier.
* @type {string}
* @exportDoc
*/
this.id;

/**
* The X offset to start the rendering area in viewportAnchorUnits of the
* video width.
* @type {number}
* @exportDoc
*/
this.viewportAnchorX;

/**
* The X offset to start the rendering area in viewportAnchorUnits of the
* video height.
* @type {number}
* @exportDoc
*/
this.viewportAnchorY;

/**
* The X offset to start the rendering area in percentage (0-100) of this
* region width.
* @type {number}
* @exportDoc
*/
this.regionAnchorX;

/**
* The Y offset to start the rendering area in percentage (0-100) of the
* region height.
* @type {number}
* @exportDoc
*/
this.regionAnchorY;

/**
* The width of the rendering area in widthUnits.
* @type {number}
* @exportDoc
*/
this.width;

/**
* The width of the rendering area in heightUnits.
* @type {number}
* @exportDoc
*/
this.height;

/**
* The units (percentage, pixels or lines) the region height is in.
* @type {shaka.text.CueRegion.units}
* @exportDoc
*/
this.heightUnits;

/**
* The units (percentage or pixels) the region width is in.
* @type {shaka.text.CueRegion.units}
* @exportDoc
*/
this.widthUnits;

/**
* The units (percentage or pixels) the region viewportAnchors are in.
* @type {shaka.text.CueRegion.units}
* @exportDoc
*/
this.viewportAnchorUnits;

/**
* If scroll=UP, it means that cues in the region will be added to the
* bottom of the region and will push any already displayed cues in the
* region up. Otherwise (scroll=NONE) cues will stay fixed at the location
* they were first painted in.
* @type {shaka.text.CueRegion.scrollMode}
* @exportDoc
*/
this.scroll;
}
};


/**
* @interface
* @exportDoc
*/
shaka.extern.Cue = class {
constructor() {
/**
* The start time of the cue in seconds, relative to the start of the
* presentation.
* @type {number}
* @exportDoc
*/
this.startTime;

/**
* The end time of the cue in seconds, relative to the start of the
* presentation.
* @type {number}
* @exportDoc
*/
this.endTime;

/**
* The text payload of the cue. If nestedCues is non-empty, this should be
* empty. Top-level block containers should have no payload of their own.
* @type {string}
* @exportDoc
*/
this.payload;

/**
* The region to render the cue into. Only supported on top-level cues,
* because nested cues are inline elements.
* @type {shaka.extern.CueRegion}
* @exportDoc
*/
this.region;

/**
* The indent (in percent) of the cue box in the direction defined by the
* writing direction.
* @type {?number}
* @exportDoc
*/
this.position;

/**
* Position alignment of the cue.
* @type {shaka.text.Cue.positionAlign}
* @exportDoc
*/
this.positionAlign;

/**
* Size of the cue box (in percents), where 0 means "auto".
* @type {number}
* @exportDoc
*/
this.size;

/**
* Alignment of the text inside the cue box.
* @type {shaka.text.Cue.textAlign}
* @exportDoc
*/
this.textAlign;

/**
* Text direction of the cue.
* @type {shaka.text.Cue.direction}
* @exportDoc
*/
this.direction;

/**
* Text writing mode of the cue.
* @type {shaka.text.Cue.writingMode}
* @exportDoc
*/
this.writingMode;

/**
* The way to interpret line field. (Either as an integer line number or
* percentage from the display box).
* @type {shaka.text.Cue.lineInterpretation}
* @exportDoc
*/
this.lineInterpretation;

/**
* The offset from the display box in either number of lines or
* percentage depending on the value of lineInterpretation.
* @type {?number}
* @exportDoc
*/
this.line;

/**
* Separation between line areas inside the cue box in px or em
* (e.g. '100px'/'100em'). If not specified, this should be no less than
* the largest font size applied to the text in the cue.
* @type {string}.
* @exportDoc
*/
this.lineHeight;

/**
* Line alignment of the cue box.
* Start alignment means the cue box’s top side (for horizontal cues), left
* side (for vertical growing right), or right side (for vertical growing
* left) is aligned at the line.
* Center alignment means the cue box is centered at the line.
* End alignment The cue box’s bottom side (for horizontal cues), right side
* (for vertical growing right), or left side (for vertical growing left) is
* aligned at the line.
* @type {shaka.text.Cue.lineAlign}
* @exportDoc
*/
this.lineAlign;

/**
* Vertical alignments of the cues within their extents.
* 'BEFORE' means displaying the captions at the top of the text display
* container box, 'CENTER' means in the middle, 'AFTER' means at the bottom.
* @type {shaka.text.Cue.displayAlign}
* @exportDoc
*/
this.displayAlign;

/**
* Text color as a CSS color, e.g. "#FFFFFF" or "white".
* @type {string}
* @exportDoc
*/
this.color;

/**
* Text background color as a CSS color, e.g. "#FFFFFF" or "white".
* @type {string}
* @exportDoc
*/
this.backgroundColor;

/**
* The number of horizontal and vertical cells into which the Root Container
* Region area is divided.
*
* @type {{ columns: number, rows: number }}
* @exportDoc
*/
this.cellResolution;

/**
* The URL of the background image, e.g. "data:[mime type];base64,[data]".
* @type {string}
* @exportDoc
*/
this.backgroundImage;

/**
* The border around this cue as a CSS border.
* @type {string}
* @exportDoc
*/
this.border;

/**
* Text font size in px or em (e.g. '100px'/'100em').
* @type {string}
* @exportDoc
*/
this.fontSize;

/**
* Text font weight. Either normal or bold.
* @type {shaka.text.Cue.fontWeight}
* @exportDoc
*/
this.fontWeight;

/**
* Text font style. Normal, italic or oblique.
* @type {shaka.text.Cue.fontStyle}
* @exportDoc
*/
this.fontStyle;

/**
* Text font family.
* @type {string}
* @exportDoc
*/
this.fontFamily;

/**
* Text shadow color as a CSS text-shadow value.
* @type {string}
* @exportDoc
*/
this.textShadow = '';

/**
* Text stroke color as a CSS color, e.g. "#FFFFFF" or "white".
* @type {string}
* @exportDoc
*/
this.textStrokeColor;

/**
* Text stroke width as a CSS stroke-width value.
* @type {string}
* @exportDoc
*/
this.textStrokeWidth;

/**
* Text letter spacing as a CSS letter-spacing value.
* @type {string}
* @exportDoc
*/
this.letterSpacing;

/**
* Text line padding as a CSS line-padding value.
* @type {string}
* @exportDoc
*/
this.linePadding;

/**
* Opacity of the cue element, from 0-1.
* @type {number}
* @exportDoc
*/
this.opacity;

/**
* Text decoration. A combination of underline, overline
* and line through. Empty array means no decoration.
* @type {!Array.<!shaka.text.Cue.textDecoration>}
* @exportDoc
*/
this.textDecoration;

/**
* Whether or not line wrapping should be applied to the cue.
* @type {boolean}
* @exportDoc
*/
this.wrapLine;

/**
* Id of the cue.
* @type {string}
* @exportDoc
*/
this.id;

/**
* Nested cues, which should be laid out horizontally in one block.
* Top-level cues are blocks, and nested cues are inline elements.
* Cues can be nested arbitrarily deeply.
* @type {!Array.<!shaka.extern.Cue>}
* @exportDoc
*/
this.nestedCues;

/**
* If true, this represents a container element that is "above" the main
* cues. For example, the <body> and <div> tags that contain the <p> tags
* in a TTML file. This controls the flow of the final cues; any nested cues
* within an "isContainer" cue will be laid out as separate lines.
* @type {boolean}
* @exportDoc
*/
this.isContainer;

/**
* Whether or not the cue only acts as a line break between two nested cues.
* Should only appear in nested cues.
* @type {boolean}
* @exportDoc
*/
this.lineBreak;
}
};


/**
* An interface for plugins that parse text tracks.
*
Expand All @@ -417,7 +36,7 @@ shaka.extern.TextParser = class {
* @param {shaka.extern.TextParser.TimeContext} timeContext
* The time information that should be used to adjust the times values
* for each cue.
* @return {!Array.<!shaka.extern.Cue>}
* @return {!Array.<!shaka.text.Cue>}
*
* @exportDoc
*/
Expand Down
Loading

0 comments on commit 62156ba

Please sign in to comment.