Merge pull request #244 from THEOplayer/feature/localize-ads-ui

Feature/localize ads UI
THEOplayer · Dec 20, 2023 · 3e3284f · 3e3284f
2 parents d4815be + 52f8119
commit 3e3284f
Show file tree

Hide file tree

Showing 8 changed files with 78 additions and 3 deletions.
diff --git a/android/src/main/java/com/theoplayer/PlayerConfigAdapter.kt b/android/src/main/java/com/theoplayer/PlayerConfigAdapter.kt
@@ -11,10 +11,12 @@ import com.theoplayer.android.api.cast.CastStrategy
 import com.theoplayer.android.api.cast.CastConfiguration
 import com.theoplayer.android.api.pip.PipConfiguration
 import com.theoplayer.android.api.player.NetworkConfiguration
+import com.theoplayer.android.api.ui.UIConfiguration
 
 private const val PROP_LICENSE = "license"
 private const val PROP_LICENSE_URL = "licenseUrl"
 private const val PROP_PRELOAD = "preload"
+private const val PROP_LANGUAGE = "language"
 private const val PROP_UI_ENABLED = "uiEnabled"
 private const val PROP_CAST_STRATEGY = "strategy"
 private const val PROP_RETRY_CONFIG = "retryConfiguration"
@@ -24,6 +26,7 @@ private const val PROP_RETRY_MIN_BACKOFF = "minimumBackoff"
 private const val PROP_RETRY_MAX_BACKOFF = "maximumBackoff"
 private const val PROP_CAST_CONFIGURATION = "cast"
 private const val PROP_ADS_CONFIGURATION = "ads"
+private const val PROP_UI_CONFIGURATION = "ui"
 
 class PlayerConfigAdapter(private val configProps: ReadableMap?) {
 
@@ -45,6 +48,9 @@ class PlayerConfigAdapter(private val configProps: ReadableMap?) {
         if (hasKey(PROP_RETRY_CONFIG)) {
           networkConfiguration(networkConfig())
         }
+        if (hasKey(PROP_UI_CONFIGURATION)) {
+          ui(uiConfig())
+        }
         if (hasKey(PROP_HLS_DATE_RANGE)) {
           hlsDateRange(getBoolean(PROP_HLS_DATE_RANGE))
         }
@@ -96,6 +102,21 @@ class PlayerConfigAdapter(private val configProps: ReadableMap?) {
     }.build()
   }
 
+  /**
+   * Get UIConfiguration object; these properties apply:
+   * - language: The language used to localize the ui elements.
+   */
+  private fun uiConfig(): UIConfiguration {
+    return UIConfiguration.Builder().apply {
+      configProps?.getMap(PROP_UI_CONFIGURATION)?.run {
+        val languageString = getString(PROP_LANGUAGE)
+        if (languageString != null && !TextUtils.isEmpty(languageString)) {
+          language(languageString)
+        }
+      }
+    }.build()
+  }
+
   /**
    * Create a AdsRenderingSettings object.
    */

diff --git a/example/src/App.tsx b/example/src/App.tsx
@@ -45,6 +45,9 @@ const playerConfig: PlayerConfiguration = {
     },
     strategy: 'auto',
   },
+  ui: {
+    language: 'en',
+  },
   mediaControl: {
     mediaSessionEnabled: true,
   },

diff --git a/ios/THEOplayerRCTView.swift b/ios/THEOplayerRCTView.swift
@@ -19,6 +19,7 @@ public class THEOplayerRCTView: UIView {
     var presentationModeContext = THEOplayerRCTPresentationModeContext()
     var adsConfig = AdsConfig()
     var castConfig = CastConfig()
+    var uiConfig = UIConfig()
 
     var pipConfig = PipConfig() {
         didSet {
@@ -39,7 +40,6 @@ public class THEOplayerRCTView: UIView {
     private var licenseUrl: String?
     private var chromeless: Bool = true
     private var hlsDateRange: Bool = false
-    private var config: THEOplayerConfiguration?
 
     // MARK: - Initialisation / view setup
     init() {
@@ -110,6 +110,7 @@ public class THEOplayerRCTView: UIView {
                                                                         cssPaths: cssPaths,
                                                                         pip: self.playerPipConfiguration(),
                                                                         ads: self.playerAdsConfiguration(),
+                                                                        ui: self.playerUIConfiguration(),
                                                                         cast: self.playerCastConfiguration(),
                                                                         hlsDateRange: self.hlsDateRange,
                                                                         license: self.license,
@@ -127,7 +128,8 @@ public class THEOplayerRCTView: UIView {
                                                                         hlsDateRange: self.hlsDateRange,
                                                                         license: self.license,
                                                                         licenseUrl: self.licenseUrl,
-                                                                        pip: self.playerPipConfiguration()))
+                                                                        pip: self.playerPipConfiguration(),
+                                                                        ui: self.playerUIConfiguration()))
         self.initAdsIntegration()
         self.initBackgroundAudio()
         self.initPip()
@@ -176,6 +178,7 @@ public class THEOplayerRCTView: UIView {
         self.hlsDateRange = configDict["hlsDateRange"] as? Bool ?? false
         self.parseAdsConfig(configDict: configDict)
         self.parseCastConfig(configDict: configDict)
+        self.parseUIConfig(configDict: configDict)
         if DEBUG_VIEW { PrintUtils.printLog(logText: "[NATIVE] config prop updated.") }
 
         // Given the bridged config, create the initial THEOplayer instance

diff --git a/ios/ui/THEOplayerRCTView+UIConfig.swift b/ios/ui/THEOplayerRCTView+UIConfig.swift
@@ -0,0 +1,23 @@
+// THEOplayerRCTView+UIConfig.swift
+
+import Foundation
+import THEOplayerSDK
+
+struct UIConfig {
+    var language: String = "en"
+}
+
+extension THEOplayerRCTView {
+
+    func parseUIConfig(configDict: NSDictionary) {
+        if let uiConfig = configDict["ui"] as? NSDictionary {
+            if let uiLanguage = uiConfig["language"] as? String {
+                self.uiConfig.language = uiLanguage
+            }
+        }
+    }
+
+    func playerUIConfiguration() -> UIConfiguration? {
+        return UIConfiguration(language: self.uiConfig.language)
+    }
+}
diff --git a/react-native-theoplayer.podspec b/react-native-theoplayer.podspec
@@ -20,7 +20,7 @@ Pod::Spec.new do |s|
   s.platforms    = { :ios => "12.0", :tvos => "12.0" }
   s.source       = { :git => "https://www.theoplayer.com/.git", :tag => "#{s.version}" }
 
-  s.source_files = 'ios/*.{h,m,swift}', 'ios/ads/*.swift', 'ios/casting/*.swift', 'ios/contentprotection/*.swift', 'ios/pip/*.swift', 'ios/backgroundAudio/*.swift', 'ios/cache/*.swift', 'ios/eventBroadcasting/*.swift'
+  s.source_files = 'ios/*.{h,m,swift}', 'ios/ads/*.swift', 'ios/casting/*.swift', 'ios/contentprotection/*.swift', 'ios/pip/*.swift', 'ios/backgroundAudio/*.swift', 'ios/cache/*.swift', 'ios/eventBroadcasting/*.swift' , 'ios/ui/*.swift'
   s.resources = ['ios/*.css']
 
   # ReactNative Dependency

diff --git a/src/api/config/PlayerConfiguration.ts b/src/api/config/PlayerConfiguration.ts
@@ -2,6 +2,7 @@ import type { AdsConfiguration } from '../ads/AdsConfiguration';
 import type { CastConfiguration } from '../cast/CastConfiguration';
 import type { MediaControlConfiguration } from '../media/MediaControlConfiguration';
 import type { RetryConfiguration } from '../utils/RetryConfiguration';
+import type { UIConfiguration } from '../ui/UIConfiguration';
 
 export interface PlayerConfiguration {
   /**
@@ -36,6 +37,11 @@ export interface PlayerConfiguration {
    */
   cast?: CastConfiguration;
 
+  /**
+   * The ui configuration for the underlying native player. Applies to Ad UI.
+   */
+  ui?: UIConfiguration;
+
   /**
    * The configuration of media controls and media sessions across platforms.
    */

diff --git a/src/api/ui/UIConfiguration.ts b/src/api/ui/UIConfiguration.ts
@@ -0,0 +1,18 @@
+/**
+ * Describes the UI related configuration of the player.
+ *
+ * @public
+ */
+export interface UIConfiguration {
+  /**
+   * The language which is used for localization.
+   *
+   * @example
+   * ```
+   * ui: {
+   *   language: 'es',
+   * }
+   * ```
+   */
+  language?: string;
+}
diff --git a/src/api/ui/barrel.ts b/src/api/ui/barrel.ts
@@ -0,0 +1 @@
+export * from './UIConfiguration';