feat(FEC-10766): create text config section and option for styling (#387

) Issue: text track doesn't have a config for styling, there is only an API for styling. Solution: create a text container for the text track and add the options for styling the text track.
kaltura · Dec 29, 2020 · dac194d · dac194d
1 parent 75acb47
commit dac194d
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 4 deletions.
diff --git a/flow-typed/types/kaltura-player-options.js b/flow-typed/types/kaltura-player-options.js
@@ -5,6 +5,7 @@ declare type KPOptionsObject = {
   targetId: string,
   log?: KPLogConfigObject,
   disableUserCache?: boolean,
+  text?: PKTextConfigObject,
   playback?: PKPlaybackConfigObject,
   sources?: PKSourcesConfigObject,
   plugins: KPPluginsConfigObject,

diff --git a/src/common/utils/setup-helpers.js b/src/common/utils/setup-helpers.js
@@ -332,10 +332,10 @@ function checkNativeHlsSupport(options: KPOptionsObject): void {
  */
 function checkNativeTextTracksSupport(options: KPOptionsObject): void {
   if ((Env.isMacOS && Env.isSafari) || Env.isIOS) {
-    const useNativeTextTrack = Utils.Object.getPropertyPath(options, 'playback.useNativeTextTrack');
+    const useNativeTextTrack = Utils.Object.getPropertyPath(options, 'text.useNativeTextTrack');
     if (typeof useNativeTextTrack !== 'boolean') {
       Utils.Object.mergeDeep(options, {
-        playback: {
+        text: {
           useNativeTextTrack: true
         }
       });
@@ -561,7 +561,13 @@ function supportLegacyOptions(options: Object): PartialKPOptionsObject {
     ['metadata.poster', 'sources.poster'],
     ['metadata', 'sources.metadata'],
     ['logLevel', 'log.level'],
-    ['ui.components.fullscreen.inBrowserFullscreenForIOS', 'playback.inBrowserFullscreen']
+    ['ui.components.fullscreen.inBrowserFullscreenForIOS', 'playback.inBrowserFullscreen'],
+    ['playback.enableCEA708Captions', 'text.enableCEA708Captions'],
+    ['playback.useNativeTextTrack', 'text.useNativeTextTrack'],
+    ['playback.captionsTextTrack1Label', 'text.captionsTextTrack1Label'],
+    ['playback.captionsTextTrack1LanguageCode', 'text.captionsTextTrack1LanguageCode'],
+    ['playback.captionsTextTrack2Label', 'text.captionsTextTrack2Label'],
+    ['playback.captionsTextTrack2LanguageCode', 'text.captionsTextTrack2LanguageCode']
   ];
   removePlayerEntry();
   moves.forEach(move => moveProp(move[0], move[1]));

diff --git a/src/kaltura-player.js b/src/kaltura-player.js
@@ -347,6 +347,10 @@ class KalturaPlayer extends FakeEventTarget {
     this._localPlayer.setTextDisplaySettings(settings);
   }
 
+  get textDisplaySetting(): Object {
+    return this._localPlayer.textDisplaySetting;
+  }
+
   isFullscreen(): boolean {
     return this._localPlayer.isFullscreen();
   }

diff --git a/test/src/utils/test-utils.js b/test/src/utils/test-utils.js
@@ -11,8 +11,10 @@ function getConfigStructure() {
       adBreaks: []
     },
     sources: {},
+    text: {
+      enableCEA708Captions: true
+    },
     playback: {
-      enableCEA708Captions: true,
       preload: 'none',
       autoplay: false,
       muted: false,