react-native-theoplayer 9.4.0 → 9.6.0

package/src/api/source/ads/ssai/GoogleDAIConfiguration.ts

@@ -4,6 +4,9 @@ import type { ServerSideAdInsertionConfiguration } from './ServerSideAdInsertion
 /**
  * The identifier of the Google DAI integration.
  *
+ * @category Ads
+ * @category SSAI
+ * @category Source
  * @public
  */
 export type GoogleDAISSAIIntegrationID = 'google-dai';
@@ -13,6 +16,9 @@ export type GoogleDAISSAIIntegrationID = 'google-dai';
  * <br/> - `'live'`: The requested stream is a live stream.
  * <br/> - `'vod'`: The requested stream is a video-on-demand stream.
  *
+ * @category Ads
+ * @category SSAI
+ * @category Source
  * @public
  */
 export type DAIAvailabilityType = 'vod' | 'live';
@@ -20,6 +26,9 @@ export type DAIAvailabilityType = 'vod' | 'live';
 /**
  * Represents a configuration for server-side ad insertion with the Google DAI pre-integration.
  *
+ * @category Ads
+ * @category SSAI
+ * @category Source
  * @public
  */
 export interface GoogleDAIConfiguration extends ServerSideAdInsertionConfiguration {
@@ -83,6 +92,9 @@ export interface GoogleDAIConfiguration extends ServerSideAdInsertionConfigurati
 /**
  * Represents a configuration for server-side ad insertion with the Google DAI pre-integration for a Live media stream.
  *
+ * @category Ads
+ * @category SSAI
+ * @category Source
  * @public
  */
 export interface GoogleDAILiveConfiguration extends GoogleDAIConfiguration {
@@ -104,6 +116,9 @@ export interface GoogleDAILiveConfiguration extends GoogleDAIConfiguration {
 /**
  * Represents a configuration for server-side ad insertion with the Google DAI pre-integration for a VOD media stream.
  *
+ * @category Ads
+ * @category SSAI
+ * @category Source
  * @public
  */
 export interface GoogleDAIVodConfiguration extends GoogleDAIConfiguration {
@@ -133,6 +148,9 @@ export interface GoogleDAIVodConfiguration extends GoogleDAIConfiguration {
 /**
  * Represents a media resource with a Google DAI server-side ad insertion request.
  *
+ * @category Ads
+ * @category SSAI
+ * @category Source
  * @public
  */
 export interface GoogleDAITypedSource extends TypedSource {

package/src/api/source/ads/ssai/ServerSideAdInsertionConfiguration.ts

@@ -3,14 +3,26 @@ import type { GoogleDAISSAIIntegrationID } from './GoogleDAIConfiguration';
 /**
  * The identifier of a server-side ad insertion pre-integration, represented by a string value.
  *
+ * @category Ads
+ * @category SSAI
  * @public
  */
 export type SSAIIntegrationId = GoogleDAISSAIIntegrationID | CustomSSAIIntegrationId;
+
+/**
+ * The identifier of a custom server-side ad insertion, represented by a string value.
+ *
+ * @category Ads
+ * @category SSAI
+ * @public
+ */
 export type CustomSSAIIntegrationId = string;
 
 /**
  * Represents a configuration for server-side ad insertion (SSAI).
  *
+ * @category Ads
+ * @category SSAI
  * @public
  */
 export interface ServerSideAdInsertionConfiguration {

package/src/api/source/analytics/AnalyticsDescription.ts

@@ -1,6 +1,8 @@
 /**
  * Describes the configuration of an analytics integration as part of the SourceDescription.
  *
+ * @category Analytics
+ * @category Source
  * @public
  */
 export interface AnalyticsDescription {

package/src/api/source/cmcd/CmcdConfiguration.ts

@@ -1,6 +1,9 @@
 /**
  * The configuration for transmitting information to Content Delivery Networks (CDNs)
  * through Common Media Client Data (CMCD) (CTA-5004)
+ *
+ * @category Source
+ * @public
  */
 export interface CmcdConfiguration {
   /**
@@ -50,6 +53,12 @@ export interface CmcdConfiguration {
   transmissionMode: CmcdTransmissionMode
 }
 
+/**
+ * The CMCD transmission mode.
+ *
+ * @category Source
+ * @public
+ */
 export enum CmcdTransmissionMode {
   /**
    * Transmit CMCD data as a custom HTTP request header.

package/src/api/source/dash/DashPlaybackConfiguration.ts

@@ -8,6 +8,7 @@
  *                     Use this if you notice that the player never preloads the next period, even though you know that the current platform
  *                     should support it.
  *
+ * @category Source
  * @public
  */
 export type SeamlessPeriodSwitchStrategy = 'auto' | 'always' | 'never';
@@ -15,6 +16,7 @@ export type SeamlessPeriodSwitchStrategy = 'auto' | 'always' | 'never';
 /**
  * Represents a configuration for controlling playback of an MPEG-DASH stream.
  *
+ * @category Source
  * @public
  */
 export interface DashPlaybackConfiguration {

package/src/api/source/drm/DRMConfiguration.ts

@@ -1,6 +1,8 @@
 /**
  * Describes the key system configuration.
  *
+ * @category Content Protection
+ * @category Source
  * @public
  */
 export interface KeySystemConfiguration {
@@ -99,6 +101,8 @@ export interface KeySystemConfiguration {
  * <br/> - `'temporary'`
  * <br/> - `'persistent'`
  *
+ * @category Content Protection
+ * @category Source
  * @public
  */
 export type LicenseType = 'temporary' | 'persistent';
@@ -106,6 +110,8 @@ export type LicenseType = 'temporary' | 'persistent';
 /**
  * Describes the FairPlay key system configuration.
  *
+ * @category Content Protection
+ * @category Source
  * @public
  */
 export interface FairPlayKeySystemConfiguration extends KeySystemConfiguration {
@@ -118,6 +124,8 @@ export interface FairPlayKeySystemConfiguration extends KeySystemConfiguration {
 /**
  * Describes the PlayReady key system configuration.
  *
+ * @category Content Protection
+ * @category Source
  * @public
  */
 export interface PlayReadyKeySystemConfiguration extends KeySystemConfiguration {
@@ -130,6 +138,8 @@ export interface PlayReadyKeySystemConfiguration extends KeySystemConfiguration
 /**
  * Describes the Widevine key system configuration.
  *
+ * @category Content Protection
+ * @category Source
  * @public
  */
 export type WidevineKeySystemConfiguration = KeySystemConfiguration;
@@ -137,6 +147,8 @@ export type WidevineKeySystemConfiguration = KeySystemConfiguration;
 /**
  * Describes the ClearKey key system configuration.
  *
+ * @category Content Protection
+ * @category Source
  * @public
  */
 export interface ClearkeyKeySystemConfiguration extends KeySystemConfiguration {
@@ -149,6 +161,8 @@ export interface ClearkeyKeySystemConfiguration extends KeySystemConfiguration {
 /**
  * Describes the ClearKey decryption key.
  *
+ * @category Content Protection
+ * @category Source
  * @public
  */
 export interface ClearkeyDecryptionKey {
@@ -174,6 +188,8 @@ export interface ClearkeyDecryptionKey {
 /**
  * Describes the AES128 key system configuration.
  *
+ * @category Content Protection
+ * @category Source
  * @public
  */
 export interface AES128KeySystemConfiguration {
@@ -191,6 +207,8 @@ export interface AES128KeySystemConfiguration {
 /**
  * Describes the configuration of the DRM.
  *
+ * @category Content Protection
+ * @category Source
  * @public
  */
 export interface DRMConfiguration {
@@ -247,6 +265,8 @@ export interface DRMConfiguration {
 /**
  * The id of a key system. Possible values are 'widevine', 'fairplay' and 'playready'.
  *
+ * @category Content Protection
+ * @category Source
  * @public
  */
 export type KeySystemId = 'widevine' | 'fairplay' | 'playready';

package/src/api/source/hls/HlsPlaybackConfiguration.ts

@@ -16,6 +16,7 @@
  * @remarks
  * <br/> - See {@link HlsPlaybackConfiguration.discontinuityAlignment}.
  *
+ * @category Source
  * @public
  */
 export type HlsDiscontinuityAlignment = 'auto' | 'playlist' | 'media';
@@ -23,6 +24,7 @@ export type HlsDiscontinuityAlignment = 'auto' | 'playlist' | 'media';
 /**
  * Represents a configuration for controlling playback of an MPEG-DASH stream.
  *
+ * @category Source
  * @public
  */
 export interface HlsPlaybackConfiguration {

package/src/api/source/metadata/MetadataDescription.ts

@@ -1,6 +1,7 @@
 /**
  * Describes the metadata of a source.
  *
+ * @category Source
  * @public
  */
 export interface MetadataDescription {

package/src/api/theoads/TheoAdsAPI.ts

@@ -5,6 +5,7 @@ import { Interstitial } from './interstitial/Interstitial';
  *
  * @since React Native THEOplayer SDK v8.17.0.
  *
+ * @category Ads
  * @category THEOads
  * @public
  */

package/src/api/theoads/interstitial/AdBreakInterstitial.ts

@@ -4,12 +4,17 @@ import { Interstitial } from './Interstitial';
 
 /**
  *  The layout of the THEOad.
+ *
+ *  @category Ads
+ *  @category THEOads
+ *  @public
  */
 export type TheoAdsLayout = 'single' | 'l-shape' | 'double';
 
 /**
  * The THEOads interstitial that corresponds with ad playback.
  *
+ * @category Ads
  * @category THEOads
  * @public
  */

package/src/api/theoads/interstitial/Interstitial.ts

@@ -1,6 +1,7 @@
 /**
  * The type of the interstitial.
  *
+ * @category Ads
  * @category THEOads
  * @public
  */
@@ -9,6 +10,7 @@ export type InterstitialType = 'adbreak' | 'overlay';
 /**
  * The THEOads interstitial.
  *
+ * @category Ads
  * @category THEOads
  * @public
  */

package/src/api/theoads/interstitial/OverlayInterstitial.ts

@@ -3,6 +3,7 @@ import { Interstitial } from './Interstitial';
 /**
  * The THEOads interstitial that corresponds with overlay playback.
  *
+ * @category Ads
  * @category THEOads
  * @public
  */
@@ -33,6 +34,7 @@ export interface OverlayInterstitial extends Interstitial {
 /**
  * The position information of the overlay.
  *
+ * @category Ads
  * @category THEOads
  * @public
  */
@@ -46,6 +48,7 @@ export interface OverlayPosition {
 /**
  * The size information of the overlay.
  *
+ * @category Ads
  * @category THEOads
  * @public
  */

package/src/api/track/DateRangeCue.ts

@@ -3,6 +3,7 @@ import type { TextTrackCue } from './TextTrackCue';
 /**
  * Represents a cue of a HLS date range metadata text track.
  *
+ * @category Media and Text Tracks
  * @public
  */
 export interface DateRangeCue extends TextTrackCue {
@@ -68,6 +69,9 @@ export interface DateRangeCue extends TextTrackCue {
 
 /**
  * Check whether a text track cue is of type DateRangeCue.
+ *
+ * @category Media and Text Tracks
+ * @public
  */
 export function isDateRangeCue(cue: TextTrackCue): cue is DateRangeCue {
   return (cue as DateRangeCue).customAttributes != undefined;

package/src/api/track/MediaTrack.ts

@@ -1,11 +1,18 @@
 import type { Track } from './Track';
 import type { Quality } from './Quality';
 
+/**
+ * Represents the category of a media track (audio or video).
+ *
+ * @category Media and Text Tracks
+ * @public
+ */
 export type MediaTrackKind = 'main' | 'alternative';
 
 /**
  * Represents a media track (audio or video) of a media resource.
  *
+ * @category Media and Text Tracks
  * @public
  */
 export interface MediaTrack extends Track {
@@ -39,6 +46,13 @@ export interface MediaTrack extends Track {
    */
   readonly label: string;
 
+  /**
+   * The unlocalized label of the media track, as extracted from the manifest.
+   *
+   * @platform ios
+   */
+  readonly unlocalizedLabel?: string;
+
   /**
    * The language of the media track.
    */
@@ -60,14 +74,32 @@ export interface MediaTrack extends Track {
   readonly enabled: boolean;
 }
 
+/**
+ * Find a media track by `uid` in a list of media tracks.
+ *
+ * @category Media and Text Tracks
+ * @public
+ */
 export function findMediaTrackByUid(mediaTracks: MediaTrack[], uid: number | undefined): MediaTrack | undefined {
   return mediaTracks.find((track) => track.uid === uid);
 }
 
+/**
+ * Find a quality by `uid` in a list of media tracks.
+ *
+ * @category Media and Text Tracks
+ * @public
+ */
 export function findQualityByUid(mediaTrack: MediaTrack, uid: number | undefined): Quality | undefined {
   return mediaTrack.qualities.find((quality) => quality.uid === uid);
 }
 
+/**
+ * Find a list of qualities by `uid` in a list of media tracks.
+ *
+ * @category Media and Text Tracks
+ * @public
+ */
 export function findQualitiesByUid(mediaTrack: MediaTrack | undefined, uid: number | number[] | undefined): Quality[] | undefined {
   if (uid && mediaTrack) {
     if (Array.isArray(uid)) {

package/src/api/track/Quality.ts

@@ -1,6 +1,7 @@
 /**
  * Represents a quality of a media track.
  *
+ * @category Media and Text Tracks
  * @public
  */
 export interface Quality {
@@ -54,6 +55,7 @@ export interface Quality {
 /**
  * Represents a quality of a video track.
  *
+ * @category Media and Text Tracks
  * @public
  */
 export interface VideoQuality extends Quality {
@@ -81,6 +83,7 @@ export interface VideoQuality extends Quality {
 /**
  * Represents a quality of an audio track.
  *
+ * @category Media and Text Tracks
  * @public
  */
 export interface AudioQuality extends Quality {

package/src/api/track/TextTrack.ts

@@ -1,6 +1,20 @@
 import type { Track } from './Track';
 import type { TextTrackCue } from './TextTrackCue';
 
+/**
+ * The content type of a text track, represented by a value from the following list:
+ * <br/> - `'srt'`: The track contains SRT (SubRip Text) content.
+ * <br/> - `'ttml'`: The track contains TTML (Timed Text Markup Language) content.
+ * <br/> - `'webvtt'`: The track contains WebVTT (Web Video Text Tracks) content.
+ * <br/> - `'emsg'`: The track contains emsg (Event Message) content.
+ * <br/> - `'eventstream'`: The track contains Event Stream content.
+ * <br/> - `'id3'`: The track contains ID3 content.
+ * <br/> - `'cea608'`: The track contains CEA608 content.
+ * <br/> - `'daterange'`: The track contains HLS EXT-X-DATERANGE content.
+ *
+ * @category Media and Text Tracks
+ * @public
+ */
 export enum TextTrackType {
   cea608 = 'cea608',
   id3 = 'id3',
@@ -12,6 +26,17 @@ export enum TextTrackType {
   emsg = 'emsg',
 }
 
+/**
+ * The kind of the text track, represented by a value from the following list:
+ * <br/> - `'subtitles'`: The track contains subtitles.
+ * <br/> - `'captions'`: The track contains closed captions, a translation of dialogue and sound effects.
+ * <br/> - `'descriptions'`: The track contains descriptions, a textual description of the video.
+ * <br/> - `'chapters'`: The track contains chapter titles.
+ * <br/> - `'metadata'`: The track contains metadata. This track will not serve display purposes.
+ *
+ * @category Media and Text Tracks
+ * @public
+ */
 export enum TextTrackKind {
   captions = 'captions',
   chapters = 'chapters',
@@ -21,12 +46,32 @@ export enum TextTrackKind {
   thumbnails = 'thumbnails',
 }
 
+/**
+ * The mode of the text track, represented by a value from the following list:
+ * <br/> - `'disabled'`: The track is disabled.
+ * <br/> - `'hidden'`: The track is hidden.
+ * <br/> - `'showing'`: The track is showing.
+ *
+ * @remarks
+ * <br/> - A disabled track is not displayed and exposes no active cues, nor fires cue events.
+ * <br/> - A hidden track is not displayed but exposes active cues and fires cue events.
+ * <br/> - A showing track is displayed, exposes active cues and fires cue events.
+ *
+ * @category Media and Text Tracks
+ * @public
+ */
 export enum TextTrackMode {
   disabled = 'disabled',
   showing = 'showing',
   hidden = 'hidden',
 }
 
+/**
+ * Represents a text track of a media resource.
+ *
+ * @category Media and Text Tracks
+ * @public
+ */
 export interface TextTrack extends Track {
   /**
    * The kind of the text track, represented by a value from the following list:
@@ -38,6 +83,13 @@ export interface TextTrack extends Track {
    */
   readonly kind: TextTrackKind;
 
+  /**
+   * The unlocalized label of the text track, as extracted from the manifest.
+   *
+   * @platform ios
+   */
+  readonly unlocalizedLabel?: string;
+
   /**
    * The label of the text track.
    */
@@ -101,7 +153,11 @@ export interface TextTrack extends Track {
 
 /**
  * Retain renderable tracks.
+ *
  * https://html.spec.whatwg.org/multipage/embedded-content.html#text-track-showing
+ *
+ * @category Media and Text Tracks
+ * @internal
  */
 export function filterRenderableTracks(textTracks: TextTrack[] | undefined): TextTrack[] | undefined {
   return textTracks && textTracks.filter((textTrack) => textTrack.kind === 'subtitles' || textTrack.kind === 'captions');
@@ -109,6 +165,9 @@ export function filterRenderableTracks(textTracks: TextTrack[] | undefined): Tex
 
 /**
  * Retain first thumbnail track encountered in the textTracks list.
+ *
+ * @category Media and Text Tracks
+ * @internal
  */
 export function filterThumbnailTracks(textTracks: TextTrack[] | undefined): TextTrack | undefined {
   return textTracks && textTracks.find(isThumbnailTrack);
@@ -116,27 +175,53 @@ export function filterThumbnailTracks(textTracks: TextTrack[] | undefined): Text
 
 /**
  * Query whether a track is a valid thumbnail track.
+ *
+ * @category Media and Text Tracks
+ * @internal
  */
 export function isThumbnailTrack(textTrack: TextTrack | undefined): boolean {
   return !!textTrack && (textTrack.kind === 'thumbnails' || (textTrack.kind === 'metadata' && textTrack.label === 'thumbnails'));
 }
-
+/**
+ * Query whether a track is a given cue.
+ *
+ * @category Media and Text Tracks
+ * @internal
+ */
 export function hasTextTrackCue(textTrack: TextTrack, cue: TextTrackCue): boolean {
   return !!(textTrack.cues && cue && textTrack.cues.find((c) => cue.uid === c.uid));
 }
 
+/**
+ * Removes a cue from a text track.
+ *
+ * @category Media and Text Tracks
+ * @internal
+ */
 export function removeTextTrackCue(textTrack?: TextTrack, cue?: TextTrackCue) {
   if (textTrack && textTrack.cues && cue && hasTextTrackCue(textTrack, cue)) {
     textTrack.cues = textTrack.cues.filter((c) => c.uid !== cue.uid);
   }
 }
 
+/**
+ * Adds a cue to a text track.
+ *
+ * @category Media and Text Tracks
+ * @internal
+ */
 export function addTextTrackCue(textTrack?: TextTrack, cue?: TextTrackCue) {
   if (textTrack && textTrack.cues && cue && !hasTextTrackCue(textTrack, cue)) {
     textTrack.cues.push(cue);
   }
 }
 
+/**
+ * Returns a cue from a text track by uid.
+ *
+ * @category Media and Text Tracks
+ * @internal
+ */
 export function findTextTrackByUid(textTracks: TextTrack[], uid: number): TextTrack | undefined {
   return textTracks.find((t) => t.uid === uid);
 }

package/src/api/track/TextTrackCue.ts

@@ -1,6 +1,7 @@
 /**
  * Represents a cue of a text track.
  *
+ * @category Media and Text Tracks
  * @public
  */
 export interface TextTrackCue {

package/src/api/track/TextTrackStyle.ts

@@ -1,6 +1,7 @@
 /**
  * The text track style API.
  *
+ * @category Media and Text Tracks
  * @public
  */
 export interface TextTrackStyle {
@@ -116,6 +117,7 @@ export interface TextTrackStyle {
  * <br/> - `'depressed'`
  * <br/> - `'uniform'`
  *
+ * @category Media and Text Tracks
  * @public
  */
 export enum EdgeStyle {

package/src/api/track/Track.ts

@@ -4,6 +4,7 @@
  * @remarks
  * <br/> - A specific track type (e.g. {@link TextTrack}) will always be used.
  *
+ * @category Media and Text Tracks
  * @public
  */
 export interface Track {
@@ -46,18 +47,42 @@ export interface Track {
   readonly language: string;
 }
 
+/**
+ * Checks whether a track list contains a given track.
+ *
+ * @category Media and Text Tracks
+ * @internal
+ */
 export function hasTrack<TTrack extends Track>(trackList: TTrack[], track: TTrack): boolean {
   return !!(trackList && track && trackList.find((t) => t.uid === track.uid));
 }
 
+/**
+ * Removes a track from a track list.
+ *
+ * @category Media and Text Tracks
+ * @internal
+ */
 export function removeTrack<TTrack extends Track>(trackList: TTrack[], track: TTrack): TTrack[] {
   return trackList && track ? trackList.filter((t) => t.uid !== track.uid) : trackList;
 }
 
+/**
+ * Adds a track to a track list.
+ *
+ * @category Media and Text Tracks
+ * @internal
+ */
 export function addTrack<TTrack extends Track>(trackList: TTrack[], track: TTrack): TTrack[] {
   return trackList && track && !hasTrack(trackList, track) ? sortTracks([...trackList, track]) : trackList;
 }
 
+/**
+ * Sort a track list based on the track's uids, which is how they are listed in the manifest.
+ *
+ * @category Media and Text Tracks
+ * @internal
+ */
 export function sortTracks<TTrack extends Track>(trackList?: TTrack[]): TTrack[] {
   return trackList?.sort((t1: TTrack, t2: TTrack) => t1.uid - t2.uid) || [];
 }

package/src/api/ui/UIConfiguration.ts

@@ -1,6 +1,7 @@
 /**
  * Describes the UI related configuration of the player.
  *
+ * @category UI
  * @public
  */
 export interface UIConfiguration {

package/src/internal/adapter/DefaultNativePlayerState.ts

@@ -25,6 +25,7 @@ export class DefaultNativePlayerState extends DefaultTextTrackState implements N
   seeking = false;
   volume = 1;
   currentTime = 0;
+  currentProgramDateTime: number | undefined = undefined;
   duration = NaN;
   playbackRate = 1;
   preload: PreloadType = 'none';