react-native-theoplayer 2.6.0 → 2.8.0

package/CHANGELOG.md

@@ -5,6 +5,43 @@ 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.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [2.8.0] - 23-06-01
+
+### Added
+
+- Added `ignoreAvailabilityWindow` property to `SourceDescription.dash` for Android and Web.
+- Added `needsTimescaleShifting`, `desiredTimescale` and `forceSeekToSynchronize` properties to `SourceDescription.dash` for Web.
+
+### Fixed
+
+- Fixed an issue where text track cue changes were not applied to the TextTrack's `cue` property.
+- Fixed an issue on Android where play-out of an MP4 stream would sometimes crash the player.
+- Fixed an issue on Android where a `pause` event would not be dispatched while pausing during play-out of an ad.
+- Fixed an issue on Android where hardware buttons, such as `play` and `pause`, were not handled anymore after toggling background audio support.
+- Fixed an issue on Android where the app would crash when toggling background playback while multiple `MediaBrowserServiceCompat` instances are registered.
+
+### Changed
+
+- Improved fullscreen support to use non-native fullscreen on Safari for iPad and Mac.
+- Limited the set of available media session actions on Android when an ad or live stream is playing.
+- Removed pausing the stream when disabling background playback on Android.
+
+## [2.7.0] - 23-05-15
+
+### Changed
+
+- Approved player behaviour on iOS and Android when doing player operations such as `play` and `pause` in case no source was set.
+
+### Fixed
+
+- Fixed an issue on Android where if an invalid view tag is passed to the native bridge, it would crash the player.
+- Fixed an issue on Web where preview thumbnails would fail to load.
+
+### Added
+
+- Updated UI documentation with necessary dependencies.
+- Added improved debug logging on iOS.
+
 ## [2.6.0] - 23-05-05
 
 ### Fixed

package/android/build.gradle

@@ -109,7 +109,7 @@ dependencies {
   def theoplayer_sdk_version = safeExtGet('THEOplayer_sdk', '[5.0.1,)')
 
 //  def theoplayer_mediasession_version = safeExtGet('THEOplayer_mediasession', theoplayer_sdk_version)
-  def theoplayer_mediasession_version = "4.12.0-local"
+  def theoplayer_mediasession_version = "5.2.0-local"
   def enabledV4 = theoplayer_sdk_version.toString().startsWith("4.")
   def core_prefix = enabledV4 ? 'unified' : 'core'
   def integration_prefix = enabledV4 ? 'unified' : 'integration'

package/android/local/com/theoplayer/android-connector/mediasession/{4.12.0-local/mediasession-4.12.0-local.pom → 5.2.0-local/mediasession-5.2.0-local.pom}

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.theoplayer.android-connector</groupId>
   <artifactId>mediasession</artifactId>
-  <version>4.12.0-local</version>
+  <version>5.2.0-local</version>
   <packaging>aar</packaging>
   <dependencies>
     <dependency>

package/android/local/com/theoplayer/android-connector/mediasession/maven-metadata-local.xml

@@ -3,11 +3,11 @@
   <groupId>com.theoplayer.android-connector</groupId>
   <artifactId>mediasession</artifactId>
   <versioning>
-    <latest>4.12.0-local</latest>
-    <release>4.12.0-local</release>
+    <latest>5.2.0-local</latest>
+    <release>5.2.0-local</release>
     <versions>
-      <version>4.12.0-local</version>
+      <version>5.2.0-local</version>
     </versions>
-    <lastUpdated>20230408184844</lastUpdated>
+    <lastUpdated>20230531125422</lastUpdated>
   </versioning>
 </metadata>

package/android/src/main/AndroidManifest.xml

@@ -29,7 +29,7 @@
 
     <!-- Allow background audio playback by registering this service. -->
     <service
-      android:name="com.theoplayer.audio.MediaPlaybackService"
+      android:name="com.theoplayer.media.MediaPlaybackService"
       android:description="@string/background_playback_service_description"
       android:exported="false"
       android:enabled="false"
@@ -40,7 +40,7 @@
       </intent-filter>
     </service>
 
-    <receiver android:name="androidx.media.session.MediaButtonReceiver"
+    <receiver android:name="com.theoplayer.media.CustomMediaButtonReceiver"
       android:exported="false">
       <intent-filter>
         <action android:name="android.intent.action.MEDIA_BUTTON" />

package/android/src/main/java/com/theoplayer/PlayerEventEmitter.kt

@@ -346,7 +346,7 @@ class PlayerEventEmitter internal constructor(
   private fun onPause() {
     val player = playerView.player
     // Do not forward the pause event in case the content player is paused because the ad player starts.
-    if (player != null && !playerView.adsApi.isPlaying) {
+    if (player != null && (!playerView.adsApi.isPlaying || player.isPaused)) {
       receiveEvent(EVENT_PAUSE, null)
     }
   }

package/android/src/main/java/com/theoplayer/ReactTHEOplayerContext.kt

@@ -26,11 +26,20 @@ import com.theoplayer.android.api.event.player.*
 import com.theoplayer.android.api.player.Player
 import com.theoplayer.android.connector.mediasession.MediaSessionConnector
 import com.theoplayer.audio.BackgroundAudioConfig
-import com.theoplayer.audio.MediaPlaybackService
+import com.theoplayer.media.MediaPlaybackService
 import java.util.concurrent.atomic.AtomicBoolean
 
 private const val TAG = "ReactTHEOplayerContext"
 
+private const val ALLOWED_PLAYBACK_ACTIONS = (
+  PlaybackStateCompat.ACTION_PLAY_PAUSE or
+    PlaybackStateCompat.ACTION_PLAY or
+    PlaybackStateCompat.ACTION_PAUSE or
+    PlaybackStateCompat.ACTION_SEEK_TO or
+    PlaybackStateCompat.ACTION_FAST_FORWARD or
+    PlaybackStateCompat.ACTION_REWIND or
+    PlaybackStateCompat.ACTION_SET_PLAYBACK_SPEED)
+
 class ReactTHEOplayerContext private constructor(
   private val reactContext: ThemedReactContext
 ) {
@@ -59,8 +68,6 @@ class ReactTHEOplayerContext private constructor(
     get() = backgroundAudioConfig.enabled
 
   companion object {
-    private var mediaControlledInstance: ReactTHEOplayerContext? = null
-
     fun create(
       reactContext: ThemedReactContext,
       playerConfig: THEOplayerConfig
@@ -75,9 +82,6 @@ class ReactTHEOplayerContext private constructor(
     override fun onServiceConnected(className: ComponentName, service: IBinder) {
       binder = service as MediaPlaybackService.MediaPlaybackBinder
 
-      // Clean-up any existing media session connector
-      mediaSessionConnector?.destroy()
-
       // Get media session connector from service
       mediaSessionConnector = binder?.mediaSessionConnector
       mediaSessionConnector?.player = player
@@ -128,12 +132,26 @@ class ReactTHEOplayerContext private constructor(
     }
   }
 
+  private fun applyAllowedMediaControls() {
+    // Reduce allowed set of remote control playback actions for ads & live streams.
+    val isLive = player.duration.isInfinite()
+    val isInAd = player.ads.isPlaying
+    mediaSessionConnector?.enabledPlaybackActions = if (isInAd || isLive) {
+      0
+    } else {
+      ALLOWED_PLAYBACK_ACTIONS
+    }
+  }
+
   private fun bindMediaPlaybackService() {
     // Bind to an existing service, if available
     // A bound service runs only as long as another application component is bound to it.
     // Multiple components can bind to the service at once, but when all of them unbind, the
     // service is destroyed.
     if (!isBound.get()) {
+      // Clean-up any existing media session connector
+      mediaSessionConnector?.destroy()
+
       isBound.set(
         reactContext.bindService(
           Intent(reactContext, MediaPlaybackService::class.java),
@@ -179,11 +197,8 @@ class ReactTHEOplayerContext private constructor(
     addIntegrations(playerConfig)
     addListeners()
 
-    if (mediaControlledInstance == null) {
-      mediaControlledInstance = this
-      if (!BuildConfig.USE_PLAYBACK_SERVICE || !isBackgroundAudioEnabled) {
-        initDefaultMediaSession()
-      }
+    if (!BuildConfig.USE_PLAYBACK_SERVICE || !isBackgroundAudioEnabled) {
+      initDefaultMediaSession()
     }
 
     // Apply initial backgroundPlayback config
@@ -243,10 +258,12 @@ class ReactTHEOplayerContext private constructor(
   private val onSourceChange = EventListener<SourceChangeEvent> {
     mediaSessionConnector?.setMediaSessionMetadata(player.source)
     binder?.updateNotification()
+    applyAllowedMediaControls()
   }
 
   private val onLoadedMetadata = EventListener<LoadedMetadataEvent> {
     binder?.updateNotification()
+    applyAllowedMediaControls()
   }
 
   private val onPlay = EventListener<PlayEvent> {
@@ -254,10 +271,12 @@ class ReactTHEOplayerContext private constructor(
       bindMediaPlaybackService()
     }
     binder?.updateNotification(PlaybackStateCompat.STATE_PLAYING)
+    applyAllowedMediaControls()
   }
 
   private val onPause = EventListener<PauseEvent> {
     binder?.updateNotification(PlaybackStateCompat.STATE_PAUSED)
+    applyAllowedMediaControls()
   }
 
   private fun addListeners() {
@@ -310,17 +329,14 @@ class ReactTHEOplayerContext private constructor(
   }
 
   fun destroy() {
-    if (mediaControlledInstance == this) {
-      if (BuildConfig.USE_PLAYBACK_SERVICE) {
-        removeListeners()
+    if (BuildConfig.USE_PLAYBACK_SERVICE) {
+      removeListeners()
 
-        // Remove service from foreground
-        binder?.stopForegroundService()
+      // Remove service from foreground
+      binder?.stopForegroundService()
 
-        // Unbind client from background service so it can stop
-        unbindMediaPlaybackService()
-      }
-      mediaControlledInstance = null
+      // Unbind client from background service so it can stop
+      unbindMediaPlaybackService()
     }
     mediaSessionConnector?.destroy()
     playerView.onDestroy()

package/android/src/main/java/com/theoplayer/media/CustomMediaButtonReceiver.kt

@@ -0,0 +1,25 @@
+package com.theoplayer.media
+
+import android.content.Context
+import android.content.Intent
+import android.util.Log
+import androidx.media.session.MediaButtonReceiver
+
+private const val TAG = "MediaButtonReceiver"
+
+class CustomMediaButtonReceiver : MediaButtonReceiver() {
+
+  override fun onReceive(context: Context?, intent: Intent?) {
+    // MediaButtonReceiver will throw an IllegalStateException in case there are
+    // none, or more than one MediaBrowserServiceCompat instances registered.
+    // Handle and ignore the exception here.
+    try {
+      super.onReceive(context, intent)
+    } catch (e: IllegalStateException) {
+      Log.e(
+        TAG,
+        e.message ?: "Failed to handle media playback button action."
+      )
+    }
+  }
+}

package/android/src/main/java/com/theoplayer/{audio → media}/MediaNotificationBuilder.kt

@@ -1,4 +1,4 @@
-package com.theoplayer.audio
+package com.theoplayer.media
 
 import android.app.Notification
 import android.app.NotificationChannel

package/android/src/main/java/com/theoplayer/{audio → media}/MediaPlaybackService.kt

@@ -1,4 +1,4 @@
-package com.theoplayer.audio
+package com.theoplayer.media
 
 import android.app.NotificationManager
 import android.app.PendingIntent
@@ -98,6 +98,9 @@ class MediaPlaybackService : MediaBrowserServiceCompat() {
   }
 
   override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {
+    // This ensures that the correct callbacks to MediaSessionCompat.Callback will be triggered
+    // based on the incoming KeyEvent.
+    // https://developer.android.com/reference/androidx/media/session/MediaButtonReceiver
     MediaButtonReceiver.handleIntent(mediaSession, intent)
     return super.onStartCommand(intent, flags, startId)
   }
@@ -155,17 +158,19 @@ class MediaPlaybackService : MediaBrowserServiceCompat() {
       setMediaButtonReceiver(mediaButtonPendingIntent)
     }
 
-    // Create a MediaSessionConnector and attach the THEOplayer instance.
+    // Create a MediaSessionConnector.
     mediaSessionConnector = MediaSessionConnector(mediaSession).apply {
       debug = BuildConfig.LOG_MEDIASESSION_EVENTS
 
       // Set mediaSession active
       setActive(true)
     }
+
+    // Set the MediaBrowserServiceCompat's media session.
+    sessionToken = mediaSession.sessionToken
   }
 
   private fun stopForegroundService() {
-    player?.pause()
     updateNotification(PlaybackStateCompat.STATE_STOPPED)
     stopSelf()
   }

package/android/src/main/java/com/theoplayer/source/SourceAdapter.kt

@@ -24,6 +24,7 @@ import com.theoplayer.android.api.source.metadata.ChromecastMetadataImage
 import com.facebook.react.bridge.ReadableArray
 import com.theoplayer.BuildConfig
 import com.theoplayer.android.api.error.ErrorCode
+import com.theoplayer.android.api.source.dash.DashPlaybackConfiguration
 import com.theoplayer.drm.ContentProtectionAdapter
 import org.json.JSONArray
 import org.json.JSONException
@@ -51,6 +52,8 @@ private const val PROP_TEXT_TRACKS = "textTracks"
 private const val PROP_POSTER = "poster"
 private const val PROP_ADS = "ads"
 private const val PROP_AVAILABILITY_TYPE = "availabilityType"
+private const val PROP_DASH = "dash"
+private const val PROP_DASH_IGNORE_AVAILABILITYWINDOW = "ignoreAvailabilityWindow"
 private const val ERROR_DAI_NOT_ENABLED = "Google DAI support not enabled."
 private const val ERROR_UNSUPPORTED_SSAI_INTEGRATION = "Unsupported SSAI integration"
 private const val ERROR_MISSING_SSAI_INTEGRATION = "Missing SSAI integration"
@@ -186,6 +189,9 @@ class SourceAdapter {
       if (sourceType != null) {
         tsBuilder.type(sourceType)
       }
+      if (jsonTypedSource.has(PROP_DASH)) {
+        tsBuilder.dash(parseDashConfig(jsonTypedSource.getJSONObject(PROP_DASH)))
+      }
       if (jsonTypedSource.has(PROP_LIVE_OFFSET)) {
         tsBuilder.liveOffset(jsonTypedSource.getDouble(PROP_LIVE_OFFSET))
       }
@@ -358,6 +364,12 @@ class SourceAdapter {
     return MetadataDescription(metadata)
   }
 
+  private fun parseDashConfig(dashConfig: JSONObject): DashPlaybackConfiguration {
+    return DashPlaybackConfiguration.Builder()
+      .ignoreAvailabilityWindow(dashConfig.optBoolean(PROP_DASH_IGNORE_AVAILABILITYWINDOW))
+      .build()
+  }
+
   @Throws(JSONException::class)
   private fun parseMetadataImages(metadataImages: JSONArray): List<ChromecastMetadataImage> {
     val imageList: MutableList<ChromecastMetadataImage> = ArrayList()

package/android/src/main/java/com/theoplayer/track/TrackListAdapter.kt

@@ -124,9 +124,11 @@ object TrackListAdapter {
     audioTrackPayload.putString(PROP_LANGUAGE, audioTrack.language)
     val qualityList = audioTrack.qualities
     val qualities = Arguments.createArray()
-    qualityList?.forEach { quality ->
-      qualities.pushMap(fromAudioQuality(quality))
-    }
+    try {
+      qualityList?.forEach { quality ->
+        qualities.pushMap(fromAudioQuality(quality))
+      }
+    } catch (ignore: NullPointerException) {}
     audioTrackPayload.putArray(PROP_QUALITIES, qualities)
     val activeQuality = audioTrack.activeQuality
     if (activeQuality != null) {
@@ -163,18 +165,20 @@ object TrackListAdapter {
     videoTrackPayload.putString(PROP_KIND, videoTrack.kind)
     videoTrackPayload.putString(PROP_LABEL, videoTrack.label)
     videoTrackPayload.putString(PROP_LANGUAGE, videoTrack.language)
-    val qualityList = videoTrack.qualities
     val qualities = Arguments.createArray()
-    if (qualityList != null) {
-      // Sort qualities according to (height, bandwidth)
-      val sortedQualityList = QualityListAdapter(qualityList)
-      sortedQualityList.sort { o: VideoQuality, t1: VideoQuality ->
-        if (o.height == t1.height) t1.bandwidth.compareTo(o.bandwidth) else t1.height.compareTo(o.height)
+    try {
+      val qualityList = videoTrack.qualities
+      if (qualityList != null) {
+        // Sort qualities according to (height, bandwidth)
+        val sortedQualityList = QualityListAdapter(qualityList)
+        sortedQualityList.sort { o: VideoQuality, t1: VideoQuality ->
+          if (o.height == t1.height) t1.bandwidth.compareTo(o.bandwidth) else t1.height.compareTo(o.height)
+        }
+        for (quality in sortedQualityList) {
+          qualities.pushMap(fromVideoQuality(quality as VideoQuality))
+        }
       }
-      for (quality in sortedQualityList) {
-        qualities.pushMap(fromVideoQuality(quality as VideoQuality))
-      }
-    }
+    } catch (ignore: java.lang.NullPointerException) {}
     videoTrackPayload.putArray(PROP_QUALITIES, qualities)
     val activeQuality = videoTrack.activeQuality
     if (activeQuality != null) {

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

@@ -1,9 +1,12 @@
 package com.theoplayer.util
 
+import android.util.Log
 import com.facebook.react.bridge.ReactApplicationContext
 import com.facebook.react.uimanager.UIManagerModule
 import com.theoplayer.ReactTHEOplayerView
 
+private const val TAG = "ViewResolver"
+
 class ViewResolver(private val reactContext: ReactApplicationContext) {
   private var uiManager: UIManagerModule? = null
 
@@ -12,7 +15,12 @@ class ViewResolver(private val reactContext: ReactApplicationContext) {
       uiManager = reactContext.getNativeModule(UIManagerModule::class.java)
     }
     uiManager?.addUIBlock {
-      onResolved(it.resolveView(tag) as ReactTHEOplayerView)
+      try {
+        onResolved(it.resolveView(tag) as ReactTHEOplayerView)
+      } catch (ignore: Exception) {
+        // The ReactTHEOplayerView instance could not be resolved: log but do not forward exception.
+        Log.w(TAG, "Failed to resolve ReactTHEOplayerView tag $tag")
+      }
     }
   }
 }

package/ios/THEOplayerRCTDebug.swift

@@ -1,16 +1,16 @@
 // THEOplayerRCTDebug.swift
 
 // General debug flag, if set to false none of the debug prints will appear
-let DEBUG = false
+let DEBUG = true
 
 // Debug flag to monitor incoming Theoplayer events
-let DEBUG_THEOPLAYER_EVENTS = DEBUG && false
+let DEBUG_THEOPLAYER_EVENTS = DEBUG && true
 
 // Debug flag to monitor eventhandler setup and breakdown
 let DEBUG_EVENTHANDLER = DEBUG && false
 
 // Debug flag to monitor the interactions for each view with its underlying theoplayer instance
-let DEBUG_THEOPLAYER_INTERACTION = DEBUG && false
+let DEBUG_THEOPLAYER_INTERACTION = DEBUG && true
 
 // Debug flag to monitor contentProtection integration handling
 let DEBUG_CONTENT_PROTECTION_API = DEBUG && false