Casting support

CHANGELOG.md

@@ -7,6 +7,7 @@
 - `DefaultMetadata` for configuration of the bundled analytics collector
 - `Player.analytics` to access the `AnalyticsApi` and interact with the bundled analytics collector
 - `SourceConfig.analyticsSourceMetadata` for extended configuration of the bundled analytics collector
+- Google Cast SDK support for Android and iOS
 
 ### Changed
 

android/src/main/java/com/bitmovin/player/reactnative/BitmovinCastManagerModule.kt

@@ -0,0 +1,76 @@
+package com.bitmovin.player.reactnative
+
+import com.bitmovin.player.casting.BitmovinCastManager
+import com.bitmovin.player.reactnative.converter.JsonConverter
+import com.facebook.react.bridge.Promise
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.bridge.ReactContextBaseJavaModule
+import com.facebook.react.bridge.ReactMethod
+import com.facebook.react.bridge.ReadableMap
+import com.facebook.react.module.annotations.ReactModule
+import com.facebook.react.uimanager.UIManagerModule
+
+private const val MODULE_NAME = "BitmovinCastManagerModule"
+
+@ReactModule(name = MODULE_NAME)
+class BitmovinCastManagerModule(
+    private val context: ReactApplicationContext,
+) : ReactContextBaseJavaModule(context) {
+    override fun getName() = MODULE_NAME
+
+    /**
+     * Returns whether the [BitmovinCastManager] is initialized.
+     */
+    @ReactMethod
+    fun isInitialized(promise: Promise) = uiManager?.addUIBlock {
+        promise.resolve(BitmovinCastManager.isInitialized())
+    }
+
+    /**
+     * Initializes the [BitmovinCastManager] with the given options.
+     */
+    @ReactMethod
+    fun initializeCastManager(options: ReadableMap?, promise: Promise) {
+        val castOptions = JsonConverter.toCastOptions(options)
+        uiManager?.addUIBlock {
+            BitmovinCastManager.initialize(
+                castOptions?.applicationId,
+                castOptions?.messageNamespace
+            )
+            promise.resolve(null)
+        }
+    }
+
+    /**
+     * Sends a message to the receiver.
+     */
+    @ReactMethod
+    fun sendMessage(message: String, messageNamespace: String?, promise: Promise) {
+        uiManager?.addUIBlock {
+            BitmovinCastManager.getInstance().sendMessage(message, messageNamespace)
+            promise.resolve(null)
+        }
+    }
+
+    /**
+     * Updates the context of the [BitmovinCastManager] to the current activity.
+     */
+    @ReactMethod
+    fun updateContext(promise: Promise) {
+        uiManager?.addUIBlock {
+            BitmovinCastManager.getInstance().updateContext(currentActivity)
+            promise.resolve(null)
+        }
+    }
+
+    private val uiManager: UIManagerModule?
+        get() = context.getNativeModule(UIManagerModule::class.java)
+}
+
+/**
+ * Represents configuration options for the [BitmovinCastManager].
+ */
+data class BitmovinCastManagerOptions(
+    val applicationId: String? = null,
+    val messageNamespace: String? = null,
+)

android/src/main/java/com/bitmovin/player/reactnative/PlayerModule.kt

@@ -4,6 +4,7 @@ import android.util.Log
 import com.bitmovin.analytics.api.DefaultMetadata
 import com.bitmovin.player.api.Player
 import com.bitmovin.player.api.analytics.create
+import com.bitmovin.player.api.event.PlayerEvent
 import com.bitmovin.player.reactnative.converter.JsonConverter
 import com.facebook.react.bridge.*
 import com.facebook.react.module.annotations.ReactModule
@@ -496,6 +497,48 @@ class PlayerModule(private val context: ReactApplicationContext) : ReactContextB
         }
     }
 
+    /**
+     * Initiates casting the current video to a cast-compatible remote device. The user has to choose to which device it
+     * should be sent.
+     */
+    @ReactMethod
+    fun castVideo(nativeId: NativeId) {
+        uiManager()?.addUIBlock {
+            players[nativeId]?.castVideo()
+        }
+    }
+
+    /**
+     * Stops casting the current video. Has no effect if [isCasting] is false.
+     */
+    @ReactMethod
+    fun castStop(nativeId: NativeId) {
+        uiManager()?.addUIBlock {
+            players[nativeId]?.castStop()
+        }
+    }
+
+    /**
+     * Whether casting to a cast-compatible remote device is available. [PlayerEvent.CastAvailable] signals when
+     * casting becomes available.
+     */
+    @ReactMethod
+    fun isCastAvailable(nativeId: NativeId, promise: Promise) {
+        uiManager()?.addUIBlock {
+            promise.resolve(players[nativeId]?.isCastAvailable)
+        }
+    }
+
+    /**
+     * Whether video is currently being casted to a remote device and not played locally.
+     */
+    @ReactMethod
+    fun isCasting(nativeId: NativeId, promise: Promise) {
+        uiManager()?.addUIBlock {
+            promise.resolve(players[nativeId]?.isCasting)
+        }
+    }
+
     /**
      * Helper function that returns the initialized `UIManager` instance.
      */

android/src/main/java/com/bitmovin/player/reactnative/RNPlayerView.kt

@@ -62,6 +62,18 @@ private val EVENT_CLASS_TO_REACT_NATIVE_NAME_MAPPING = mapOf(
     PlayerEvent.AdSkipped::class to "adSkipped",
     PlayerEvent.AdStarted::class to "adStarted",
     PlayerEvent.VideoPlaybackQualityChanged::class to "videoPlaybackQualityChanged",
+    PlayerEvent.CastStart::class to "castStart",
+    @Suppress("DEPRECATION")
+    PlayerEvent.CastPlaybackFinished::class to "castPlaybackFinished",
+    @Suppress("DEPRECATION")
+    PlayerEvent.CastPaused::class to "castPaused",
+    @Suppress("DEPRECATION")
+    PlayerEvent.CastPlaying::class to "castPlaying",
+    PlayerEvent.CastStarted::class to "castStarted",
+    PlayerEvent.CastAvailable::class to "castAvailable",
+    PlayerEvent.CastStopped::class to "castStopped",
+    PlayerEvent.CastWaitingForDevice::class to "castWaitingForDevice",
+    PlayerEvent.CastTimeUpdated::class to "castTimeUpdated",
 )
 
 private val EVENT_CLASS_TO_REACT_NATIVE_NAME_MAPPING_UI = mapOf<KClass<out Event>, String>(

android/src/main/java/com/bitmovin/player/reactnative/RNPlayerViewManager.kt

@@ -113,6 +113,15 @@ class RNPlayerViewManager(private val context: ReactApplicationContext) : Simple
         "fullscreenDisabled" to "onFullscreenDisabled",
         "fullscreenEnter" to "onFullscreenEnter",
         "fullscreenExit" to "onFullscreenExit",
+        "castStart" to "onCastStart",
+        "castPlaybackFinished" to "onCastPlaybackFinished",
+        "castPaused" to "onCastPaused",
+        "castPlaying" to "onCastPlaying",
+        "castStarted" to "onCastStarted",
+        "castAvailable" to "onCastAvailable",
+        "castStopped" to "onCastStopped",
+        "castWaitingForDevice" to "onCastWaitingForDevice",
+        "castTimeUpdated" to "onCastTimeUpdated",
     )
 
     /**

android/src/main/java/com/bitmovin/player/reactnative/RNPlayerViewPackage.kt

@@ -27,7 +27,8 @@ class RNPlayerViewPackage : ReactPackage {
             PlayerAnalyticsModule(reactContext),
             RNPlayerViewManager(reactContext),
             FullscreenHandlerModule(reactContext),
-            CustomMessageHandlerModule(reactContext)
+            CustomMessageHandlerModule(reactContext),
+            BitmovinCastManagerModule(reactContext),
         )
     }
 

android/src/main/java/com/bitmovin/player/reactnative/SourceModule.kt

@@ -46,13 +46,15 @@ class SourceModule(private val context: ReactApplicationContext) : ReactContextB
      * @param nativeId ID to be associated with the `Source` instance.
      * @param drmNativeId ID of the DRM config to use.
      * @param config `SourceConfig` object received from JS.
+     * @param sourceRemoteControlConfig `SourceRemoteControlConfig` object received from JS. Not supported on Android.
      * @param analyticsSourceMetadata `SourceMetadata` object received from JS.
      */
     @ReactMethod
     fun initWithAnalyticsConfig(
         nativeId: NativeId,
         drmNativeId: NativeId?,
         config: ReadableMap?,
+        sourceRemoteControlConfig: ReadableMap?,
         analyticsSourceMetadata: ReadableMap?
     ) {
         uiManager()?.addUIBlock {
@@ -69,12 +71,14 @@ class SourceModule(private val context: ReactApplicationContext) : ReactContextB
      * @param nativeId ID to be associated with the `Source` instance.
      * @param drmNativeId ID of the DRM config to use.
      * @param config `SourceConfig` object received from JS.
+     * @param sourceRemoteControlConfig `SourceRemoteControlConfig` object received from JS. Not supported on Android.
      */
     @ReactMethod
     fun initWithConfig(
         nativeId: NativeId,
         drmNativeId: NativeId?,
         config: ReadableMap?,
+        sourceRemoteControlConfig: ReadableMap?
     ) {
         uiManager()?.addUIBlock {
             initializeSource(nativeId, drmNativeId, config) { sourceConfig ->

android/src/main/java/com/bitmovin/player/reactnative/converter/JsonConverter.kt

@@ -18,9 +18,11 @@ import com.bitmovin.player.api.advertising.AdQuartile
 import com.bitmovin.player.api.advertising.AdSource
 import com.bitmovin.player.api.advertising.AdSourceType
 import com.bitmovin.player.api.advertising.AdvertisingConfig
+import com.bitmovin.player.api.casting.RemoteControlConfig
 import com.bitmovin.player.api.drm.WidevineConfig
 import com.bitmovin.player.api.event.PlayerEvent
 import com.bitmovin.player.api.event.SourceEvent
+import com.bitmovin.player.api.event.data.CastPayload
 import com.bitmovin.player.api.event.data.SeekPosition
 import com.bitmovin.player.api.media.AdaptationConfig
 import com.bitmovin.player.api.media.audio.AudioTrack
@@ -37,8 +39,10 @@ import com.bitmovin.player.api.source.SourceType
 import com.bitmovin.player.api.source.TimelineReferencePoint
 import com.bitmovin.player.api.ui.ScalingMode
 import com.bitmovin.player.api.ui.StyleConfig
+import com.bitmovin.player.reactnative.BitmovinCastManagerOptions
 import com.bitmovin.player.reactnative.extensions.getBooleanOrNull
 import com.bitmovin.player.reactnative.extensions.getName
+import com.bitmovin.player.reactnative.extensions.getOrDefault
 import com.bitmovin.player.reactnative.extensions.getProperty
 import com.bitmovin.player.reactnative.extensions.putBoolean
 import com.bitmovin.player.reactnative.extensions.putDouble
@@ -96,9 +100,67 @@ class JsonConverter {
                     playerConfig.adaptationConfig = it
                 }
             }
+            if (json.hasKey("remoteControlConfig")) {
+                toRemoteControlConfig(json.getMap("remoteControlConfig"))?.let {
+                    playerConfig.remoteControlConfig = it
+                }
+            }
             return playerConfig
         }
 
+        /**
+         * Converts an arbitrary [ReadableMap] to a [RemoteControlConfig].
+         *
+         * @param json JS object representing the [RemoteControlConfig].
+         * @return The generated [RemoteControlConfig].
+         */
+        private fun toRemoteControlConfig(json: ReadableMap?): RemoteControlConfig? {
+            if (json == null) return null
+            val defaultRemoteControlConfig = RemoteControlConfig()
+
+            val receiverStylesheetUrl = json.getOrDefault(
+                "receiverStylesheetUrl",
+                defaultRemoteControlConfig.receiverStylesheetUrl
+            )
+
+            var customReceiverConfig = defaultRemoteControlConfig.customReceiverConfig
+            if (json.hasKey("customReceiverConfig")) {
+                customReceiverConfig = json.getMap("customReceiverConfig")
+                    ?.toHashMap()
+                    ?.mapValues { entry -> entry.value as String } ?: emptyMap()
+            }
+
+            val isCastEnabled = json.getOrDefault(
+                "isCastEnabled",
+                defaultRemoteControlConfig.isCastEnabled
+            )
+
+            val sendManifestRequestsWithCredentials = json.getOrDefault(
+                "sendManifestRequestsWithCredentials",
+                defaultRemoteControlConfig.sendManifestRequestsWithCredentials
+            )
+
+            val sendSegmentRequestsWithCredentials = json.getOrDefault(
+                "sendSegmentRequestsWithCredentials",
+                defaultRemoteControlConfig.sendSegmentRequestsWithCredentials
+            )
+
+            val sendDrmLicenseRequestsWithCredentials = json.getOrDefault(
+                "sendDrmLicenseRequestsWithCredentials",
+                defaultRemoteControlConfig.sendDrmLicenseRequestsWithCredentials
+            )
+
+
+            return RemoteControlConfig(
+                receiverStylesheetUrl = receiverStylesheetUrl,
+                customReceiverConfig = customReceiverConfig,
+                isCastEnabled = isCastEnabled,
+                sendManifestRequestsWithCredentials = sendManifestRequestsWithCredentials,
+                sendSegmentRequestsWithCredentials = sendSegmentRequestsWithCredentials,
+                sendDrmLicenseRequestsWithCredentials = sendDrmLicenseRequestsWithCredentials,
+            )
+        }
+
         /**
          * Converts an arbitrary `json` to `SourceOptions`.
          * @param json JS object representing the `SourceOptions`.
@@ -123,7 +185,7 @@ class JsonConverter {
             "end" -> TimelineReferencePoint.End
             else -> null
         }
-        
+
         /**
          * Converts an arbitrary `json` to `AdaptationConfig`.
          * @param json JS object representing the `AdaptationConfig`.
@@ -564,13 +626,34 @@ class JsonConverter {
                     json.putMap("oldVideoQuality", fromVideoQuality(event.oldVideoQuality))
                 }
 
+                is PlayerEvent.CastWaitingForDevice -> {
+                    json.putMap("castPayload", fromCastPayload(event.castPayload))
+                }
+
+                is PlayerEvent.CastStarted -> {
+                    json.putString("deviceName", event.deviceName)
+                }
+
                 else -> {
                     // Event is not supported yet or does not have any additional data
                 }
             }
             return json
         }
 
+        /**
+         * Converts an arbitrary `json` into [BitmovinCastManagerOptions].
+         * @param json JS object representing the [BitmovinCastManagerOptions].
+         * @return The generated [BitmovinCastManagerOptions] if successful, `null` otherwise.
+         */
+        fun toCastOptions(json: ReadableMap?): BitmovinCastManagerOptions? {
+            if (json == null) return null
+            return BitmovinCastManagerOptions(
+                json.getOrDefault("applicationId", null),
+                json.getOrDefault("messageNamespace", null)
+            )
+        }
+
         /**
          * Converts an arbitrary `json` to `WidevineConfig`.
          * @param json JS object representing the `WidevineConfig`.
@@ -1008,3 +1091,12 @@ class JsonConverter {
         }
     }
 }
+
+/**
+ * Converts a [CastPayload] object into its JS representation.
+ */
+private fun fromCastPayload(castPayload: CastPayload) = Arguments.createMap().apply {
+    putDouble("currentTime", castPayload.currentTime)
+    putString("deviceName", castPayload.deviceName)
+    putString("type", castPayload.type)
+}

android/src/main/java/com/bitmovin/player/reactnative/extensions/ReadableMapExtension.kt

@@ -5,3 +5,21 @@ import com.facebook.react.bridge.ReadableMap
 fun ReadableMap.getBooleanOrNull(
     key: String
 ): Boolean? = takeIf { hasKey(key) }?.getBoolean(key)
+
+/**
+ * Reads the [Boolean] value from the given [ReadableMap] if the [key] is present.
+ * Returns the [default] value otherwise.
+ */
+fun ReadableMap.getOrDefault(
+    key: String,
+    default: Boolean,
+) = if (hasKey(key)) getBoolean(key) else default
+
+/**
+ * Reads the [String] value from the given [ReadableMap] if the [key] is present.
+ * Returns the [default] value otherwise.
+ */
+fun ReadableMap.getOrDefault(
+    key: String,
+    default: String?,
+) = if (hasKey(key)) getString(key) else default

example/README.md

@@ -14,6 +14,7 @@ inside the [`src/screens/`](https://github.com/bitmovin/bitmovin-player-react-na
 - [Basic Analytics](https://github.com/bitmovin/bitmovin-player-react-native/blob/development/example/src/screens/BasicAnalytics.tsx)
 - [Basic Offline Playback](https://github.com/bitmovin/bitmovin-player-react-native/blob/development/example/src/screens/OfflinePlayback.tsx) (iOS and Android only)
 - [System UI](https://github.com/bitmovin/bitmovin-player-react-native/blob/development/example/src/screens/SystemUi.tsx) (iOS and tvOS only)
+- [Casting](https://github.com/bitmovin/bitmovin-player-react-native/blob/development/example/src/screens/Casting.tsx) (iOS and Android only)
 
 ### Custom asset playback