react-native-theoplayer 3.0.2 → 3.2.0

package/src/api/track/DateRangeCue.ts

@@ -0,0 +1,74 @@
+import type { TextTrackCue } from './TextTrackCue';
+
+/**
+ * Represents a cue of a HLS date range metadata text track.
+ *
+ * @public
+ */
+export interface DateRangeCue extends TextTrackCue {
+  /**
+   * The class of the date range cue.
+   *
+   * @remarks
+   * <br/> - The class is a client-defined string specifying a set of attributes with associated value semantics.
+   */
+  class: string | undefined;
+
+  /**
+   * The playback position at which the date range cue becomes active, as a Date.
+   */
+  startDate: Date;
+
+  /**
+   * The playback position at which the date range cue becomes inactive, as a Date.
+   */
+  endDate: Date | undefined;
+
+  /**
+   * The duration of the date range cue, in milliseconds.
+   */
+  duration: number | undefined;
+
+  /**
+   * The planned duration of the date range cue, in milliseconds.
+   *
+   * @remarks
+   * <br/> - This is used when the exact duration is not known yet.
+   */
+  plannedDuration: number | undefined;
+
+  /**
+   * Whether end-on-next is enabled for the date range cue.
+   *
+   * @remarks
+   * <br/> - End-on-next results in the {@link DateRangeCue.endDate} of the date range cue becoming equal to the {@link DateRangeCue.startDate} of the next date range cue with the same {@link DateRangeCue."class"}, once it is known.
+   */
+  endOnNext: boolean;
+
+  /**
+   * The SCTE 'cmd' splice_info_section of the date range cue.
+   */
+  scte35Cmd: ArrayBuffer | undefined;
+
+  /**
+   * The SCTE 'out' splice_info_section of the date range cue.
+   */
+  scte35Out: ArrayBuffer | undefined;
+
+  /**
+   * The SCTE 'in' splice_info_section of the date range cue.
+   */
+  scte35In: ArrayBuffer | undefined;
+
+  /**
+   * Custom attributes extracted from the cue source.
+   */
+  customAttributes: Record<string, string | number | ArrayBuffer>;
+}
+
+/**
+ * Check whether a text track cue is of type DateRangeCue.
+ */
+export function isDateRangeCue(cue: TextTrackCue): cue is DateRangeCue {
+  return (cue as DateRangeCue).customAttributes != undefined;
+}

package/src/api/track/TextTrack.ts

@@ -7,6 +7,8 @@ export enum TextTrackType {
   srt = 'srt',
   ttml = 'ttml',
   webvtt = 'webvtt',
+  daterange = 'daterange',
+  eventstream = 'eventstream',
 }
 
 export enum TextTrackKind {
@@ -65,6 +67,7 @@ export interface TextTrack extends Track {
    * The mode of the text track, represented by a value from the following list:
    * <br/> - `'disabled'`: The track is disabled.
    * <br/> - `'showing'`: The track is showing.
+   * <br/> - `'hidden'`: The track is enabled and loading cues, but not shown. (used for metadata tracks)
    */
   mode: TextTrackMode;
 

package/src/api/track/barrel.ts

@@ -4,3 +4,4 @@ export * from './TextTrack';
 export * from './TextTrackCue';
 export * from './Track';
 export * from './TextTrackStyle';
+export * from './DateRangeCue';

package/src/internal/THEOplayerView.tsx

@@ -11,7 +11,7 @@ import {
   View,
   ViewStyle,
 } from 'react-native';
-import type { PlayerConfiguration, PlayerError, THEOplayerViewProps } from 'react-native-theoplayer';
+import { isDateRangeCue, PlayerConfiguration, PlayerError, TextTrackCue, THEOplayerViewProps } from 'react-native-theoplayer';
 import { CastEventType, PlayerEventType } from 'react-native-theoplayer';
 
 import styles from './THEOplayerView.style';
@@ -254,12 +254,28 @@ export class THEOplayerView extends PureComponent<React.PropsWithChildren<THEOpl
     const nativeEvent = event.nativeEvent;
     const cue = nativeEvent.cue;
     if (cue) {
-      cue.startTime = decodeNanInf(cue.startTime);
-      cue.endTime = decodeNanInf(cue.endTime);
+      this.normalizeCue(cue);
     }
     this._facade.dispatchEvent(new DefaultTextTrackEvent(toTextTrackEventType(nativeEvent.type), nativeEvent.trackUid, cue));
   };
 
+  private normalizeCue(cue: TextTrackCue) {
+    cue.startTime = decodeNanInf(cue.startTime);
+    cue.endTime = decodeNanInf(cue.endTime);
+    if (isDateRangeCue(cue)) {
+      cue.startDate = new Date(cue.startDate);
+      if (cue.endDate) {
+        cue.endDate = new Date(cue.endDate);
+      }
+      if (cue.duration) {
+        cue.duration = decodeNanInf(cue.duration);
+      }
+      if (cue.plannedDuration) {
+        cue.plannedDuration = decodeNanInf(cue.plannedDuration);
+      }
+    }
+  }
+
   private _onMediaTrackListEvent = (event: NativeSyntheticEvent<NativeMediaTrackListEvent>) => {
     const nativeEvent = event.nativeEvent;
     this._facade.dispatchEvent(

package/src/internal/adapter/THEOplayerAdapter.ts

@@ -142,6 +142,9 @@ export class THEOplayerAdapter extends DefaultEventDispatcher<PlayerEventMap> im
     this._state.selectedAudioTrack = event.selectedAudioTrack;
     this._state.selectedVideoTrack = event.selectedVideoTrack;
     this._state.selectedTextTrack = event.selectedTextTrack;
+    if (isFinite(this._state.duration)) {
+      this._state.seekable = [{start: 0, end: this._state.duration}];
+    }
   };
 
   private onDurationChange = (event: DurationChangeEvent) => {
@@ -388,7 +391,7 @@ export class THEOplayerAdapter extends DefaultEventDispatcher<PlayerEventMap> im
       return;
     }
     this._state.selectedAudioTrack = trackUid;
-    NativeModules.PlayerModule.setSelectedAudioTrack(this._view.nativeHandle, trackUid || -1);
+    NativeModules.PlayerModule.setSelectedAudioTrack(this._view.nativeHandle, (trackUid !== undefined) ? trackUid : -1);
   }
 
   get videoTracks(): MediaTrack[] {
@@ -405,7 +408,7 @@ export class THEOplayerAdapter extends DefaultEventDispatcher<PlayerEventMap> im
     }
     this._state.selectedVideoTrack = trackUid;
     this._state.targetVideoQuality = undefined;
-    NativeModules.PlayerModule.setSelectedVideoTrack(this._view.nativeHandle, trackUid || -1);
+    NativeModules.PlayerModule.setSelectedVideoTrack(this._view.nativeHandle, (trackUid !== undefined) ? trackUid : -1);
   }
 
   get textTracks(): TextTrack[] {
@@ -428,7 +431,7 @@ export class THEOplayerAdapter extends DefaultEventDispatcher<PlayerEventMap> im
         track.mode = TextTrackMode.disabled;
       }
     });
-    NativeModules.PlayerModule.setSelectedTextTrack(this._view.nativeHandle, trackUid || -1);
+    NativeModules.PlayerModule.setSelectedTextTrack(this._view.nativeHandle, (trackUid !== undefined) ? trackUid : -1);
   }
 
   get textTrackStyle(): TextTrackStyle {

package/src/internal/adapter/WebEventForwarder.ts

@@ -26,6 +26,8 @@ import {
   PlayerEventType,
   PresentationMode,
   TextTrackEventType,
+  TextTrackKind,
+  TextTrackMode,
   TrackListEventType,
 } from 'react-native-theoplayer';
 import type { THEOplayerWebAdapter } from './THEOplayerWebAdapter';
@@ -251,6 +253,9 @@ export class WebEventForwarder {
 
   private readonly onAddTextTrack = (event: AddTrackEvent) => {
     const track = event.track as NativeTextTrack;
+    if (track.kind === TextTrackKind.metadata) {
+      track.mode = TextTrackMode.hidden;
+    }
     track.addEventListener('addcue', this.onAddTextTrackCue(track));
     track.addEventListener('removecue', this.onRemoveTextTrackCue(track));
     track.addEventListener('entercue', this.onEnterTextTrackCue(track));

package/src/internal/adapter/web/TrackUtils.ts

@@ -1,4 +1,5 @@
 import type {
+  DateRangeCue as NativeDateRangeCue,
   MediaTrack as NativeMediaTrack,
   MediaTrackList as NativeMediaTrackList,
   Quality as NativeQuality,
@@ -6,9 +7,13 @@ import type {
   TextTrackCue as NativeTextTrackCue,
   TextTracksList as NativeTextTrackList,
 } from 'theoplayer';
-import type { MediaTrack, TextTrack, TextTrackCue } from 'react-native-theoplayer';
+import type { MediaTrack, TextTrack, TextTrackCue, DateRangeCue } from 'react-native-theoplayer';
 import { decodeNanInf } from '../../utils/TypeUtils';
 
+export function isDateRangeCue(cue: TextTrackCue): cue is DateRangeCue {
+  return (cue as NativeDateRangeCue).customAttributes != undefined;
+}
+
 export function fromNativeCue(cue: NativeTextTrackCue): TextTrackCue {
   return {
     id: cue.id,
@@ -16,6 +21,18 @@ export function fromNativeCue(cue: NativeTextTrackCue): TextTrackCue {
     startTime: decodeNanInf(1e3 * cue.startTime),
     endTime: decodeNanInf(1e3 * cue.endTime),
     content: cue.content,
+    ...(isDateRangeCue(cue) && {
+      class: cue.class,
+      startDate: cue.startDate,
+      endDate: cue.endDate,
+      duration: cue.duration ? decodeNanInf(1e3 * cue.duration) : cue.duration,
+      plannedDuration: cue.plannedDuration ? decodeNanInf(1e3 * cue.plannedDuration) : cue.plannedDuration,
+      endOnNext: cue.endOnNext,
+      scte35Cmd: cue.scte35Cmd,
+      scte35Out: cue.scte35Out,
+      scte35In: cue.scte35In,
+      customAttributes: cue.customAttributes,
+    }),
   } as TextTrackCue;
 }