react-native-theoplayer 11.2.0 → 11.3.0

package/src/api/cmcd/CmcdConfiguration.ts

@@ -0,0 +1,175 @@
+/**
+ * Configuration for a CMCD endpoint.
+ *
+ * @remarks
+ * <br/> - Available since v11.4.0.
+ *
+ * @category CMCD
+ * @public
+ */
+export interface CmcdEndpointConfiguration {
+  /**
+   * The URL of the CMCD endpoint.
+   */
+  url: string;
+}
+
+/**
+ * Describes the CMCD (Common Media Client Data) configuration for event mode reporting at the player level.
+ *
+ * @remarks
+ * <br/> - Available since v11.4.0.
+ * <br/> - This configuration is set at the player level. For source-level configuration, see {@link CmcdSourceConfiguration}.
+ *
+ * @category CMCD
+ * @category Player
+ * @public
+ */
+export interface CmcdPlayerConfiguration {
+  /**
+   * An external session ID that can be used to identify the current playback session.
+   */
+  externalSessionId?: string;
+
+  /**
+   * A user ID that can be used to identify the user.
+   */
+  userId?: string;
+
+  /**
+   * A list of CMCD endpoints to which events should be sent.
+   */
+  eventEndpoints?: CmcdEndpointConfiguration[];
+}
+
+/**
+ * Describes the CMCD (Common Media Client Data) configuration at the source level.
+ *
+ * @remarks
+ * <ul>
+ *   <li>Event mode reporting available since v11.4.0.</li>
+ *   <li>
+ *     This extends the player-level {@link CmcdPlayerConfiguration} by additionally allowing a session ID to be specified
+ *  per source. Source-level values take precedence over player-level values for overlapping fields,
+ *  except for `eventEndpoints` which are merged (both player and source endpoints receive events).
+ *  </li>
+ * </ul>
+ *
+ * @category CMCD
+ * @category Source
+ * @public
+ */
+export interface CmcdSourceConfiguration extends CmcdPlayerConfiguration {
+  /**
+   * The content ID parameter which should be passed as a CMCD value. If left empty, no content ID will be sent.
+   *
+   * @platform web
+   *
+   * @remarks Request mode only
+   */
+  contentID?: string;
+  /**
+   * A GUID identifying the current playback session. If left empty, a UUIDv4 will be generated when applying the configuration.
+   *
+   * @remarks
+   * <ul>
+   *   <li>A playback session typically consists of the playback of a single media
+   * asset along with accompanying content such as advertisements. The maximum length is 64 characters.
+   * It is RECOMMENDED to conform to the UUID specification (https://tools.ietf.org/html/rfc4122).
+   * </li>
+   * <li>Event mode only for iOS and Android</li>
+   * </ul>
+   */
+  sessionID?: string;
+
+  /**
+   * 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.
+   *
+   * @platform web
+   *
+   * @remarks Request mode only
+   */
+  sendRequestID?: boolean;
+
+  /**
+   * The target URI where client data is to be delivered in case the {@link transmissionMode} is set
+   * to {@link CmcdTransmissionMode.JSON_OBJECT}.
+   *
+   * @platform web
+   *
+   * @remarks Request mode only
+   */
+  jsonObjectTargetURI?: string;
+
+  /**
+   * An object containing custom keys which should be added to the generated CMCD parameters.
+   * 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.
+   *
+   * @platform web
+   *
+   * @remarks Request mode only
+   */
+  customKeys?: {
+    [key: string]: string | number | boolean;
+  };
+
+  /**
+   * The data transmission mode as defined in section 2 of the specification.
+   *
+   * @remarks
+   * <ul>
+   *   <li>Starting from version 11.4.0, this property is now optional. By providing a value, request mode will be
+   *   enabled as it was before. If left undefined, the SDK will not use request mode.</li>
+   *   <li>Request mode only</li>
+   * </ul>
+   */
+  transmissionMode?: CmcdTransmissionMode
+}
+
+/**
+ * The configuration for transmitting information to Content Delivery Networks (CDNs)
+ * through Common Media Client Data (CMCD) (CTA-5004)
+ *
+ * @category CMCD
+ * @category Source
+ * @public
+ *
+ * @deprecated Use {@link CmcdSourceConfiguration} instead.
+ */
+export type CmcdConfiguration = CmcdSourceConfiguration;
+
+/**
+ * The CMCD transmission mode.
+ *
+ * @category Source
+ * @public
+ */
+export enum CmcdTransmissionMode {
+  /**
+   * Transmit CMCD data as a custom HTTP request header.
+   *
+   * @remarks
+   * Usage of a custom header from a web browser user-agent will trigger a preflight OPTIONS request before each unique
+   * media object request. This will lead to an increased request rate against the server. As a result, for CMCD
+   * transmissions from web browser user-agents that require CORS-preflighting per URL,
+   * the preferred mode of use is query arguments.
+   */
+  HTTP_HEADER,
+  /**
+   * Transmit CMCD data as a HTTP query argument.
+   */
+  QUERY_ARGUMENT,
+  /**
+   * Transmit CMCD data as a JSON object independent of the HTTP object request.
+   */
+  JSON_OBJECT,
+  /**
+   * Use the default transmission mode for each SDK:
+   * - Web: Query arguments
+   * - Android: Query arguments
+   * - iOS: HTTP request headers
+   */
+  SDK_DEFAULT
+}

package/src/api/config/PlayerConfiguration.ts

@@ -4,6 +4,7 @@ import type { MediaControlConfiguration } from '../media/MediaControlConfigurati
 import type { RetryConfiguration } from '../utils/RetryConfiguration';
 import type { UIConfiguration } from '../ui/UIConfiguration';
 import { TheoLiveConfiguration } from '../theolive/TheoLiveConfiguration';
+import type { CmcdPlayerConfiguration } from '../cmcd/CmcdConfiguration';
 
 /**
  * Describes a player's configuration.
@@ -142,6 +143,16 @@ export interface PlayerConfiguration {
    * <br/> - Any user-defined overrides are still respected.
    */
   useSystemCaptionStyle?: boolean;
+
+  /**
+   * The CMCD configuration for the player.
+   *
+   * @remarks
+   * <br/> - Available since v11.4.0.
+   * <br/> - Configures event mode reporting for Common Media Client Data (CTA-5004).
+   * <br/> - Source-level configuration can override player-level values. See {@link CmcdSourceConfiguration}.
+   */
+  cmcd?: CmcdPlayerConfiguration;
 }
 
 /**

package/src/api/source/SourceDescription.ts

@@ -14,7 +14,7 @@ import type { AdDescription } from './ads/Ads';
 import type { MetadataDescription } from './metadata/MetadataDescription';
 import type { ServerSideAdInsertionConfiguration } from './ads/ssai/ServerSideAdInsertionConfiguration';
 import type { AnalyticsDescription } from './analytics/AnalyticsDescription';
-import { CmcdConfiguration } from './cmcd/CmcdConfiguration';
+import { CmcdSourceConfiguration } from '../cmcd/CmcdConfiguration';
 import { SourceLatencyConfiguration } from './latency/SourceLatencyConfiguration';
 
 /**
@@ -109,7 +109,7 @@ export interface SourceConfiguration {
    * The configuration for transmitting information to Content Delivery Networks (CDNs)
    * through Common Media Client Data (CMCD) (CTA-5004)
    */
-  cmcd?: CmcdConfiguration;
+  cmcd?: CmcdSourceConfiguration;
 }
 
 /**

package/src/api/source/barrel.ts

@@ -1,6 +1,5 @@
 export * from './ads/barrel';
 export * from './analytics/barrel';
-export * from './cmcd/barrel';
 export * from './drm/barrel';
 export * from './dash/barrel';
 export * from './hls/barrel';

package/src/api/track/TextTrack.ts

@@ -150,6 +150,11 @@ export interface TextTrack extends Track {
    */
   readonly forced: boolean;
 
+  /**
+   * The in-band metadata track dispatch type of the text track.
+   */
+  readonly inBandMetadataTrackDispatchType: string;
+
   /**
    * The closed caption service number of the text track.
    *

package/src/internal/adapter/THEOplayerWebAdapter.ts

@@ -95,11 +95,16 @@ export class THEOplayerWebAdapter extends DefaultEventDispatcher<PlayerEventMap>
   set source(source: SourceDescription | undefined) {
     this._targetVideoQuality = undefined;
     if (this._player) {
-      this._player.source = source as NativeSourceDescription;
-      if (source?.cmcd && this._cmcdConnector === undefined) {
-        this._cmcdConnector = createCMCDConnector(this._player);
+      this._player.source = (
+        source?.cmcd ? { ...source, cmcd: { ...source.cmcd, sessionId: source.cmcd.sessionID } } : source
+      ) as NativeSourceDescription;
+      const requestModeEnabled = source?.cmcd?.transmissionMode !== undefined;
+      if (requestModeEnabled) {
+        this._cmcdConnector ??= createCMCDConnector(this._player);
+        this._cmcdConnector?.reconfigure(this.toWebCmcdConfiguration(source?.cmcd));
+      } else {
+        this._cmcdConnector?.reconfigure(undefined);
       }
-      this._cmcdConnector?.reconfigure(this.toWebCmcdConfiguration(source?.cmcd));
     }
   }
 

package/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, captionChannel } = track;
+  const { id, uid, kind, label, language, mode, type, src, forced, inBandMetadataTrackDispatchType, captionChannel } = track;
 
   return {
     id,
@@ -53,6 +53,7 @@ export function fromNativeTextTrack(track: NativeTextTrack): TextTrack {
     type,
     src,
     forced,
+    inBandMetadataTrackDispatchType,
     captionChannel,
     cues: track.cues ? track.cues.map((cue) => fromNativeCue(cue)) : [],
   } as TextTrack;

package/src/manifest.json

@@ -1 +1 @@
-{"version":"11.2.0","buildDate":"2026-06-04T15:04:43.174Z"}
+{"version":"11.3.0","buildDate":"2026-06-19T06:51:55.916Z"}

package/lib/commonjs/api/source/cmcd/CmcdConfiguration.js

@@ -1,27 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.CmcdTransmissionMode = void 0;
-/**
- * The configuration for transmitting information to Content Delivery Networks (CDNs)
- * through Common Media Client Data (CMCD) (CTA-5004)
- *
- * @category Source
- * @public
- */
-/**
- * The CMCD transmission mode.
- *
- * @category Source
- * @public
- */
-let CmcdTransmissionMode = exports.CmcdTransmissionMode = /*#__PURE__*/function (CmcdTransmissionMode) {
-  CmcdTransmissionMode[CmcdTransmissionMode["HTTP_HEADER"] = 0] = "HTTP_HEADER";
-  CmcdTransmissionMode[CmcdTransmissionMode["QUERY_ARGUMENT"] = 1] = "QUERY_ARGUMENT";
-  CmcdTransmissionMode[CmcdTransmissionMode["JSON_OBJECT"] = 2] = "JSON_OBJECT";
-  CmcdTransmissionMode[CmcdTransmissionMode["SDK_DEFAULT"] = 3] = "SDK_DEFAULT";
-  return CmcdTransmissionMode;
-}({});
-//# sourceMappingURL=CmcdConfiguration.js.map

package/lib/commonjs/api/source/cmcd/CmcdConfiguration.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["CmcdTransmissionMode","exports"],"sourceRoot":"../../../../../src","sources":["api/source/cmcd/CmcdConfiguration.ts"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AAiDA;AACA;AACA;AACA;AACA;AACA;AALA,IAMYA,oBAAoB,GAAAC,OAAA,CAAAD,oBAAA,0BAApBA,oBAAoB;EAApBA,oBAAoB,CAApBA,oBAAoB;EAApBA,oBAAoB,CAApBA,oBAAoB;EAApBA,oBAAoB,CAApBA,oBAAoB;EAApBA,oBAAoB,CAApBA,oBAAoB;EAAA,OAApBA,oBAAoB;AAAA","ignoreList":[]}

package/lib/commonjs/api/source/cmcd/barrel.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["_CmcdConfiguration","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get"],"sourceRoot":"../../../../../src","sources":["api/source/cmcd/barrel.ts"],"mappings":";;;;;AAAA,IAAAA,kBAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,kBAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,kBAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,kBAAA,CAAAK,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/lib/module/api/source/cmcd/CmcdConfiguration.js

@@ -1,24 +0,0 @@
-"use strict";
-
-/**
- * The configuration for transmitting information to Content Delivery Networks (CDNs)
- * through Common Media Client Data (CMCD) (CTA-5004)
- *
- * @category Source
- * @public
- */
-
-/**
- * The CMCD transmission mode.
- *
- * @category Source
- * @public
- */
-export let CmcdTransmissionMode = /*#__PURE__*/function (CmcdTransmissionMode) {
-  CmcdTransmissionMode[CmcdTransmissionMode["HTTP_HEADER"] = 0] = "HTTP_HEADER";
-  CmcdTransmissionMode[CmcdTransmissionMode["QUERY_ARGUMENT"] = 1] = "QUERY_ARGUMENT";
-  CmcdTransmissionMode[CmcdTransmissionMode["JSON_OBJECT"] = 2] = "JSON_OBJECT";
-  CmcdTransmissionMode[CmcdTransmissionMode["SDK_DEFAULT"] = 3] = "SDK_DEFAULT";
-  return CmcdTransmissionMode;
-}({});
-//# sourceMappingURL=CmcdConfiguration.js.map

package/lib/module/api/source/cmcd/CmcdConfiguration.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["CmcdTransmissionMode"],"sourceRoot":"../../../../../src","sources":["api/source/cmcd/CmcdConfiguration.ts"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;;AAiDA;AACA;AACA;AACA;AACA;AACA;AACA,WAAYA,oBAAoB,0BAApBA,oBAAoB;EAApBA,oBAAoB,CAApBA,oBAAoB;EAApBA,oBAAoB,CAApBA,oBAAoB;EAApBA,oBAAoB,CAApBA,oBAAoB;EAApBA,oBAAoB,CAApBA,oBAAoB;EAAA,OAApBA,oBAAoB;AAAA","ignoreList":[]}

package/lib/module/api/source/cmcd/barrel.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sourceRoot":"../../../../../src","sources":["api/source/cmcd/barrel.ts"],"mappings":";;AAAA,cAAc,qBAAqB","ignoreList":[]}

package/lib/typescript/api/source/cmcd/CmcdConfiguration.d.ts

@@ -1,83 +0,0 @@
-/**
- * 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.
-     *
-     * @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.
-     *
-     * @platform web
-     */
-    sessionID?: string;
-    /**
-     * 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.
-     *
-     * @platform web
-     */
-    sendRequestID?: boolean;
-    /**
-     * The target URI where client data is to be delivered in case the {@link transmissionMode} is set
-     * to {@link CmcdTransmissionMode.JSON_OBJECT}.
-     *
-     * @platform web
-     */
-    jsonObjectTargetURI?: string;
-    /**
-     * An object containing custom keys which should be added to the generated CMCD parameters.
-     * 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.
-     *
-     * @platform web
-     */
-    customKeys?: {
-        [key: string]: string | number | boolean;
-    };
-    /**
-     * The data transmission mode as defined in section 2 of the specification.
-     */
-    transmissionMode: CmcdTransmissionMode;
-}
-/**
- * The CMCD transmission mode.
- *
- * @category Source
- * @public
- */
-export declare enum CmcdTransmissionMode {
-    /**
-     * Transmit CMCD data as a custom HTTP request header.
-     *
-     * @remarks
-     * Usage of a custom header from a web browser user-agent will trigger a preflight OPTIONS request before each unique
-     * media object request. This will lead to an increased request rate against the server. As a result, for CMCD
-     * transmissions from web browser user-agents that require CORS-preflighting per URL,
-     * the preferred mode of use is query arguments.
-     */
-    HTTP_HEADER = 0,
-    /**
-     * Transmit CMCD data as a HTTP query argument.
-     */
-    QUERY_ARGUMENT = 1,
-    /**
-     * Transmit CMCD data as a JSON object independent of the HTTP object request.
-     */
-    JSON_OBJECT = 2,
-    /**
-     * Use the default transmission mode for each SDK:
-     * - Web: Query arguments
-     * - Android: Query arguments
-     * - iOS: HTTP request headers
-     */
-    SDK_DEFAULT = 3
-}
-//# sourceMappingURL=CmcdConfiguration.d.ts.map

package/lib/typescript/api/source/cmcd/CmcdConfiguration.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CmcdConfiguration.d.ts","sourceRoot":"","sources":["../../../../../src/api/source/cmcd/CmcdConfiguration.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;KAC1C,CAAC;IAEF;;OAEG;IACH,gBAAgB,EAAE,oBAAoB,CAAA;CACvC;AAED;;;;;GAKG;AACH,oBAAY,oBAAoB;IAC9B;;;;;;;;OAQG;IACH,WAAW,IAAA;IACX;;OAEG;IACH,cAAc,IAAA;IACd;;OAEG;IACH,WAAW,IAAA;IACX;;;;;OAKG;IACH,WAAW,IAAA;CACZ"}

package/lib/typescript/api/source/cmcd/barrel.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"barrel.d.ts","sourceRoot":"","sources":["../../../../../src/api/source/cmcd/barrel.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC"}

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

@@ -1,88 +0,0 @@
-/**
- * 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.
-   *
-   * @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.
-   *
-   * @platform web
-   */
-  sessionID?: string;
-
-  /**
-   * 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.
-   *
-   * @platform web
-   */
-  sendRequestID?: boolean;
-
-  /**
-   * The target URI where client data is to be delivered in case the {@link transmissionMode} is set
-   * to {@link CmcdTransmissionMode.JSON_OBJECT}.
-   *
-   * @platform web
-   */
-  jsonObjectTargetURI?: string;
-
-  /**
-   * An object containing custom keys which should be added to the generated CMCD parameters.
-   * 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.
-   *
-   * @platform web
-   */
-  customKeys?: {
-    [key: string]: string | number | boolean;
-  };
-
-  /**
-   * The data transmission mode as defined in section 2 of the specification.
-   */
-  transmissionMode: CmcdTransmissionMode
-}
-
-/**
- * The CMCD transmission mode.
- *
- * @category Source
- * @public
- */
-export enum CmcdTransmissionMode {
-  /**
-   * Transmit CMCD data as a custom HTTP request header.
-   *
-   * @remarks
-   * Usage of a custom header from a web browser user-agent will trigger a preflight OPTIONS request before each unique
-   * media object request. This will lead to an increased request rate against the server. As a result, for CMCD
-   * transmissions from web browser user-agents that require CORS-preflighting per URL,
-   * the preferred mode of use is query arguments.
-   */
-  HTTP_HEADER,
-  /**
-   * Transmit CMCD data as a HTTP query argument.
-   */
-  QUERY_ARGUMENT,
-  /**
-   * Transmit CMCD data as a JSON object independent of the HTTP object request.
-   */
-  JSON_OBJECT,
-  /**
-   * Use the default transmission mode for each SDK:
-   * - Web: Query arguments
-   * - Android: Query arguments
-   * - iOS: HTTP request headers
-   */
-  SDK_DEFAULT
-}