react-native-theoplayer 1.8.3 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,248 @@
+# Changelog
+
+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.0.0] - 23-04-06
+
+### Added
+
+- Released 2.0.0 version.
+
+## [Unreleased 2.0.0-pre9]
+
+### Changed
+
+- Set the player container on Web to by default have a width and height not larger than the devices width and height.
+- Use `enum` type for `PresentationMode`, `CastState` and`AdIntegrationKind`.
+- Changed the methods of the Cast API, such as `casting` and `state`, to be synchronous.
+- Applied `backgroundAudioConfig` properties on Android when closing picture-in-picture window.
+- Applied `backgroundAudioConfig` properties on Android when showing Notifications.
+- Disable iOS lockscreen controls when backgroundAudioConfig is set to `disabled`.
+
+### Added
+
+- Added `enableMediaPlaybackService` option to `backgroundAudioConfiguration` to optionally disable the MediaBrowserService that provides background audio support on Android.
+- Added support for the `enabled` flag of `BackgroundAudioConfiguration` for Web.
+- Added serviceId and contentId to NowPlayingInfo
+- Feature flag extraction from custom iOS builds
+
+### Fixed
+
+- Fixed an issue on Android where the media session would become inactive when going to picture-in-picture mode, removing all transport controls.
+- Fixed an issue where removing a player listener within a listener callback would sometimes result in events not being dispatched.
+
+## [Unreleased 2.0.0-pre7]
+
+### Fixed
+
+- Fixed an issue where the media session connector for Web would report an error when passing an Infinite duration for live streams.
+- Fixed an issue on iOS where ID3 metadata content would not be correctly passed to cue instances.
+- Fixed an issue on Android where the `'picture-in-picture'` permission was not checked.
+- Fixed an issue on Android where the aspect ratio of the `'picture-in-picture'` window could be outside the valid range.
+- Fixed an issue on iOS and Android where for a live stream the `duration` property of a `loadedmetadata` event was not properly passed as being `Infinite`.
+
+### Changed
+
+- Replaced deprecated systemUiVisibility code in Android's PresentationManager.
+- Use `enum` types for `TextTrackMode`, `TextTrackType` and `TextTrackKind`.
+- Allow go-to-live on iOS and Android by setting `currentTime` to `Infinity`.
+
+### Added
+
+- Added a `mediaControl` property to `PlayerConfiguration` to configure Media Session, Now Playing and Remote Command Center functionality across all platforms. It currently only contains a media session toggle for Web.
+- Added a `backgroundAudioConfiguration` property to `THEOplayer` to allow dynamically configuring background audio functionality.
+- Added a `pipConfiguration` property to `THEOplayer` to allow dynamically configuring picture-in-picture behavior.
+- Added support for background audio playback on iOS and Android.
+- Added `keepScreenOn` as a default player view property on Android to keep the device awake.
+
+## [Unreleased 2.0.0-pre6]
+
+### Fixed
+
+- Fixed an issue where the IMA player container would be rendered collapsed on Web.
+- Fixed a missing check for picture-in-picture permission on Android.
+
+### Added
+
+- Added media session connector for Web.
+
+## [Unreleased 2.0.0-pre5]
+
+### Added
+
+- Added `onPlayerReady` callback on `THEOplayerView` to pass a `THEOplayer` instance once it is ready for access. More info on the [migration documentation](./doc/migrating_v2.md) page.
+- Added `canplay` event, which is dispatched when the player can start play-out.
+- Added `waiting` event, which is dispatched when the player has stopped play-out because of a temporary lack of data.
+- Added `nativeHandle` property on `THEOplayer` to access the native player instance on web, and view id on mobile.
+- Added `entercue` and `exitcue` events for text tracks, which are dispatched when a cue becomes (in)active.
+- Added `ratechange` event, which is dispatched when the player's playback rate was changed.
+- Added `seekable` property on `THEOplayer`, containing the time ranges of the media the player is able to seek to.
+- Added `buffered` property on `THEOplayer`, containing the time ranges of the media the player has currently buffered.
+- Added `buffered` property to the payload of the `onprogress` event.
+- Added `duration`, `seeking`, `preload`, `textTrack`, `videoTracks` and `audioTracks` properties to `THEOplayer`.
+- Added `libraryLocation` property to `PlayerConfiguration` to allow passing custom location for web workers.
+- Added `mutedAutoplay` property to `PlayerConfiguration` to allow autoplay on web browsers with different autoplay policies.
+- Added mode `hidden` as a value for a text track's `TextTrackMode` property, which is typically used for metadata tracks.
+- Added `TextTrackStyle` API to support text track styling. This feature is currently supported on web only.
+- Added support for 'picture-in-picture' presentation mode. More information on the [documentation page](./doc/pip.md)
+- Added `muted` state in `volumechange` event payload.
+- Added media session connector for Android.
+- Added public accessor on the `THEOplayerRCTView` that exposes the underlying iOS `THEOplayer` instance. So you can use the underlying THEOplayer from other packages.
+
+### Changed
+
+- Moved all player properties such as `paused`, `muted` and `volume`, from  `THEOplayerView` component to `THEOplayer` instance. More info on the [migration documentation](./doc/migrating_v2.md) page.
+- Removed `onEventName` callback methods from `THEOplayerView` component in favor of `THEOplayer` event listener's interface. More info on the [migration documentation](./doc/migrating_v2.md) page.
+- Changed documentation sample code to reflect API changes.
+- Exposed the `activeQuality` of a `MediaTrack` as a `Quality` instance instead of the quality's `uid`.
+- Set the default container style for web to let the player cover the whole container.
+
+### Removed
+
+- Removed `seek` method on `THEOplayer`. It is replaced with a `currentTime` setter.
+- Removed `fullscreen` setter and getter in favor of `presentationMode`.
+
+### Fixed
+
+- Fixed an issue on Android where an exception is thrown when an empty source description would be passed.
+- Fixed the Webpack configuration in the sample application to copy web workers to `libraryLocation`.
+- Fixed an issue on web where in case multiple player instances are created, the players would overlap.
+- Fixed an issue on iOS Safari where switching to fullscreen presentation would not work.
+- Fixed an issue on Android where passing an invalid empty source description would result in a crash.
+- Fixed an issue on Android where the `framerate` property of a `VideoQuality` instance would not be filled in.
+- Fixed an issue on iOS where the `TextTrackMode` property of a text track would be incorrect.
+- Fixed an issue on iOS where after enabling/disabling a text track, metadata tracks would be set to `disabled` as well.
+- Fixed missing `volumechange` events on mobile platforms.
+- Fixed an issue on iOS where after toggling the mute state during an ad playout, succeeding mute toggles had no effect.
+
+## [1.8.2]
+
+### Fixed
+
+- Fixed an issue on Android where building the SDK would fail when depending on player SDK v4.12.0.
+
+## [1.8.1]
+
+### Changed
+
+- Restructured iOS bridge code to extensions based on features.
+
+### Fixed
+
+- Fixed an issue on Android where the system UI would not be restored when unmounting THEOplayerView with `fullscreen` enabled.
+- Fixed an issue with the availability of the cast button and play buttons in the example application.
+- Fixed an issue on iOS where the player was not destroyed correctly on the iOS bridge.
+- Added support for `DRMConfig` through `SourceDescription` for SSAI sources on iOS.
+
+## [1.8.0]
+
+### Added
+
+- Support for Chromecast and Airplay.
+
+### Fixed
+
+- Fixed an issue where moving the sender app to the background while playing a DAI source on an Airplay device, would pause playback.
+
+### Changed
+
+- Upgraded Web SDK to v4.6.0.
+- Updated the custom build setup to support both iOS and tvOS.
+
+## [1.7.2]
+
+### Fixed
+
+- Fixed an issue on tvOS where a feature flag was incorrectly used for ads-related code.
+
+## [1.7.1]
+
+### Fixed
+
+- Fixed an issue on Android where the player would consider unusable custom drm integrations.
+- Fixed missing kotlin classpath property on Android.
+
+## [1.7.0]
+
+### Added
+
+- Support for content protection integration (DRM connectors).
+- Support for subscribing to ad events.
+- Support for Google DAI ads.
+- Support for Google IMA ads.
+- Support for ABR configuration on Android and Web.
+- Support for video quality selection on Android and Web.
+
+### Fixed
+
+- Fixed an issue where the player would not be correctly released when destroying the view on Android.
+- Fixed a warning during debugging when a stream would have duration INF or NaN.
+- Fixed an issue in the example app where it would not be possible to select a specific text track.
+- Fixed conflicting npm dependencies in the example app.
+
+## [1.6.1]
+
+### Added
+
+- Improved source handling for iOS.
+
+## [1.6.0]
+
+### Fixed
+
+- Fixed jitpack.io repository url for Android.
+- Fixed an issue where play-out of HLS streams would fail on Android.
+
+### Changed
+
+- Excluded folders from bob build config.
+- Upgraded gradle versions for Android.
+
+## [1.5.0]
+
+### Fixed
+
+- Fixed disabling all debug logs for iOS/tvOS release builds.
+- Fixed duration from seconds to milliseconds on iOS/tvOS.
+
+### Added
+
+- Support for DRM pre-integrations on Android.
+- Support for additional source properties on Android: `liveOffset`, `hlsDateRange`, `timeServer` and `hls`.
+
+## [1.4.0]
+
+### Fixed
+
+- Fixed an issue on iOS where subtitles upon disappearing would sometimes leave a thin black line on the image.
+- Fixed an issue on iOS where the player would not be destroyed after going to fullscreen.
+
+### Added
+
+- Improved determination of the stream source type on Android.
+
+## [1.3.0]
+
+### Fixed
+
+- Fixed an issue where the app would crash due to the configured Flipper version.
+- Fixed duplicate classes issue for Android when having dependencies on local libs folder.
+- Fixed documentation feature matrix.
+- Fixed duration scale in loadedmetadata event properties for Web.
+
+## [1.2.0]
+
+### Fixed
+
+- Fixed a crash when removing text tracks event listeners on iOS.
+- Fixed a number of broken links in the documentation.
+- Removed unused files.
+
+## [1.1.0]
+
+### Added
+
+- Initial release.

package/README.md

@@ -23,7 +23,8 @@ following platforms:
 - Web (currently only HTML5 browsers are tested)
 
 This document covers the creation of a minimal app including a `THEOplayerView` component,
-and an overview of the included example app with its basic UI.
+and an overview of the included example app with the `DefaultTHEOplayerUi`.
+
 It also gives a description of the properties of the `THEOplayerView` component, and
 a list of features and known limitations.
 
@@ -60,13 +61,17 @@ and discussed in the next section. Finally, an overview of features, limitations
     - [Getting started on Android](./doc/creating-minimal-app.md#getting-started-on-android)
     - [Getting started on iOS](./doc/creating-minimal-app.md#getting-started-on-ios-and-tvos)
     - [Getting started on Web](./doc/creating-minimal-app.md#getting-started-on-web)
+- [Getting started with the UI](./doc/ui.md)
 - [The THEOplayerView component](./doc/theoplayerview-component.md)
-- [The example application with React Native UI](./doc/example-app.md)
+- [The example application](./doc/example-app.md)
 - [Features](./doc/features.md)
 - Knowledge Base
   - [Adaptive Bitrate (ABR)](./doc/abr.md)
   - [Advertisements](./doc/ads.md)
+  - [Background playback and notifications](./doc/background.md)
   - [Casting with Chromecast and Airplay](./doc/cast.md)
   - [Custom iOS framework](./doc/custom-ios-framework.md)
   - [Digital Rights Management (DRM)](./doc/drm.md)
+  - [Picture-in-Picture (PiP)](./doc/pip.md)
+  - [Migrating to `react-native-theoplayer` v2.x](./doc/migrating_v2.md)
 - [Limitations and known issues](./doc/limitations.md)

package/android/build.gradle

@@ -6,7 +6,7 @@ buildscript {
 
   dependencies {
     classpath 'com.android.tools.build:gradle:4.2.2'
-    classpath 'org.jetbrains.kotlin:kotlin-gradle-plugin:1.7.10'
+    classpath 'org.jetbrains.kotlin:kotlin-gradle-plugin:1.7.21'
   }
 }
 
@@ -17,11 +17,16 @@ def safeExtGet(prop, fallback) {
   rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
 }
 
+static def versionString(version) {
+  return "${version == '+' ? 'latest' : version}"
+}
+
 // Extensions
 def enabledGoogleIMA = safeExtGet("THEOplayer_extensionGoogleIMA", 'false').toBoolean()
 def enabledGoogleDAI = safeExtGet("THEOplayer_extensionGoogleDAI", 'false').toBoolean()
 def enabledAds = enabledGoogleIMA || enabledGoogleDAI
 def enabledCast = safeExtGet("THEOplayer_extensionCast", 'false').toBoolean()
+def enabledMediaSession = safeExtGet("THEOplayer_extensionMediaSession", 'true').toBoolean()
 
 android {
   compileSdkVersion safeExtGet('THEOplayer_compileSdkVersion', 31)
@@ -43,12 +48,15 @@ android {
     // Optionally log events to logcat
     buildConfigField "boolean", "LOG_PLAYER_EVENTS", "${safeExtGet('THEOplayer_logPlayerEvents', 'false')}"
     buildConfigField "boolean", "LOG_VIEW_EVENTS", "${safeExtGet('THEOplayer_logViewEvents', 'false')}"
+    buildConfigField "boolean", "LOG_MEDIASESSION_EVENTS", "${safeExtGet('THEOplayer_logMediaSessionEvents', 'false')}"
+    buildConfigField "boolean", "USE_PLAYBACK_SERVICE", "${safeExtGet('THEOplayer_usePlaybackService', 'true')}"
 
     // Extension buildConfig fields
     buildConfigField "boolean", "EXTENSION_GOOGLE_IMA", "${enabledGoogleIMA}"
     buildConfigField "boolean", "EXTENSION_GOOGLE_DAI", "${enabledGoogleDAI}"
     buildConfigField "boolean", "EXTENSION_ADS", "${enabledAds}"
     buildConfigField "boolean", "EXTENSION_CAST", "${enabledCast}"
+    buildConfigField "boolean", "EXTENSION_MEDIASESSION", "${enabledMediaSession}"
   }
 
   buildTypes {
@@ -93,43 +101,54 @@ repositories {
 dependencies {
   //noinspection GradleDynamicVersion
   implementation "com.facebook.react:react-native:+"  // From node_modules
-  implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4'
-  implementation "com.theoplayer.theoplayer-sdk-android:ads-wrapper:4.3.0"
+  implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4"
+  implementation "com.theoplayer.theoplayer-sdk-android:ads-wrapper:4.8.0"
+  implementation "androidx.appcompat:appcompat:1.4.+"
 
   def theoplayer_sdk_version = safeExtGet('THEOplayer_sdk', '+')
+//  def theoplayer_mediasession_version = safeExtGet('THEOplayer_mediasession', theoplayer_sdk_version)
+  def theoplayer_mediasession_version = "4.11.0-local"
   def enabledV4 = theoplayer_sdk_version.toString().startsWith("4.")
   def core_prefix = enabledV4 ? 'unified' : 'core'
   def integration_prefix = enabledV4 ? 'unified' : 'integration'
 
-  println("Using THEOplayer v${theoplayer_sdk_version}")
+  println("Using THEOplayer (${versionString(theoplayer_sdk_version)})")
   implementation "com.theoplayer.theoplayer-sdk-android:${core_prefix}:${theoplayer_sdk_version}"
 
+  if (enabledMediaSession) {
+    println("Enable THEOplayer MediaSession extension (${versionString(theoplayer_mediasession_version)})")
+    implementation "com.theoplayer.android-connector:mediasession:${theoplayer_mediasession_version}"
+  } else {
+    println('Disable THEOplayer MediaSession extension.')
+    compileOnly "com.theoplayer.android-connector:mediasession:${theoplayer_mediasession_version}"
+  }
+
   if (enabledGoogleIMA) {
-    println('ENABLE THEOplayer IMA extension.')
+    println('Enable THEOplayer IMA extension.')
     implementation "com.theoplayer.theoplayer-sdk-android:${integration_prefix}-ads:${theoplayer_sdk_version}"
     implementation "com.theoplayer.theoplayer-sdk-android:${integration_prefix}-ads-ima:${theoplayer_sdk_version}"
   } else {
-    println('DISABLE THEOplayer IMA extension.')
+    println('Disable THEOplayer IMA extension.')
     compileOnly "com.theoplayer.theoplayer-sdk-android:${integration_prefix}-ads:${theoplayer_sdk_version}"
     compileOnly "com.theoplayer.theoplayer-sdk-android:${integration_prefix}-ads-ima:${theoplayer_sdk_version}"
   }
 
   // NOTE: The DAI extension module is available on Maven as of SDK v4.3.0
   if (enabledGoogleDAI) {
-    println('ENABLE THEOplayer DAI extension.')
+    println('Enable THEOplayer DAI extension.')
     implementation "com.theoplayer.theoplayer-sdk-android:${integration_prefix}-ads:${theoplayer_sdk_version}"
     implementation "com.theoplayer.theoplayer-sdk-android:${integration_prefix}-ads-dai:${theoplayer_sdk_version}"
   } else {
-    println('DISABLE THEOplayer DAI extension.')
+    println('Disable THEOplayer DAI extension.')
     compileOnly "com.theoplayer.theoplayer-sdk-android:${integration_prefix}-ads:${theoplayer_sdk_version}"
     compileOnly "com.theoplayer.theoplayer-sdk-android:${integration_prefix}-ads-dai:${theoplayer_sdk_version}"
   }
 
   if (enabledCast) {
-    println('ENABLE THEOplayer cast extension.')
+    println('Enable THEOplayer cast extension.')
     implementation "com.theoplayer.theoplayer-sdk-android:${integration_prefix}-cast:${theoplayer_sdk_version}"
   } else {
-    println('DISABLE THEOplayer cast extension.')
+    println('Disable THEOplayer cast extension.')
     compileOnly "com.theoplayer.theoplayer-sdk-android:${integration_prefix}-cast:${theoplayer_sdk_version}"
   }
 }

package/android/local/com/theoplayer/android-connector/mediasession/4.11.0-local/mediasession-4.11.0-local.pom

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.theoplayer.android-connector</groupId>
+  <artifactId>mediasession</artifactId>
+  <version>4.11.0-local</version>
+  <packaging>aar</packaging>
+  <dependencies>
+    <dependency>
+      <groupId>androidx.media</groupId>
+      <artifactId>media</artifactId>
+      <version>1.6.0</version>
+    </dependency>
+  </dependencies>
+</project>

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

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<metadata>
+  <groupId>com.theoplayer.android-connector</groupId>
+  <artifactId>mediasession</artifactId>
+  <versioning>
+    <latest>4.11.0-local</latest>
+    <release>4.11.0-local</release>
+    <versions>
+      <version>4.11.0-local</version>
+    </versions>
+    <lastUpdated>20230403121710</lastUpdated>
+  </versioning>
+</metadata>

package/android/local/com/theoplayer/theoplayer-sdk-android/ads-wrapper/4.8.0/ads-wrapper-4.8.0.pom

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.theoplayer.theoplayer-sdk-android</groupId>
+  <artifactId>ads-wrapper</artifactId>
+  <version>4.8.0</version>
+  <packaging>aar</packaging>
+</project>

package/android/local/com/theoplayer/theoplayer-sdk-android/ads-wrapper/maven-metadata-local.xml

@@ -3,11 +3,11 @@
   <groupId>com.theoplayer.theoplayer-sdk-android</groupId>
   <artifactId>ads-wrapper</artifactId>
   <versioning>
-    <latest>4.3.0</latest>
-    <release>4.3.0</release>
+    <latest>4.8.0</latest>
+    <release>4.8.0</release>
     <versions>
-      <version>4.3.0</version>
+      <version>4.8.0</version>
     </versions>
-    <lastUpdated>20221118111544</lastUpdated>
+    <lastUpdated>20230217111544</lastUpdated>
   </versioning>
 </metadata>

package/android/src/main/AndroidManifest.xml

@@ -1,6 +1,51 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-          package="com.theoplayer">
+  package="com.theoplayer">
 
+  <!--
+    In order to play online streams or ads it is needed to add permissions below.
+    Protection level: normal.
+  -->
+  <uses-permission android:name="android.permission.INTERNET" />
+
+  <!--
+    Allows using PowerManager WakeLocks to keep processor from sleeping or screen from dimming.
+    Protection level: normal
+   -->
   <uses-permission android:name="android.permission.WAKE_LOCK" />
 
+  <!--
+    Allows a regular application to use Service.startForeground.
+    Protection level: normal
+    -->
+  <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
+
+  <!--
+    Allows an app to post notifications.
+    Protection level: dangerous
+    -->
+  <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
+
+  <application>
+
+    <!-- Allow background audio playback by registering this service. -->
+    <service
+      android:name="com.theoplayer.audio.MediaPlaybackService"
+      android:description="@string/background_playback_service_description"
+      android:exported="false"
+      android:foregroundServiceType="mediaPlayback">
+      <intent-filter>
+        <action android:name="android.media.browse.MediaBrowserService" />
+        <action android:name="android.intent.action.MEDIA_BUTTON" />
+      </intent-filter>
+    </service>
+
+    <receiver android:name="androidx.media.session.MediaButtonReceiver"
+      android:exported="false">
+      <intent-filter>
+        <action android:name="android.intent.action.MEDIA_BUTTON" />
+      </intent-filter>
+    </receiver>
+
+  </application>
+
 </manifest>

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

@@ -9,6 +9,7 @@ import com.theoplayer.android.api.ads.AdPreloadType
 import com.theoplayer.android.api.ads.GoogleImaConfiguration
 import com.theoplayer.android.api.cast.CastStrategy
 import com.google.android.gms.cast.framework.CastContext
+import com.theoplayer.android.api.pip.PipConfiguration
 
 private const val TAG = "PlayerConfigAdapter"
 private const val PROP_ADS_CONFIGURATION = "ads"
@@ -26,7 +27,7 @@ private const val PROP_CHROMECAST_APPID = "appID"
 
 object PlayerConfigAdapter {
 
-  fun fromProps(configProps: ReadableMap?): THEOplayerConfig {
+  fun theoConfigFromProps(configProps: ReadableMap?): THEOplayerConfig {
     val configBuilder = THEOplayerConfig.Builder()
     if (configProps != null) {
       val adsConfig = adsConfigurationFromProps(configProps.getMap(PROP_ADS_CONFIGURATION))
@@ -45,6 +46,7 @@ object PlayerConfigAdapter {
         configBuilder.chromeless(configProps.getBoolean(PROP_CHROMELESS))
       }
       applyCastConfigurationFromProps(configBuilder, configProps.getMap(PROP_CAST_CONFIGURATION))
+      configBuilder.pipConfiguration(PipConfiguration.Builder().build())
     }
     return configBuilder.build()
   }