Merge pull request #1276 from canalplus/misc/remove-manifestUpdateUrlDoc

[Proposal] "Remove" `manifestUpdateUrl` loadVideo option for the v4
canalplus · Sep 27, 2023 · ac24e45 · ac24e45
2 parents 3d22953 + 4552426
commit ac24e45
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 17 deletions.
diff --git a/doc/Getting_Started/Migration_From_v3/loadVideo_Options.md b/doc/Getting_Started/Migration_From_v3/loadVideo_Options.md
@@ -35,6 +35,19 @@ If you still need that option for a valid use case, you are welcomed to open an
 issue.
 
 
+### `transportOptions.manifestUpdateUrl`
+
+The `manifestUpdateUrl` option has been removed without replacement.
+
+It was previously used as a non-standard DASH optimization to be able to refresh
+a DASH MPD (its Manifest document) through an URL containing a shorter version
+of the full DASH MPD.
+As we knew, it was only used at Canal+, though we now use (and we always
+preferred) more standard solutions both on the packaging-side (use of repeat
+attributes) and on the RxPlayer-side (usage of WebAssembly, internal
+optimizations like "unsafeMode").
+
+
 ### `transportOptions.aggressiveMode`
 
 The `aggressiveMode` option has been removed without replacement.

diff --git a/doc/reference/API_Reference.md b/doc/reference/API_Reference.md
@@ -148,10 +148,6 @@ properties, methods, events and so on.
   - [`initialManifest`](../api/Loading_a_Content.md#initialmanifest):
     Allows to provide an initial Manifest to speed-up the content loading
 
-  - [`manifestUpdateUrl`](../api/Loading_a_Content.md#manifestupdateurl):
-    Provide another URL, potentially to a shorter Manifest, used only for
-    Manifest updates
-
   - [`representationFilter`](../api/Loading_a_Content.md#representationfilter):
     Filter out qualities from the Manifest based on its characteristics.
 

diff --git a/src/core/api/option_utils.ts b/src/core/api/option_utils.ts
@@ -82,7 +82,7 @@ interface IParsedLoadVideoOptionsBase {
   representationFilter? : IRepresentationFilter | undefined;
   segmentLoader? : ISegmentLoader | undefined;
   serverSyncInfos? : IServerSyncInfos | undefined;
-  manifestUpdateUrl? : string | undefined;
+  __priv_manifestUpdateUrl? : string | undefined;
   __priv_patchLastSegmentInSidx? : boolean | undefined;
 }
 
@@ -346,11 +346,6 @@ function parseLoadVideoOptions(
     onCodecSwitch = DEFAULT_CODEC_SWITCHING_BEHAVIOR;
   }
 
-  if (!isNullOrUndefined(options.manifestUpdateUrl)) {
-    warnOnce("`manifestUpdateUrl` API is deprecated, please open an issue if you" +
-             " still rely on this.");
-  }
-
   if (isNullOrUndefined(options.textTrackMode)) {
     textTrackMode = DEFAULT_TEXT_TRACK_MODE;
   } else {
@@ -402,6 +397,7 @@ function parseLoadVideoOptions(
   /* eslint-disable @typescript-eslint/no-unsafe-assignment */
   /* eslint-disable @typescript-eslint/no-unsafe-member-access */
   return { __priv_patchLastSegmentInSidx: (options as any).__priv_patchLastSegmentInSidx,
+           __priv_manifestUpdateUrl: (options as any).__priv_manifestUpdateUrl,
   /* eslint-enable @typescript-eslint/no-explicit-any */
   /* eslint-enable @typescript-eslint/no-unsafe-assignment */
   /* eslint-enable @typescript-eslint/no-unsafe-member-access */
@@ -413,7 +409,6 @@ function parseLoadVideoOptions(
            keySystems,
            lowLatencyMode,
            manifestLoader: options.manifestLoader,
-           manifestUpdateUrl: options.manifestUpdateUrl,
            minimumManifestUpdateInterval,
            requestConfig,
            onCodecSwitch,

diff --git a/src/core/api/public_api.ts b/src/core/api/public_api.ts
@@ -547,11 +547,11 @@ class Player extends EventEmitter<IPublicAPIEvent> {
             transport,
             checkMediaSegmentIntegrity,
             manifestLoader,
-            manifestUpdateUrl,
             referenceDateTime,
             representationFilter,
             segmentLoader,
             serverSyncInfos,
+            __priv_manifestUpdateUrl,
             __priv_patchLastSegmentInSidx,
             url } = options;
 
@@ -587,11 +587,11 @@ class Player extends EventEmitter<IPublicAPIEvent> {
       const transportPipelines = transportFn({ lowLatencyMode,
                                                checkMediaSegmentIntegrity,
                                                manifestLoader,
-                                               manifestUpdateUrl,
                                                referenceDateTime,
                                                representationFilter,
                                                segmentLoader,
                                                serverSyncInfos,
+                                               __priv_manifestUpdateUrl,
                                                __priv_patchLastSegmentInSidx });
 
       /** Interface used to load and refresh the Manifest. */

diff --git a/src/public_types.ts b/src/public_types.ts
@@ -145,9 +145,6 @@ export interface ILoadVideoOptions {
   /** Custom implementation for performing Manifest requests. */
   manifestLoader? : IManifestLoader;
 
-  /** Possible custom URL pointing to a shorter form of the Manifest. */
-  manifestUpdateUrl? : string;
-
   /** Minimum bound for Manifest updates, in milliseconds. */
   minimumManifestUpdateInterval? : number;
 

diff --git a/src/transports/types.ts b/src/transports/types.ts
@@ -795,10 +795,10 @@ export interface ITransportOptions {
   checkMediaSegmentIntegrity? : boolean | undefined;
   lowLatencyMode : boolean;
   manifestLoader?: IManifestLoader | undefined;
-  manifestUpdateUrl? : string | undefined;
   referenceDateTime? : number | undefined;
   representationFilter? : IRepresentationFilter | undefined;
   segmentLoader? : ICustomSegmentLoader | undefined;
   serverSyncInfos? : IServerSyncInfos | undefined;
+  __priv_manifestUpdateUrl? : string | undefined;
   __priv_patchLastSegmentInSidx? : boolean | undefined;
 }