Add a segmentRequestHeaders option for DASH segment requests

src/main_thread/api/option_utils.ts

@@ -124,6 +124,8 @@ interface IParsedLoadVideoOptionsBase {
         workerId?: string | undefined;
       }
     | undefined;
+  /** @see ILoadVideoOptions.segmentRequestHeaders */
+  segmentRequestHeaders?: Record<string, string> | undefined;
   /** @see ILoadVideoOptions.serverSyncInfos */
   serverSyncInfos?: IServerSyncInfos | undefined;
   /** @see ILoadVideoOptions.mode */
@@ -567,6 +569,7 @@ function parseLoadVideoOptions(options: ILoadVideoOptions): IParsedLoadVideoOpti
     referenceDateTime: options.referenceDateTime,
     representationFilter,
     segmentLoader,
+    segmentRequestHeaders: options.segmentRequestHeaders,
     serverSyncInfos: options.serverSyncInfos,
     startAt,
     textTrackElement: textTrackElement as HTMLElement,

src/main_thread/api/public_api.ts

@@ -1017,6 +1017,7 @@ class Player extends EventEmitter<IPublicAPIEvent> {
       manifestLoader,
       referenceDateTime,
       segmentLoader,
+      segmentRequestHeaders,
       serverSyncInfos,
       experimentalOptions,
       __priv_manifestUpdateUrl,
@@ -1146,6 +1147,7 @@ class Player extends EventEmitter<IPublicAPIEvent> {
         serverSyncInfos,
         manifestLoader,
         segmentLoader,
+        segmentRequestHeaders,
         representationFilter: options.representationFilter,
         __priv_manifestUpdateUrl,
         __priv_patchLastSegmentInSidx,

src/public_types.ts

@@ -96,6 +96,15 @@ export interface ILoadVideoOptions {
    */
   lowLatencyMode?: boolean;
 
+  /**
+   * HTTP headers added to every DASH audio and video segment request,
+   * including initialization segments and low-latency chunked requests.
+   *
+   * These headers are not added to Manifest, text-track, thumbnail, or
+   * license requests.
+   */
+  segmentRequestHeaders?: Record<string, string> | undefined;
+
   requestConfig?: IRequestConfig;
 
   /** Indicate the position the RxPlayer should start at on the loaded content. */

src/transports/dash/init_segment_loader.ts

@@ -43,6 +43,7 @@ export default function initSegmentLoader(
   options: ISegmentLoaderOptions,
   cancelSignal: CancellationSignal,
   callbacks: ISegmentLoaderCallbacks<ArrayBuffer | Uint8Array<ArrayBuffer>>,
+  segmentRequestHeaders?: Record<string, string> | undefined,
 ): Promise<
   | ISegmentLoaderResultSegmentLoaded<ArrayBuffer | Uint8Array<ArrayBuffer>>
   | ISegmentLoaderResultSegmentCreated<ArrayBuffer | Uint8Array<ArrayBuffer>>
@@ -58,7 +59,10 @@ export default function initSegmentLoader(
     return request({
       url,
       responseType: "arraybuffer",
-      headers: cmcdHeaders,
+      headers:
+        segmentRequestHeaders === undefined
+          ? cmcdHeaders
+          : { ...segmentRequestHeaders, ...cmcdHeaders },
       timeout: options.timeout,
       connectionTimeout: options.connectionTimeout,
       cancelSignal,
@@ -70,6 +74,7 @@ export default function initSegmentLoader(
     return request({
       url,
       headers: {
+        ...segmentRequestHeaders,
         ...cmcdHeaders,
         Range: byteRange(segment.range),
       },
@@ -86,6 +91,7 @@ export default function initSegmentLoader(
     return request({
       url,
       headers: {
+        ...segmentRequestHeaders,
         ...cmcdHeaders,
         Range: byteRange([segment.range[0], segment.indexRange[1]]),
       },
@@ -100,6 +106,7 @@ export default function initSegmentLoader(
   const rangeRequest$ = request({
     url,
     headers: {
+      ...segmentRequestHeaders,
       ...cmcdHeaders,
       Range: byteRange(segment.range),
     },
@@ -112,6 +119,7 @@ export default function initSegmentLoader(
   const indexRequest$ = request({
     url,
     headers: {
+      ...segmentRequestHeaders,
       ...cmcdHeaders,
       Range: byteRange(segment.indexRange),
     },

src/transports/dash/segment_loader.ts

@@ -55,6 +55,7 @@ export async function regularSegmentLoader(
   initialUrl: string,
   context: ISegmentContext,
   lowLatencyMode: boolean,
+  segmentRequestHeaders: Record<string, string> | undefined,
   options: ISegmentLoaderOptions,
   callbacks: ISegmentLoaderCallbacks<ILoadedAudioVideoSegmentFormat>,
   cancelSignal: CancellationSignal,
@@ -70,6 +71,7 @@ export async function regularSegmentLoader(
       options,
       cancelSignal,
       callbacks,
+      segmentRequestHeaders,
     );
   }
 
@@ -82,14 +84,18 @@ export async function regularSegmentLoader(
     options.cmcdPayload?.type === "headers" ? options.cmcdPayload.value : undefined;
 
   const { segment } = context;
-  let headers;
+  let headers = segmentRequestHeaders;
   if (segment.range !== undefined) {
     headers = {
+      ...segmentRequestHeaders,
       ...cmcdHeaders,
       Range: byteRange(segment.range),
     };
   } else if (cmcdHeaders !== undefined) {
-    headers = cmcdHeaders;
+    headers = {
+      ...segmentRequestHeaders,
+      ...cmcdHeaders,
+    };
   }
 
   const containerType = inferSegmentContainer(context.type, context.mimeType);
@@ -132,10 +138,12 @@ export async function regularSegmentLoader(
 export default function generateSegmentLoader({
   lowLatencyMode,
   segmentLoader: customSegmentLoader,
+  segmentRequestHeaders,
   checkMediaSegmentIntegrity,
 }: {
   lowLatencyMode: boolean;
   segmentLoader?: ICustomSegmentLoader | undefined;
+  segmentRequestHeaders?: Record<string, string> | undefined;
   checkMediaSegmentIntegrity?: boolean | undefined;
 }): ISegmentLoader<Uint8Array<ArrayBuffer> | ArrayBuffer | null> {
   return checkMediaSegmentIntegrity !== true
@@ -174,6 +182,7 @@ export default function generateSegmentLoader({
         url,
         context,
         lowLatencyMode,
+        segmentRequestHeaders,
         options,
         callbacks,
         cancelSignal,
@@ -276,6 +285,7 @@ export default function generateSegmentLoader({
           url,
           context,
           lowLatencyMode,
+          segmentRequestHeaders,
           options,
           callbacks,
           cancelSignal,

src/transports/types.ts

@@ -908,6 +908,7 @@ export interface ITransportOptions {
   referenceDateTime?: number | undefined;
   representationFilter?: IRepresentationFilter | undefined;
   segmentLoader?: ICustomSegmentLoader | undefined;
+  segmentRequestHeaders?: Record<string, string> | undefined;
   serverSyncInfos?: IServerSyncInfos | undefined;
   __priv_manifestUpdateUrl?: string | undefined;
   __priv_patchLastSegmentInSidx?: boolean | undefined;