mirror of
https://github.com/shaka-project/shaka-player.git
synced 2026-06-26 17:46:26 +03:00
Joey Parrish
3a91c466cf
Generated externs should include member assignments from constructors.
Without them, the generated externs may not appear to implement the
full interface. The alternative is to re-declare these members on the
prototype, but that is more difficult to maintain. Instead, the
extern generator can convert them for us.
Example code:
/** @interface @exportInterface */
FooLike = function() {};
/** @exportInterface @type {number} */
FooLike.prototype.bar;
/** @constructor @export @implements {FooLike} */
Foo = function() {
/** @override @exportInterface */
this.bar = 10;
};
Example externs:
/** @interface */
FooLike = function() {};
/** @type {number} */
FooLike.prototype.bar;
/**
* @constructor @implements {FooLike}
*/
Foo = function() {}
/**
* @override
*/
Foo.prototype.bar;
Change-Id: I435ba1800d5eefbf68c27851d6454c1a572cc6f6
209 lines
3.9 KiB
JavaScript
209 lines
3.9 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2016 Google Inc.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
goog.provide('shaka.text.Cue');
|
|
|
|
|
|
|
|
/**
|
|
* Creates a Cue object.
|
|
*
|
|
* @param {number} startTime
|
|
* @param {number} endTime
|
|
* @param {!string} payload
|
|
*
|
|
* @implements {shakaExtern.Cue}
|
|
* @constructor
|
|
* @struct
|
|
* @export
|
|
*/
|
|
shaka.text.Cue = function(startTime, endTime, payload) {
|
|
var Cue = shaka.text.Cue;
|
|
|
|
/** @override @exportInterface */
|
|
this.startTime = startTime;
|
|
|
|
/** @override @exportInterface */
|
|
this.endTime = endTime;
|
|
|
|
/** @override @exportInterface */
|
|
this.payload = payload;
|
|
|
|
/** @override @exportInterface */
|
|
this.region = {x: 0, y: 0, width: 100, height: 100};
|
|
|
|
/** @override @exportInterface */
|
|
this.position = null;
|
|
|
|
/** @override @exportInterface */
|
|
this.positionAlign = Cue.positionAlign.AUTO;
|
|
|
|
/** @override @exportInterface */
|
|
this.size = 100;
|
|
|
|
/** @override @exportInterface */
|
|
this.textAlign = Cue.textAlign.CENTER;
|
|
|
|
/** @override @exportInterface */
|
|
this.writingDirection = Cue.writingDirection.HORIZONTAL_LEFT_TO_RIGHT;
|
|
|
|
/** @override @exportInterface */
|
|
this.lineInterpretation = Cue.lineInterpretation.LINE_NUMBER;
|
|
|
|
/** @override @exportInterface */
|
|
this.line = null;
|
|
|
|
/** @override @exportInterface */
|
|
this.lineHeight = '';
|
|
|
|
/** @override @exportInterface */
|
|
this.lineAlign = Cue.lineAlign.CENTER;
|
|
|
|
/** @override @exportInterface */
|
|
this.displayAlign = Cue.displayAlign.BEFORE;
|
|
|
|
/** @override @exportInterface */
|
|
this.color = '';
|
|
|
|
/** @override @exportInterface */
|
|
this.backgroundColor = '';
|
|
|
|
/** @override @exportInterface */
|
|
this.fontSize = '';
|
|
|
|
/** @override @exportInterface */
|
|
this.fontWeight = Cue.fontWeight.NORMAL;
|
|
|
|
/** @override @exportInterface */
|
|
this.fontStyle = Cue.fontStyle.NORMAL;
|
|
|
|
/** @override @exportInterface */
|
|
this.fontFamily = '';
|
|
|
|
/** @override @exportInterface */
|
|
this.textDecoration = [];
|
|
|
|
/** @override @exportInterface */
|
|
this.wrapLine = true;
|
|
|
|
/** @override @exportInterface */
|
|
this.id = '';
|
|
};
|
|
|
|
|
|
/**
|
|
* @enum {string}
|
|
* @export
|
|
*/
|
|
shaka.text.Cue.positionAlign = {
|
|
'LEFT': 'line-left',
|
|
'RIGHT': 'line-right',
|
|
'CENTER': 'center',
|
|
'AUTO': 'auto'
|
|
};
|
|
|
|
|
|
/**
|
|
* @enum {string}
|
|
* @export
|
|
*/
|
|
shaka.text.Cue.textAlign = {
|
|
'LEFT': 'left',
|
|
'RIGHT': 'right',
|
|
'CENTER': 'center',
|
|
'START': 'start',
|
|
'END': 'end'
|
|
};
|
|
|
|
|
|
/**
|
|
* @enum {string}
|
|
* @export
|
|
*/
|
|
shaka.text.Cue.displayAlign = {
|
|
'BEFORE': 'before',
|
|
'CENTER': 'center',
|
|
'AFTER': 'after'
|
|
};
|
|
|
|
|
|
/**
|
|
* @enum {number}
|
|
* @export
|
|
*/
|
|
shaka.text.Cue.writingDirection = {
|
|
'HORIZONTAL_LEFT_TO_RIGHT': 0,
|
|
'HORIZONTAL_RIGHT_TO_LEFT': 1,
|
|
'VERTICAL_LEFT_TO_RIGHT': 2,
|
|
'VERTICAL_RIGHT_TO_LEFT': 3
|
|
};
|
|
|
|
|
|
/**
|
|
* @enum {number}
|
|
* @export
|
|
*/
|
|
shaka.text.Cue.lineInterpretation = {
|
|
'LINE_NUMBER': 0,
|
|
'PERCENTAGE': 1
|
|
};
|
|
|
|
|
|
/**
|
|
* @enum {string}
|
|
* @export
|
|
*/
|
|
shaka.text.Cue.lineAlign = {
|
|
'CENTER': 'center',
|
|
'START': 'start',
|
|
'END': 'end'
|
|
};
|
|
|
|
|
|
/**
|
|
* In CSS font weight can be a number, where 400 is normal
|
|
* and 700 is bold. Use these values for the enum for consistency.
|
|
* @enum {number}
|
|
* @export
|
|
*/
|
|
shaka.text.Cue.fontWeight = {
|
|
'NORMAL': 400,
|
|
'BOLD': 700
|
|
};
|
|
|
|
|
|
/**
|
|
* @enum {string}
|
|
* @export
|
|
*/
|
|
shaka.text.Cue.fontStyle = {
|
|
'NORMAL': 'normal',
|
|
'ITALIC': 'italic',
|
|
'OBLIQUE': 'oblique'
|
|
};
|
|
|
|
|
|
/**
|
|
* @enum {string}
|
|
* @export
|
|
*/
|
|
shaka.text.Cue.textDecoration = {
|
|
'UNDERLINE': 'underline',
|
|
'LINE_THROUGH': 'lineThrough',
|
|
'OVERLINE': 'overline'
|
|
};
|