fix(FEC-10924): add type for textTrackDisplaySetting (#537)

add type for textTrackDisplaySetting
kaltura · Jan 26, 2021 · 8d385c8 · 8d385c8
1 parent b26065f
commit 8d385c8
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 7 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -488,7 +488,7 @@ var config = {
 >  useNativeTextTrack: boolean,
 >  enableCEA708Captions: boolean,
 >  forceCenter: boolean,
->  textTrackDisplaySetting: Object,
+>  textTrackDisplaySetting: PKTextTrackDisplaySettingObject,
 >  textStyle: TextStyle,
 >  captionsTextTrack1Label: string,
 >  captionsTextTrack1LanguageCode: string,
@@ -547,7 +547,7 @@ var config = {
 >
 > > ### config.text.textTrackDisplaySetting
 > >
-> > ##### Type: `Object`
+> > ##### Type: `PKTextTrackDisplaySettingObject`
 > >
 > > ##### Default: `null`
 > >

diff --git a/flow-typed/types/text-config.js b/flow-typed/types/text-config.js
@@ -4,7 +4,7 @@ import {TextStyle} from '../../src/track/text-style';
 declare type PKTextConfigObject = {
   enableCEA708Captions: boolean,
   useNativeTextTrack: boolean,
-  textTrackDisplaySetting: Object,
+  textTrackDisplaySetting: PKTextTrackDisplaySettingObject,
   textStyle: PKTextStyleObject,
   forceCenter: boolean,
   captionsTextTrack1Label: string,

diff --git a/flow-typed/types/text-track-display-setting.js b/flow-typed/types/text-track-display-setting.js
@@ -0,0 +1,11 @@
+// @flow
+declare type PKTextTrackDisplaySettingObject = {
+  line: string | number,
+  lineAlign: string,
+  align: string,
+  position: number,
+  positionAlign: string,
+  snapToLines: boolean,
+  vertical: string,
+  size: number
+};
diff --git a/src/player.js b/src/player.js
@@ -276,10 +276,10 @@ export default class Player extends FakeEventTarget {
   _activeTextCues: Array<any> = [];
   /**
    * The player text disaply settings
-   * @type {Object}
+   * @type {PKTextTrackDisplaySettingObject}
    * @private
    */
-  _textDisplaySettings: Object = {};
+  _textDisplaySettings: PKTextTrackDisplaySettingObject = {};
   /**
    * The player text style settings
    * @type {TextStyle}
@@ -1305,11 +1305,11 @@ export default class Player extends FakeEventTarget {
 
   /**
    * update the text display settings
-   * @param {Object} settings - text cue display settings
+   * @param {PKTextTrackDisplaySettingObject} settings - text cue display settings
    * @public
    * @returns {void}
    */
-  setTextDisplaySettings(settings: Object): void {
+  setTextDisplaySettings(settings: PKTextTrackDisplaySettingObject): void {
     this._textDisplaySettings = Utils.Object.mergeDeep(this._textDisplaySettings, settings);
     this._updateCueDisplaySettings();
     for (let i = 0; i < this._activeTextCues.length; i++) {