react-native-theoplayer 9.3.0 → 9.5.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 {
@@ -71,10 +80,11 @@ export interface GoogleDAIConfiguration extends ServerSideAdInsertionConfigurati
     /**
      * The network code for the publisher making this stream request.
      *
+     * @platform web
+     *
      * @remarks
      * <br/> - See {@link https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/html5/reference/js/StreamRequest#networkCode}
      *         for more information.
-     * <br/> - Available on Web only.
      */
     networkCode?: string;
 }
@@ -82,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 {
@@ -103,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 {
@@ -132,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,21 +1,22 @@
 /**
  * The configuration for transmitting information to Content Delivery Networks (CDNs)
  * through Common Media Client Data (CMCD) (CTA-5004)
+ *
+ * @category Source
+ * @public
  */
 export interface CmcdConfiguration {
   /**
    * The content ID parameter which should be passed as a CMCD value. If left empty, no content ID will be sent.
    *
-   * @remarks
-   * Web only
+   * @platform web
    */
   contentID?: string;
 
   /**
    * The session ID parameter which should be passed as a CMCD value. If left empty, a UUIDv4 will be generated when applying the configuration.
    *
-   * @remarks
-   * Web only
+   * @platform web
    */
   sessionID?: string;
 
@@ -23,8 +24,7 @@ export interface CmcdConfiguration {
    * A flag to indicate if request IDs should be sent or not.
    * When set to a truthy value, a UUIDv4 will be sent as a request id (`rid`) with every request to allow for request tracing.
    *
-   * @remarks
-   * Web only
+   * @platform web
    */
   sendRequestID?: boolean;
 
@@ -32,8 +32,7 @@ export interface CmcdConfiguration {
    * The target URI where client data is to be delivered in case the {@link transmissionMode} is set
    * to {@link CmcdTransmissionMode.JSON_OBJECT}.
    *
-   * @remarks
-   * Web only
+   * @platform web
    */
   jsonObjectTargetURI?: string;
 
@@ -42,8 +41,7 @@ export interface CmcdConfiguration {
    * Note custom keys MUST carry a hyphenated prefix to ensure that there will not be a namespace collision with future
    * revisions to the specification. Clients SHOULD use a reverse-DNS syntax when defining their own prefix.
    *
-   * @remarks
-   * Web only
+   * @platform web
    */
   customKeys?: {
     [key: string]: string | number | boolean;
@@ -55,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,17 +16,14 @@ export type SeamlessPeriodSwitchStrategy = 'auto' | 'always' | 'never';
 /**
  * Represents a configuration for controlling playback of an MPEG-DASH stream.
  *
- * @remarks
- * <br/> - Available since v2.79.0.
- *
+ * @category Source
  * @public
  */
 export interface DashPlaybackConfiguration {
   /**
    * Whether to seamlessly switch between DASH periods.
    *
-   * @remarks
-   * <br/> - Available on Web only.
+   * @platform web
    *
    * The player supports two strategies for handling a switch between two periods in an MPEG-DASH stream:
    * <br/> - <strong>Seamless</strong>: Once the player is done buffering the current period, it immediately starts buffering the next period.
@@ -49,9 +47,9 @@ export interface DashPlaybackConfiguration {
    * (Experimental) Whether the timescales of the media data need to be shifted,
    * in order to work around platform-specific issues on certain smart TV platforms.
    *
+   * @platform android
+   *
    * @remarks
-   * <br/> - Available since v4.1.0.
-   * <br/> - Available on Web only.
    * <br/> - On certain smart TV platforms (such as Tizen 2), playback issues may arise when
    *         the timescale of the media data changes across periods or discontinuities.
    *         In that case, the player may need to shift all the timescales first,
@@ -66,9 +64,9 @@ export interface DashPlaybackConfiguration {
   /**
    * (Experimental) The desired timescale to which the media data should be shifted.
    *
+   * @platform web
+   *
    * @remarks
-   * <br/> - Available since v4.11.0.
-   * <br/> - Available on Web only.
    * <br/> - When specified, if the player decides to shift the timescale (see {@link DashPlaybackConfiguration.needsTimescaleShifting}), the timescale will be set to the
    *         given desired timescale.
    * <br/> - When not specified, if the player decides to shift timescale, the player will decide the timescale to which it should shift.
@@ -82,8 +80,7 @@ export interface DashPlaybackConfiguration {
    *
    * @internal
    *
-   * @remarks
-   * <br/> - Available on Web only.
+   * @platform web
    */
   forceSeekToSynchronize?: boolean;
 
@@ -91,9 +88,9 @@ export interface DashPlaybackConfiguration {
    * (Experimental) Force the player to ignore the availability window of individual segments in the MPD,
    * and instead consider every listed segment to be immediately available.
    *
+   * @platform web,android
+   *
    * @remarks
-   * <br/> - Available since v5.2.0.
-   * <br/> - Available on Web and Android.
    * <br/> - This only applies to livestreams (with `<MPD type="dynamic">`).
    * <br/> - This only applies to streams that use `<SegmentTimeline>`.
    */
@@ -102,10 +99,9 @@ export interface DashPlaybackConfiguration {
   /**
    * A flag to indicate whether timestamps of segmented WebVTT subtitles are relative to the segment start time.
    *
-   * @remarks
-   * <br/> - Available on Web only.
+   * @platform web
    *
-   *  @defaultValue `true`
+   * @defaultValue `true`
    */
   segmentRelativeVttTiming?: boolean;
 }

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,9 +24,7 @@ export type HlsDiscontinuityAlignment = 'auto' | 'playlist' | 'media';
 /**
  * Represents a configuration for controlling playback of an MPEG-DASH stream.
  *
- * @remarks
- * <br/> - Available since v2.82.0.
- *
+ * @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

@@ -3,9 +3,9 @@ import { Interstitial } from './interstitial/Interstitial';
 /**
  * The THEOads API.
  *
- * @remarks
- * <br/> - Available since v8.17.0.
+ * @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/theolive/TheoLiveConfiguration.ts

@@ -7,32 +7,28 @@ export interface TheoLiveConfiguration {
   /**
    * An id used to report usage analytics, if not explicitly given a random UUID is used.
    *
-   * @remarks
-   * <br/> - Available on Web and Android only.
+   * @platform web,android
    */
   readonly externalSessionId?: string;
 
   /**
    * Whether this player should fallback or not when it has a fallback configured.
    *
-   * @remarks
-   * <br/> - Available on Web only.
+   * @platform web
    */
   readonly fallbackEnabled?: boolean;
 
   /**
    * An optional header that can be passed during discovery.
    *
-   * @remarks
-   * <br/> - Available on Web only.
+   * @platform web
    */
   readonly discoveryHeader?: string;
 
   /**
    * Whether THEOlive analytics should be disabled or not.
    *
-   * @remarks
-   * <br/> - Available on Android only.
+   * @platform android
    *
    * @defaultValue `false`
    */

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 {
@@ -60,14 +67,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 {