Add TextTrack.captionChannel

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Added support for player SDK v11. More info on the [migration documentation](./doc/migrating-to-react-native-theoplayer-11.md) page.
 - Enabled core library desugaring for Android to support version 3.39.0 of the Google IMA SDK.
+- Added `TextTrack.captionChannel` to retrieve the CEA-608 channel and/or CEA-708 service numbers of closed caption text tracks.
 
 ### Changed
 

android/build.gradle

@@ -92,6 +92,9 @@ android {
             minifyEnabled false
         }
     }
+    buildFeatures {
+        buildConfig true
+    }
     lint {
         disable 'GradleCompatible'
     }

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

@@ -26,6 +26,7 @@ private const val PROP_NAME = "name"
 private const val PROP_ENABLED = "enabled"
 private const val PROP_SRC = "src"
 private const val PROP_FORCED = "forced"
+private const val PROP_CAPTION_CHANNEL = "captionChannel"
 private const val PROP_AUDIO_SAMPLING_RATE = "audioSamplingRate"
 private const val PROP_BANDWIDTH = "bandwidth"
 private const val PROP_QUALITIES = "qualities"
@@ -69,6 +70,9 @@ object TrackListAdapter {
     textTrackPayload.putString(PROP_SRC, textTrack.source)
     textTrackPayload.putBoolean(PROP_FORCED, textTrack.isForced)
 
+    // THEOplayer v10.13+
+    textTrack.captionChannel?.let { textTrackPayload.putInt(PROP_CAPTION_CHANNEL, it) }
+
     // Optionally pass cue list.
     val cueList = textTrack.cues
     if (cueList != null) {

package.json

@@ -80,7 +80,7 @@
   "peerDependencies": {
     "react": "*",
     "react-native": "*",
-    "theoplayer": "^9.12.0 || ^10 || ^11"
+    "theoplayer": "^11"
   },
   "peerDependenciesMeta": {
     "theoplayer": {

src/api/track/TextTrack.ts

@@ -149,6 +149,18 @@ export interface TextTrack extends Track {
    * <br/> - For HLS: the corresponding #EXT-X-MEDIA tag contains the attributes TYPE=SUBTITLES and FORCED=YES (not supported yet)
    */
   readonly forced: boolean;
+
+  /**
+   * The closed caption service number of the text track.
+   *
+   * @platform web,android
+   *
+   * @remarks
+   * <br/> - For CEA-608 caption tracks, this holds the channel number.
+   * <br/> - For CEA-708 caption tracks, this holds the service number.
+   * <br/> - Otherwise, this is `undefined`.
+   */
+  readonly captionChannel?: number;
 }
 
 /**

src/internal/adapter/web/TrackUtils.ts

@@ -41,7 +41,7 @@ export function fromNativeTextTrackList(tracks: NativeTextTrackList): TextTrack[
 }
 
 export function fromNativeTextTrack(track: NativeTextTrack): TextTrack {
-  const { id, uid, kind, label, language, mode, type, src, forced } = track;
+  const { id, uid, kind, label, language, mode, type, src, forced, captionChannel } = track;
 
   return {
     id,
@@ -53,6 +53,7 @@ export function fromNativeTextTrack(track: NativeTextTrack): TextTrack {
     type,
     src,
     forced,
+    captionChannel,
     cues: track.cues ? track.cues.map((cue) => fromNativeCue(cue)) : [],
   } as TextTrack;
 }