Merge pull request #707 from THEOplayer/OPTI-658-millicast-config-react-native

Expose webrtc in TheoLiveSource on iOS/Android

Author: Yousif-CS

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 
 - Added `useExperimentalPipeline` to `CastConfiguration` for iOS, that controls the usage of an experimental, alternative implementation of the chromecast pipeline with a different feature set.
+- Added a webrtc configuration property `webrtc` in `TheoLiveSource`, to enable configuring the playout delay for Millicast streams consumed through OptiVew Live.
 
 ## [10.6.0] - 25-12-02
 

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

@@ -24,7 +24,9 @@ import com.theoplayer.android.api.cmcd.CMCDTransmissionMode
 import com.theoplayer.android.api.error.ErrorCode
 import com.theoplayer.android.api.source.AdIntegration
 import com.theoplayer.android.api.source.dash.DashPlaybackConfiguration
+import com.theoplayer.android.api.theolive.PlayoutDelay
 import com.theoplayer.android.api.theolive.TheoLiveSource
+import com.theoplayer.android.api.theolive.WebRTCOptions
 import com.theoplayer.cmcd.CmcdTransmissionMode
 import com.theoplayer.drm.ContentProtectionAdapter
 import com.theoplayer.latency.parseLatencyConfiguration
@@ -72,6 +74,10 @@ private const val PROP_SSE_ENDPOINT = "sseEndpoint"
 private const val PROP_STREAM_ACTIVITY_MONITOR_ID = "streamActivityMonitorId"
 private const val PROP_LATENCY_CONFIGURATION = "latencyConfiguration"
 private const val PROP_PROFILE = "profile"
+private const val PROP_WEBRTC: String = "webrtc"
+private const val PROP_PLAYOUT_DELAY: String = "playoutDelayMs"
+private const val PROP_PLAYOUT_DELAY_MIN: String = "minimum"
+private const val PROP_PLAYOUT_DELAY_MAX: String = "maximum"
 
 private const val ERROR_IMA_NOT_ENABLED = "Google IMA support not enabled."
 private const val ERROR_THEOADS_NOT_ENABLED = "THEOads support not enabled."
@@ -183,10 +189,23 @@ class SourceAdapter {
       drm=jsonTypedSource.optJSONObject(PROP_CONTENT_PROTECTION)?.let {
         ContentProtectionAdapter.drmConfigurationFromJson(it)
       },
-      profile=jsonTypedSource.optString(PROP_PROFILE)
+      profile=jsonTypedSource.optString(PROP_PROFILE),
+      webrtc=parseWebRTCOptions(jsonTypedSource)
     )
   }
 
+  @Throws(THEOplayerException::class)
+  private fun parseWebRTCOptions(jsonWebrtcOptions: JSONObject): WebRTCOptions? {
+    val webrtc = jsonWebrtcOptions.optJSONObject(PROP_WEBRTC)
+    val playoutDelay = webrtc?.optJSONObject(PROP_PLAYOUT_DELAY)
+    val playoutDelayMin = playoutDelay?.optInt(PROP_PLAYOUT_DELAY_MIN)
+    val playoutDelayMax = playoutDelay?.optInt(PROP_PLAYOUT_DELAY_MAX)
+
+    if (playoutDelayMin == null || playoutDelayMax == null) return null
+
+    return WebRTCOptions(playoutDelayMs = PlayoutDelay(playoutDelayMin, playoutDelayMax))
+  }
+
   @Throws(THEOplayerException::class)
   private fun parseTypedSource(jsonTypedSource: JSONObject, cmcdTransmissionMode: CMCDTransmissionMode? = null): TypedSource {
     // Property `integration` will be replaced with `type`.

ios/theolive/THEOplayerRCTSourceDescriptionBuilder+Theolive.swift

@@ -9,9 +9,22 @@ import THEOplayerTHEOliveIntegration
 #endif
 
 let SD_PROP_PROFILE: String = "profile"
+let SD_PROP_WEBRTC: String = "webrtc"
+let SD_PROP_PLAYOUT_DELAY: String = "playoutDelayMs"
+let SD_PROP_PLAYOUT_DELAY_MIN: String = "minimum"
+let SD_PROP_PLAYOUT_DELAY_MAX: String = "maximum"
 
 extension THEOplayerRCTSourceDescriptionBuilder {
 
+    private static func buildWebrtcOptions(_ theoliveData: [String: Any]) -> WebrtcOptions? {
+          let webrtc = theoliveData[SD_PROP_WEBRTC] as? NSDictionary
+          let playoutDelay = webrtc?[SD_PROP_PLAYOUT_DELAY] as? NSDictionary
+          let playoutDelayMin = playoutDelay?[SD_PROP_PLAYOUT_DELAY_MIN] as? Int
+          let playoutDelayMax = playoutDelay?[SD_PROP_PLAYOUT_DELAY_MAX] as? Int
+          guard let playoutDelayMin, let playoutDelayMax else { return nil }
+          return WebrtcOptions(playoutDelayMs: PlayoutDelay(minimum: playoutDelayMin, maximum: playoutDelayMax))
+    }
+  
     /**
      Builds a THEOplayer SourceDescription that can be passed as a source for the THEOplayer.
      - returns: a THEOlive TypedSource.
@@ -20,7 +33,8 @@ extension THEOplayerRCTSourceDescriptionBuilder {
 #if canImport(THEOplayerTHEOliveIntegration)
       if let src = theoliveData[SD_PROP_SRC] as? String {
           let profile = theoliveData[SD_PROP_PROFILE] as? String;
-          return TheoLiveSource(channelId: src, drm: contentProtection, profile: profile)
+          let webrtc = buildWebrtcOptions(theoliveData)
+          return TheoLiveSource(channelId: src, drm: contentProtection, profile: profile, webrtc: webrtc)
       }
 #endif
         return nil

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-theoplayer",
-  "version": "10.6.1",
+  "version": "10.7.0",
   "description": "A THEOplayer video component for react-native.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

react-native-theoplayer.podspec

@@ -43,37 +43,37 @@ Pod::Spec.new do |s|
 
   # THEOplayer Dependency
   puts "Adding THEOplayerSDK-core"
-  s.dependency "THEOplayerSDK-core", "~> 10.6"
+  s.dependency "THEOplayerSDK-core", "~> 10.7"
 
   # THEOlive Dependency
   puts "Adding THEOplayer-Integration-THEOlive"
-  s.dependency "THEOplayer-Integration-THEOlive", "~> 10.6"
+  s.dependency "THEOplayer-Integration-THEOlive", "~> 10.7"
 
   # Feature based integration dependencies
   if theofeatures.include?("GOOGLE_IMA")
 	puts "Adding THEOplayer-Integration-GoogleIMA"
-    s.dependency "THEOplayer-Integration-GoogleIMA", "~> 10.6"
+    s.dependency "THEOplayer-Integration-GoogleIMA", "~> 10.7"
   end
 
   if theofeatures.include?("CHROMECAST")
 	puts "Adding THEOplayer-Integration-GoogleCast"
-    s.ios.dependency "THEOplayer-Integration-GoogleCast", "~> 10.6"
+    s.ios.dependency "THEOplayer-Integration-GoogleCast", "~> 10.7"
   end
 
   if theofeatures.include?("THEO_ADS")
 	puts "Adding THEOplayer-Integration-THEOads"
-    s.dependency "THEOplayer-Integration-THEOads", "~> 10.6"
+    s.dependency "THEOplayer-Integration-THEOads", "~> 10.7"
   end
 
   if theofeatures.include?("MILLICAST")
   puts "Adding THEOplayer-Integration-Millicast"
-    s.dependency "THEOplayer-Integration-Millicast", "~> 10.6"
+    s.dependency "THEOplayer-Integration-Millicast", "~> 10.7"
   end
 
   # Feature based connector dependencies
   if theofeatures.include?("SIDELOADED_TEXTTRACKS")
 	puts "Adding THEOplayer-Connector-SideloadedSubtitle"
-    s.dependency "THEOplayer-Connector-SideloadedSubtitle", "~> 10.6"
+    s.dependency "THEOplayer-Connector-SideloadedSubtitle", "~> 10.7"
   end
 
 end

src/api/theolive/TheoLiveEndpoint.ts

@@ -1,8 +1,11 @@
+import { WebrtcOptions } from "./WebrtcOptions";
+
 export interface EndpointMillicastSource {
   name: string;
   accountId: string;
   subscriberToken?: string;
   directorUrl?: string;
+  webrtc?: WebrtcOptions
 }
 
 /**

src/api/theolive/TheoLiveSource.ts

@@ -1,4 +1,5 @@
 import { SourceIntegrationId, TypedSource } from 'react-native-theoplayer';
+import { WebrtcOptions } from './WebrtcOptions';
 
 /**
  * Represents a source for the THEOlive integration.
@@ -21,4 +22,9 @@ export interface TheoLiveSource extends TypedSource {
      * The profile identifier is included as a query parameter in the discovery request to obtain a response specific to that profile.
      */
     profile?: string;
+
+    /**
+     * WebRTC configuration for a THEOlive Millicast source.
+     */
+    webrtc?: WebrtcOptions;
 }

src/api/theolive/WebrtcOptions.ts

@@ -0,0 +1,28 @@
+
+/**
+ * Webrtc playout delay configuration.
+ * 
+ * This is used to configure the playout delay for a Millicast Source. This hints Webrtc 
+ * to increase the jitter buffer size.
+ *
+ * @category THEOlive
+ * @remark This is a hint, and factors like network jitter and audio/video sync latency affect the actual delay applied.
+ * @public
+ */
+export interface WebrtcPlayoutDelay {
+  minimum: number;
+  maximum: number;
+}
+
+/**
+ * WebRTC configuration for a THEOlive Millicast source.
+ *
+ * @category THEOlive
+ * @public
+ */
+export interface WebrtcOptions {
+  /**
+   * Webrtc playout delay configuration for the Webrtc media.
+   */
+  playoutDelayMs?: WebrtcPlayoutDelay;
+}