react-native-theoplayer 8.5.0 → 8.7.0

package/CHANGELOG.md

@@ -5,6 +5,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.1.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [8.7.0] - 24-11-05
+
+### Fixed
+
+- Fixed an issue on iOS where the dynamic island (iphone 14 plus and higher) briefly disappeared when updating the nowPlayingInfo on for example backgrounding the app.
+- Fixed an issue on Android when using Expo, where the Expo plugin would not add THEOplayer's Maven repo to the project's repositories list.
+
+### Added
+
+- Added the `Omid` API for ads, which can be used to manage friendly video controls overlay obstructions.
+
+## [8.6.0] - 24-10-25
+
+### Added
+
+- Added `AdEvent.AD_CLICKED` and `AdEvent.AD_TAPPED` ad events for iOS and Android. The events are dispatched when a user taps or clicks on an ad that has a `clickThrough` link.
+
+### Changed
+
+- Upgrade example app to support React Native v0.75.
+
 ## [8.5.0] - 24-10-21
 
 ### Added
@@ -40,6 +61,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Fixed an issue on Android where on some Android SDK versions controlling playback with the notification buttons would not work.
 - Fixed an issue on Web and Android where a text track with attribute `DEFAULT` was not set as the player's `selectedTextTrack` property.
 
+### Added
+
+- Added `sdkVersions` to react-native-theoplayer, which contains the current RN SDK version and the version of the underlying native THEOplayer SDK.
+
 ## [8.3.0] - 24-09-30
 
 ### Added

package/android/build.gradle

@@ -108,9 +108,9 @@ repositories {
   maven { url "https://maven.theoplayer.com/releases" }
 }
 
-// The minimum supported THEOplayer version is 8.1.0
-def theoplayer_sdk_version = safeExtGet('THEOplayer_sdk', '[8.1.0, 9.0.0)')
-def theoplayer_mediasession_version = safeExtGet('THEOplayer_mediasession', '[8.1.0, 9.0.0)')
+// The minimum supported THEOplayer version is 8.3.0
+def theoplayer_sdk_version = safeExtGet('THEOplayer_sdk', '[8.3.0, 9.0.0)')
+def theoplayer_mediasession_version = safeExtGet('THEOplayer_mediasession', '[8.0.0, 9.0.0)')
 
 dependencies {
   //noinspection GradleDynamicVersion

package/android/src/main/java/com/theoplayer/ads/AdEventAdapter.kt

@@ -115,8 +115,8 @@ class AdEventAdapter(private val adsApi: AdsApiWrapper, eventEmitter: AdEventEmi
         GoogleImaAdEventType.AD_BREAK_STARTED, AdsEventTypes.AD_BREAK_BEGIN -> "adbreakbegin"
         GoogleImaAdEventType.AD_BREAK_ENDED, AdsEventTypes.AD_BREAK_END -> "adbreakend"
         GoogleImaAdEventType.AD_BREAK_FETCH_ERROR -> "aderror"
-        GoogleImaAdEventType.CLICKED -> "adclicked"
-        GoogleImaAdEventType.TAPPED -> "adtapped"
+        GoogleImaAdEventType.CLICKED, AdsEventTypes.AD_CLICKED -> "adclicked"
+        GoogleImaAdEventType.TAPPED, AdsEventTypes.AD_TAPPED -> "adtapped"
         GoogleImaAdEventType.ICON_TAPPED -> "adicontapped"
         GoogleImaAdEventType.ICON_FALLBACK_IMAGE_CLOSED -> "adiconfallbackimageclosed"
         AdsEventTypes.ADD_AD -> "addad"

package/android/src/main/java/com/theoplayer/ads/AdsModule.kt

@@ -3,14 +3,21 @@
 package com.theoplayer.ads
 
 import android.util.Log
+import android.view.View
 import com.facebook.react.bridge.*
 import com.theoplayer.source.SourceAdapter
 import com.theoplayer.util.ViewResolver
 import com.theoplayer.ReactTHEOplayerView
+import com.theoplayer.android.api.ads.OmidFriendlyObstruction
+import com.theoplayer.android.api.ads.OmidFriendlyObstructionPurpose
 import com.theoplayer.android.api.error.THEOplayerException
 
 private const val TAG = "THEORCTAdsModule"
 
+private const val PROP_OMID_VIEW = "view"
+private const val PROP_OMID_PURPOSE = "purpose"
+private const val PROP_OMID_REASON = "reason"
+
 class AdsModule(context: ReactApplicationContext) : ReactContextBaseJavaModule(context) {
   private val sourceHelper = SourceAdapter()
   private val viewResolver: ViewResolver = ViewResolver(context)
@@ -133,4 +140,49 @@ class AdsModule(context: ReactApplicationContext) : ReactContextBaseJavaModule(c
       }
     }
   }
+
+  @ReactMethod
+  fun addFriendlyObstruction(tag: Int, obstruction: ReadableMap) {
+    val obsTag =
+      if (obstruction.hasKey(PROP_OMID_VIEW)) obstruction.getInt(PROP_OMID_VIEW) else null
+    val purpose = if (obstruction.hasKey(PROP_OMID_PURPOSE)) {
+      when (obstruction.getString(PROP_OMID_PURPOSE)) {
+        "videoControls" -> OmidFriendlyObstructionPurpose.VIDEO_CONTROLS
+        "closeAd" -> OmidFriendlyObstructionPurpose.CLOSE_AD
+        "notVisible" -> OmidFriendlyObstructionPurpose.NOT_VISIBLE
+        else -> OmidFriendlyObstructionPurpose.OTHER
+      }
+    } else null
+    val reason =
+      if (obstruction.hasKey(PROP_OMID_REASON)) obstruction.getString(PROP_OMID_REASON) else null
+
+    if (obsTag !== null) {
+      viewResolver.resolveViewByTag(obsTag) { obsView: View? ->
+        addFriendlyObstruction(tag, obsView, purpose, reason)
+      }
+    }
+  }
+
+  private fun addFriendlyObstruction(
+    tag: Int,
+    obsView: View?,
+    purpose: OmidFriendlyObstructionPurpose?,
+    reason: String?
+  ) {
+    if (obsView == null || purpose == null) {
+      return
+    }
+    viewResolver.resolveViewByTag(tag) { view: ReactTHEOplayerView? ->
+      view?.player?.ads?.omid?.addFriendlyObstruction(
+        OmidFriendlyObstruction(obsView, purpose, reason)
+      )
+    }
+  }
+
+  @ReactMethod
+  fun removeAllFriendlyObstructions(tag: Int) {
+    viewResolver.resolveViewByTag(tag) { view: ReactTHEOplayerView? ->
+      view?.player?.ads?.omid?.removeAllFriendlyObstructions()
+    }
+  }
 }

package/android/src/main/java/com/theoplayer/player/PlayerModule.kt

@@ -10,6 +10,7 @@ import com.theoplayer.android.api.player.RenderingTarget
 import com.theoplayer.android.api.player.track.mediatrack.MediaTrack
 import com.theoplayer.android.api.player.track.mediatrack.quality.VideoQuality
 import com.theoplayer.android.api.player.track.texttrack.TextTrackMode
+import com.theoplayer.android.api.THEOplayerGlobal
 import com.theoplayer.audio.BackgroundAudioConfigAdapter
 import com.theoplayer.presentation.PipConfigAdapter
 import com.theoplayer.track.TextTrackStyleAdapter
@@ -25,6 +26,12 @@ class PlayerModule(context: ReactApplicationContext) : ReactContextBaseJavaModul
     return TAG
   }
 
+  // The native version string of the Android THEOplayer SDK.
+  @ReactMethod
+  fun version(promise: Promise) {
+    promise.resolve(THEOplayerGlobal.getVersion())
+  }
+
   @ReactMethod
   fun setABRConfig(tag: Int, config: ReadableMap?) {
     viewResolver.resolveViewByTag(tag) { view: ReactTHEOplayerView? ->

package/android/src/main/java/com/theoplayer/presentation/PresentationManager.kt

@@ -40,6 +40,8 @@ class PresentationManager(
 
   var currentPresentationMode: PresentationMode = PresentationMode.INLINE
     private set
+  var currentPresentationModeChangeContext: PresentationModeChangeContext? = null
+    private set
 
   var pipConfig: PipConfig = PipConfig()
 
@@ -54,12 +56,14 @@ class PresentationManager(
     }
     onPictureInPictureModeChanged = object : BroadcastReceiver() {
       override fun onReceive(context: Context?, intent: Intent?) {
-        // Dispatch event on every PiP mode change
+        val transitioningToPip = intent
+          ?.getBooleanExtra("isTransitioningToPip", false) ?: false
         val inPip = intent?.getBooleanExtra("isInPictureInPictureMode", false) ?: false
-        if (inPip) {
-          onEnterPip()
-        } else {
-          onExitPip()
+        // Dispatch event on every PiP mode change
+        when {
+          transitioningToPip -> onEnterPip(true)
+          inPip -> onEnterPip()
+          else -> onExitPip()
         }
       }
     }
@@ -104,9 +108,11 @@ class PresentationManager(
       PresentationMode.INLINE -> {
         setFullscreen(false)
       }
+
       PresentationMode.FULLSCREEN -> {
         setFullscreen(true)
       }
+
       PresentationMode.PICTURE_IN_PICTURE -> {
         setFullscreen(false)
         enterPip()
@@ -144,8 +150,13 @@ class PresentationManager(
     }
   }
 
-  private fun onEnterPip() {
-    updatePresentationMode(PresentationMode.PICTURE_IN_PICTURE)
+  private fun onEnterPip(transitioningToPip: Boolean = false) {
+    updatePresentationMode(
+      PresentationMode.PICTURE_IN_PICTURE,
+      if (transitioningToPip)
+        PresentationModeChangeContext(PresentationModeChangePipContext.TRANSITIONING_TO_PIP)
+      else null
+    )
   }
 
   private fun onExitPip() {
@@ -241,11 +252,14 @@ class PresentationManager(
     presentationMode: PresentationMode,
     context: PresentationModeChangeContext? = null
   ) {
-    if (presentationMode == currentPresentationMode) {
+    if (presentationMode == currentPresentationMode &&
+      context == currentPresentationModeChangeContext
+    ) {
       return
     }
     val prevPresentationMode = currentPresentationMode
     currentPresentationMode = presentationMode
+    currentPresentationModeChangeContext = context
     eventEmitter.emitPresentationModeChange(presentationMode, prevPresentationMode, context)
 
     // Resume playing when going to PiP and player was playing

package/android/src/main/java/com/theoplayer/presentation/PresentationModeChangeContext.kt

@@ -9,7 +9,10 @@ enum class PresentationModeChangePipContext {
   CLOSED,
 
   // The PiP window transitioned back into the app.
-  RESTORED
+  RESTORED,
+
+  // The app transitioning to PiP frame
+  TRANSITIONING_TO_PIP
 }
 
 data class PresentationModeChangeContext(

package/android/src/main/java/com/theoplayer/util/PayloadBuilder.kt

@@ -109,6 +109,7 @@ class PayloadBuilder {
     val contextPayload = Arguments.createMap()
     context.pip?.let { pipCtx ->
       contextPayload.putString(EVENT_PROP_PIP, when (pipCtx) {
+        PresentationModeChangePipContext.TRANSITIONING_TO_PIP -> "transitioning-to-pip"
         PresentationModeChangePipContext.RESTORED -> "restored"
         else -> "closed"
       })

package/android/src/main/java/com/theoplayer/util/ViewResolver.kt

@@ -1,17 +1,18 @@
 package com.theoplayer.util
 
 import android.util.Log
+import android.view.View
 import com.facebook.react.bridge.ReactApplicationContext
 import com.facebook.react.uimanager.UIManagerModule
-import com.theoplayer.ReactTHEOplayerView
 
 private const val TAG = "ViewResolver"
 private const val INVALID_TAG = -1
 
+@Suppress("UNCHECKED_CAST")
 class ViewResolver(private val reactContext: ReactApplicationContext) {
   private var uiManager: UIManagerModule? = null
 
-  fun resolveViewByTag(tag: Int, onResolved: (view: ReactTHEOplayerView?) -> Unit) {
+  fun <T: View> resolveViewByTag(tag: Int, onResolved: (view: T?) -> Unit) {
     if (tag == INVALID_TAG) {
       // Don't bother trying to resolve an invalid tag.
       onResolved(null)
@@ -21,10 +22,10 @@ class ViewResolver(private val reactContext: ReactApplicationContext) {
     }
     uiManager?.addUIBlock {
       try {
-        onResolved(it.resolveView(tag) as ReactTHEOplayerView)
+        onResolved(it.resolveView(tag) as? T?)
       } catch (e: Exception) {
-        // The ReactTHEOplayerView instance could not be resolved: log but do not forward exception.
-        Log.e(TAG, "Failed to resolve ReactTHEOplayerView tag $tag: $e")
+        // The View instance could not be resolved: log but do not forward exception.
+        Log.e(TAG, "Failed to resolve View tag $tag: $e")
         onResolved(null)
       }
     }

package/app.plugin.js

@@ -40,10 +40,11 @@ const withAndroidTHEOplayer = (config, props) => {
   const { extensions } = props | {};
   config = applyAndroidExtensions(config, extensions);
 
-  // Add the localMaven repo to the project's repositories
+  // Add THEOplayer and local Maven repos to the project's repositories
   return withProjectBuildGradle(config, (config) => {
     const localMaven = 'maven { url("$rootDir/../node_modules/react-native-theoplayer/android/local") }';
-    config.modResults.contents = config.modResults.contents.replace(/allprojects\s*\{\s*repositories\s*\{/, `$&\n\t\t${localMaven}`);
+    const THEOplayerMaven = 'maven { url("https://maven.theoplayer.com/releases") }';
+    config.modResults.contents = config.modResults.contents.replace(/allprojects\s*\{\s*repositories\s*\{/, `$&\n\t\t${localMaven}\n\t\t${THEOplayerMaven}`);
     return config;
   });
 };

package/ios/THEOplayerRCTBridge.m

@@ -60,6 +60,9 @@ RCT_EXTERN_METHOD(destroy:(nonnull NSNumber *)node);
 // ----------------------------------------------------------------------------
 @interface RCT_EXTERN_REMAP_MODULE(THEORCTPlayerModule, THEOplayerRCTPlayerAPI, NSObject)
 
+RCT_EXTERN_METHOD(version:(RCTPromiseResolveBlock)resolve
+                  rejecter:(RCTPromiseRejectBlock)reject)
+
 RCT_EXTERN_METHOD(setPaused:(nonnull NSNumber *)node
                   paused:(BOOL)paused)
 
@@ -157,6 +160,11 @@ RCT_EXTERN_METHOD(daiStreamTimeForContentTime:(nonnull NSNumber *)node
                   resolver:(RCTPromiseResolveBlock)resolve
                   rejecter:(RCTPromiseRejectBlock)reject)
 
+RCT_EXTERN_METHOD(addFriendlyObstruction:(nonnull NSNumber *)node
+                  obstruction:(NSDictionary)obstruction)
+
+RCT_EXTERN_METHOD(removeAllFriendlyObstructions:(nonnull NSNumber *)node)
+
 @end
 
 // ----------------------------------------------------------------------------

package/ios/THEOplayerRCTPlayerAPI.swift

@@ -35,6 +35,12 @@ class THEOplayerRCTPlayerAPI: NSObject, RCTBridgeModule {
     static func requiresMainQueueSetup() -> Bool {
         return false
     }
+  
+    @objc(version:rejecter:)
+    func version(resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) -> Void {
+        let versionString = THEOplayer.version
+        resolve(versionString)
+    }
 
     @objc(setPaused:paused:)
     func setPaused(_ node: NSNumber, paused: Bool) -> Void {

package/ios/THEOplayerRCTTypeUtils.swift

@@ -123,6 +123,22 @@ class THEOplayerRCTTypeUtils {
             return .moviePlayback
         }
     }
+  
+    class func omidFriendlyObstructionPurposeFromString(_ purposeString: String) -> OmidFriendlyObstructionPurpose {
+      switch purposeString {
+      case "videoControls":
+        return OmidFriendlyObstructionPurpose.mediaControls
+      case "closeAd":
+        return OmidFriendlyObstructionPurpose.closeAd
+      case "notVisible":
+        return OmidFriendlyObstructionPurpose.notVisible
+      case "other":
+        return OmidFriendlyObstructionPurpose.other
+      default:
+        return OmidFriendlyObstructionPurpose.other
+      }
+      
+    }
 
 #if os(iOS)
     class func cacheStatusToString(_ status: CacheStatus) -> String {

package/ios/ads/THEOplayerRCTAdsAPI+Omid.swift

@@ -0,0 +1,55 @@
+//  THEOplayerRCTAdsAPI+Omid.swift
+
+import Foundation
+import THEOplayerSDK
+import UIKit
+
+let PROP_OMID_VIEW: String = "view"
+let PROP_OMID_PURPOSE: String = "purpose"
+let PROP_OMID_REASON: String = "reason"
+
+extension THEOplayerRCTAdsAPI {
+  
+#if canImport(THEOplayerGoogleIMAIntegration)
+  @objc(addFriendlyObstruction:obstruction:)
+  func addFriendlyObstruction(_ node: NSNumber, obstruction: NSDictionary) {
+    DispatchQueue.main.async {
+      if let obstructionNode = obstruction[PROP_OMID_VIEW] as? NSNumber,
+         let purposeString = obstruction[PROP_OMID_PURPOSE] as? String,
+         let theView = self.bridge.uiManager.view(forReactTag: node) as? THEOplayerRCTView,
+         let obstructionView = self.bridge.uiManager.view(forReactTag: obstructionNode),
+         let ads = theView.ads() {
+        let obstruction = OmidFriendlyObstruction(view: obstructionView,
+                                                  purpose: THEOplayerRCTTypeUtils.omidFriendlyObstructionPurposeFromString(purposeString),
+                                                  detailedReason: obstruction[PROP_OMID_REASON] as? String)
+        ads.omid.addFriendlyObstruction(friendlyObstruction: obstruction)
+      }
+    }
+  }
+  
+  @objc(removeAllFriendlyObstructions:)
+  func removeAllFriendlyObstructions(_ node: NSNumber) {
+    DispatchQueue.main.async {
+      if let theView = self.bridge.uiManager.view(forReactTag: node) as? THEOplayerRCTView,
+         let ads = theView.ads() {
+        ads.omid.removeFriendlyObstructions()
+      }
+    }
+  }
+  
+#else
+  
+  @objc(addFriendlyObstruction:obstruction:)
+  func addFriendlyObstruction(_ node: NSNumber, obstruction: NSDictionary) {
+    if DEBUG_ADS_API { print(ERROR_MESSAGE_ADS_UNSUPPORTED_FEATURE) }
+  }
+  
+  @objc(removeAllFriendlyObstructions:)
+  func removeAllFriendlyObstructions(_ node: NSNumber) {
+    if DEBUG_ADS_API { print(ERROR_MESSAGE_ADS_UNSUPPORTED_FEATURE) }
+  }
+  
+#endif
+}
+
+