rx-player 4.0.0-dev.2023121900 → 4.0.0-rc.2

package/dist/commonjs/multithread_types.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file regroups TypeScript types and enums only needed when running the
+ * RxPlayer in a
+ * multithread situation.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/commonjs/parsers/manifest/dash/common/parse_periods.js

@@ -46,6 +46,7 @@ var log_1 = require("../../../../log");
 var flat_map_1 = require("../../../../utils/flat_map");
 var id_generator_1 = require("../../../../utils/id_generator");
 var is_null_or_undefined_1 = require("../../../../utils/is_null_or_undefined");
+var is_worker_1 = require("../../../../utils/is_worker");
 var monotonic_timestamp_1 = require("../../../../utils/monotonic_timestamp");
 var object_values_1 = require("../../../../utils/object_values");
 var string_parsing_1 = require("../../../../utils/string_parsing");
@@ -283,28 +284,25 @@ function generateStreamEvents(baseIr, periodStart, xmlNamespaces) {
                             undefined :
                             start + (eventIr.duration / timescale);
                         var element = void 0;
-                        if (eventIr.eventStreamData instanceof Element) {
+                        var xmlData = void 0;
+                        if (!is_worker_1.default && eventIr.eventStreamData instanceof Element) {
                             element = eventIr.eventStreamData;
                         }
                         else {
-                            // First, we will create a parent Element defining all namespaces that
-                            // should have been encountered until know.
-                            // This is needed because the DOMParser API might throw when
-                            // encountering unknown namespaced attributes or elements in the given
-                            // `<Event>` xml subset.
-                            var parentNode = allNamespaces.reduce(function (acc, ns) {
-                                return acc + "xmlns:" + ns.key + "=\"" + ns.value + "\" ";
-                            }, "<toremove ");
-                            parentNode += ">";
-                            var elementToString = (0, string_parsing_1.utf8ToStr)(new Uint8Array(eventIr.eventStreamData));
-                            element = new DOMParser()
-                                .parseFromString(parentNode + elementToString + "</toremove>", "application/xml")
-                                .documentElement
-                                .childNodes[0]; // unwrap from the `<toremove>` element
+                            try {
+                                xmlData = {
+                                    namespaces: allNamespaces,
+                                    data: (0, string_parsing_1.utf8ToStr)(new Uint8Array(eventIr.eventStreamData)),
+                                };
+                            }
+                            catch (err) {
+                                log_1.default.error("DASH: Error while parsing event-stream:", err instanceof Error ? err.message :
+                                    "Unknown error");
+                            }
                         }
                         res.push({ start: start, end: end, id: eventIr.id,
                             data: { type: "dash-event-stream",
-                                value: { schemeIdUri: schemeIdUri, timescale: timescale, element: element } } });
+                                value: { schemeIdUri: schemeIdUri, timescale: timescale, element: element, xmlData: xmlData } } });
                     }
                 }
             }

package/dist/commonjs/parsers/manifest/dash/js-parser/parse_from_document.js

@@ -40,7 +40,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-var assert_unreachable_1 = require("../../../../utils/assert_unreachable");
+var assert_1 = require("../../../../utils/assert");
 var is_null_or_undefined_1 = require("../../../../utils/is_null_or_undefined");
 var common_1 = require("../common");
 var MPD_1 = require("./node_parsers/MPD");
@@ -124,7 +124,7 @@ function parseFromDocument(document, args) {
             };
         }
         else {
-            (0, assert_unreachable_1.default)(initialRes);
+            (0, assert_1.assertUnreachable)(initialRes);
         }
     }
 }

package/dist/commonjs/parsers/manifest/dash/wasm-parser/ts/dash-wasm-parser.d.ts

@@ -107,5 +107,5 @@ export default class DashWasmParser {
 }
 /** Options needed when constructing the DASH-WASM parser. */
 export interface IDashWasmParserOptions {
-    wasmUrl: string;
+    wasmUrl: string | ArrayBuffer;
 }

package/dist/commonjs/parsers/manifest/dash/wasm-parser/ts/dash-wasm-parser.js

@@ -67,9 +67,10 @@ var __read = (this && this.__read) || function (o, n) {
     return ar;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-var global_scope_1 = require("../../../../../compat/global_scope");
+var has_webassembly_1 = require("../../../../../compat/has_webassembly");
 var log_1 = require("../../../../../log");
-var assert_unreachable_1 = require("../../../../../utils/assert_unreachable");
+var assert_1 = require("../../../../../utils/assert");
+var global_scope_1 = require("../../../../../utils/global_scope");
 var noop_1 = require("../../../../../utils/noop");
 var common_1 = require("../../common");
 var generators_1 = require("./generators");
@@ -188,7 +189,7 @@ var DashWasmParser = /** @class */ (function () {
                 self._mpdData.cursor += sizeToRead;
                 return sizeToRead;
             }
-            var parsersStack, textDecoder, self, imports, fetchedWasm, streamingProm;
+            var parsersStack, textDecoder, self, imports, objectUrl, fetchedWasm, streamingProm;
             var _this = this;
             return __generator(this, function (_a) {
                 if (this.status !== "uninitialized") {
@@ -215,7 +216,14 @@ var DashWasmParser = /** @class */ (function () {
                         onTagClose: onTagClose,
                     },
                 };
-                fetchedWasm = fetch(opts.wasmUrl);
+                objectUrl = null;
+                if (typeof opts.wasmUrl === "string") {
+                    fetchedWasm = fetch(opts.wasmUrl);
+                }
+                else {
+                    objectUrl = URL.createObjectURL(new Blob([opts.wasmUrl], { type: "application/wasm" }));
+                    fetchedWasm = fetch(objectUrl);
+                }
                 streamingProm = typeof WebAssembly.instantiateStreaming === "function" ?
                     WebAssembly.instantiateStreaming(fetchedWasm, imports) :
                     Promise.reject("`WebAssembly.instantiateStreaming` API not available");
@@ -225,6 +233,10 @@ var DashWasmParser = /** @class */ (function () {
                     return __generator(this, function (_a) {
                         switch (_a.label) {
                             case 0:
+                                if (objectUrl !== null) {
+                                    URL.revokeObjectURL(objectUrl);
+                                    objectUrl = null;
+                                }
                                 log_1.default.warn("Unable to call `instantiateStreaming` on WASM", e instanceof Error ? e : "");
                                 return [4 /*yield*/, fetchedWasm];
                             case 1:
@@ -240,6 +252,10 @@ var DashWasmParser = /** @class */ (function () {
                     });
                 }); })
                     .then(function (instanceWasm) {
+                    if (objectUrl !== null) {
+                        URL.revokeObjectURL(objectUrl);
+                        objectUrl = null;
+                    }
                     _this._instance = instanceWasm;
                     // TODO better types?
                     _this._linearMemory = _this._instance.instance.exports.memory;
@@ -275,8 +291,7 @@ var DashWasmParser = /** @class */ (function () {
      * @returns {boolean}
      */
     DashWasmParser.prototype.isCompatible = function () {
-        return typeof WebAssembly === "object" &&
-            typeof WebAssembly.instantiate === "function" &&
+        return has_webassembly_1.default &&
             typeof global_scope_1.default.TextDecoder === "function";
     };
     DashWasmParser.prototype._parseMpd = function (mpd) {
@@ -388,7 +403,7 @@ var DashWasmParser = /** @class */ (function () {
                     continue: continueParsingMPD } };
         }
         else {
-            (0, assert_unreachable_1.default)(initialRes);
+            (0, assert_1.assertUnreachable)(initialRes);
         }
     };
     return DashWasmParser;

package/dist/commonjs/parsers/manifest/dash/wasm-parser/ts/types.d.ts

@@ -68,66 +68,66 @@ export declare const enum AttributeName {
     Duration = 1,
     Profiles = 2,
     AudioSamplingRate = 3,
-    Codecs = 4,
+    Codecs = 4,// String
     CodingDependency = 5,
     FrameRate = 6,
-    Height = 7,
-    Width = 8,
+    Height = 7,// f64
+    Width = 8,// f64
     MaxPlayoutRate = 9,
     MaxSAPPeriod = 10,
-    MimeType = 11,
+    MimeType = 11,// f64
     SegmentProfiles = 12,
-    ContentProtectionValue = 13,
-    ContentProtectionKeyId = 14,
-    ContentProtectionCencPSSH = 15,
-    SchemeIdUri = 16,
-    SchemeValue = 17,
-    MediaRange = 18,
-    SegmentTimeline = 19,
-    StartNumber = 20,
-    SegmentBaseSegment = 21,
-    AvailabilityTimeComplete = 22,
-    IndexRangeExact = 23,
-    PresentationTimeOffset = 24,
-    EventPresentationTime = 25,
-    Element = 26,
-    TimeScale = 27,
-    Index = 28,
-    InitializationRange = 29,
-    Media = 30,
-    IndexRange = 31,
-    BitstreamSwitching = 32,
-    Type = 33,
-    AvailabilityStartTime = 34,
-    AvailabilityEndTime = 35,
-    PublishTime = 36,
-    MinimumUpdatePeriod = 37,
-    MinBufferTime = 38,
-    TimeShiftBufferDepth = 39,
-    SuggestedPresentationDelay = 40,
-    MaxSegmentDuration = 41,
-    MaxSubsegmentDuration = 42,
-    AvailabilityTimeOffset = 43,
-    BaseUrlValue = 44,
-    Start = 45,
-    XLinkHref = 46,
-    XLinkActuate = 47,
+    ContentProtectionValue = 13,// String
+    ContentProtectionKeyId = 14,// ArrayBuffer
+    ContentProtectionCencPSSH = 15,// ArrayBuffer
+    SchemeIdUri = 16,// String
+    SchemeValue = 17,// String
+    MediaRange = 18,// [f64, f64]
+    SegmentTimeline = 19,// Vec<SElement>
+    StartNumber = 20,// f64
+    SegmentBaseSegment = 21,// SegmentBaseSegment
+    AvailabilityTimeComplete = 22,// u8 (bool)
+    IndexRangeExact = 23,// u8 (bool)
+    PresentationTimeOffset = 24,// f64
+    EventPresentationTime = 25,// f64
+    Element = 26,// String (XML)
+    TimeScale = 27,// f64
+    Index = 28,// String
+    InitializationRange = 29,// [f64, f64]
+    Media = 30,// String
+    IndexRange = 31,// [f64, f64]
+    BitstreamSwitching = 32,// u8 (bool)
+    Type = 33,// String
+    AvailabilityStartTime = 34,// f64
+    AvailabilityEndTime = 35,// f64
+    PublishTime = 36,// f64
+    MinimumUpdatePeriod = 37,// f64
+    MinBufferTime = 38,// f64
+    TimeShiftBufferDepth = 39,// f64
+    SuggestedPresentationDelay = 40,// f64
+    MaxSegmentDuration = 41,// f64
+    MaxSubsegmentDuration = 42,// f64
+    AvailabilityTimeOffset = 43,// f64
+    BaseUrlValue = 44,// String
+    Start = 45,// f64
+    XLinkHref = 46,// String
+    XLinkActuate = 47,// String
     Group = 48,
-    MaxBandwidth = 49,
-    MaxFrameRate = 50,
-    MaxHeight = 51,
-    MaxWidth = 52,
-    MinBandwidth = 53,
-    MinFrameRate = 54,
-    MinHeight = 55,
-    MinWidth = 56,
+    MaxBandwidth = 49,// f64
+    MaxFrameRate = 50,// f64
+    MaxHeight = 51,// f64
+    MaxWidth = 52,// f64
+    MinBandwidth = 53,// f64
+    MinFrameRate = 54,// f64
+    MinHeight = 55,// f64
+    MinWidth = 56,// f64
     SelectionPriority = 57,
     SegmentAlignment = 58,
     SubsegmentAlignment = 59,
-    Language = 60,
-    ContentType = 61,
+    Language = 60,// String
+    ContentType = 61,// String
     Par = 62,
-    Bitrate = 63,
+    Bitrate = 63,// f64
     Text = 64,
     QualityRanking = 65,
     Location = 66,
@@ -135,11 +135,11 @@ export declare const enum AttributeName {
     MediaPresentationDuration = 68,
     EventStreamEltRange = 69,
     Namespace = 70,
-    Label = 71,
-    ServiceLocation = 72,
-    QueryBeforeStart = 73,
-    ProxyServerUrl = 74,
+    Label = 71,// String
+    ServiceLocation = 72,// String
+    QueryBeforeStart = 73,// Boolean
+    ProxyServerUrl = 74,// String
     DefaultServiceLocation = 75,
-    EndNumber = 76,
+    EndNumber = 76,// f64
     SupplementalCodecs = 77
 }

package/dist/commonjs/parsers/manifest/metaplaylist/metaplaylist_parser.js

@@ -40,6 +40,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+var log_1 = require("../../../log");
 var manifest_1 = require("../../../manifest");
 var id_generator_1 = require("../../../utils/id_generator");
 var monotonic_timestamp_1 = require("../../../utils/monotonic_timestamp");
@@ -166,6 +167,16 @@ function createManifest(mplData, manifests, parserOptions) {
                             periodEnd: currentPeriod.end,
                         };
                         var newIndex = new representation_index_1.default(currentRepresentation.index, [contentOffset, contentEnd], content.transport, baseContentMetadata);
+                        var supplementalCodecs = void 0;
+                        if (currentRepresentation.codecs.length > 1) {
+                            if (currentRepresentation.codecs.length > 2) {
+                                log_1.default.warn("MP: MetaPlaylist relying on more than 2 groups of " +
+                                    "codecs with retro-compatibility");
+                            }
+                            supplementalCodecs = currentRepresentation.codecs[0];
+                        }
+                        var codecs = currentRepresentation
+                            .codecs[currentRepresentation.codecs.length - 1];
                         representations.push({
                             bitrate: currentRepresentation.bitrate,
                             index: newIndex,
@@ -175,7 +186,8 @@ function createManifest(mplData, manifests, parserOptions) {
                             width: currentRepresentation.width,
                             mimeType: currentRepresentation.mimeType,
                             frameRate: currentRepresentation.frameRate,
-                            codecs: currentRepresentation.codec,
+                            codecs: codecs,
+                            supplementalCodecs: supplementalCodecs,
                             isSpatialAudio: currentRepresentation.isSpatialAudio,
                             contentProtections: currentRepresentation.contentProtections,
                         });

package/dist/commonjs/parsers/manifest/smooth/parse_protection_node.js

@@ -24,7 +24,7 @@ var isobmff_1 = require("../../containers/isobmff");
  * @returns {Array.<Object>}
  */
 function createWidevineKeySystem(keyIdBytes) {
-    return [{ systemId: "edef8ba9-79d6-4ace-a3c8-27dcd51d21ed",
+    return [{ systemId: "edef8ba9-79d6-4ace-a3c8-27dcd51d21ed", // Widevine
             privateData: (0, byte_parsing_1.concat)([0x08, 0x01, 0x12, 0x10], keyIdBytes) }];
 }
 /**

package/dist/commonjs/parsers/manifest/types.d.ts

@@ -26,7 +26,14 @@ export interface IParsedStreamEventData {
     value: {
         schemeIdUri: string;
         timescale: number;
-        element: Element;
+        element?: Element | undefined;
+        xmlData?: {
+            namespaces: Array<{
+                key: string;
+                value: string;
+            }>;
+            data: string;
+        } | undefined;
     };
 }
 /** Describes information about an encryption Key ID of a given media. */

package/dist/commonjs/public_types.d.ts

@@ -1,30 +1,22 @@
 /**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * This file defines and exports types we want to expose to library users.
+ * Those types are considered as part of the API.
  */
 import { IPreferredEmeApiType } from "./compat/eme";
 import { IPersistentSessionInfoV0, IPersistentSessionInfoV1, IPersistentSessionInfoV2, IPersistentSessionInfoV3, IPersistentSessionInfoV4 } from "./core/decrypt";
-import { IMediaErrorTrackContext, EncryptedMediaError, MediaError, NetworkError, OtherError } from "./errors";
-import Manifest from "./manifest";
+import { EncryptedMediaError, MediaError, NetworkError, OtherError } from "./errors";
+import Manifest, { ITaggedTrack } from "./manifest";
 import { ILocalManifest } from "./parsers/manifest/local";
 import { IMetaPlaylist } from "./parsers/manifest/metaplaylist/metaplaylist_parser";
-export { IMediaErrorTrackContext };
+export { ITaggedTrack as IMediaErrorTrackContext };
 export { IPreferredEmeApiType };
-/**
- * This file defines and exports types we want to expose to library users.
- * Those types are considered as part of the API.
- */
+/** `mode` option for the `loadVideo` method */
+export type IRxPlayerMode = "auto" | "main" | "multithread";
+/** Argument of the `attachWorker` method. */
+export interface IWorkerSettings {
+    workerUrl: string | Blob;
+    dashWasmUrl: string | ArrayBuffer;
+}
 /** Every options that can be given to the RxPlayer's constructor. */
 export interface IConstructorOptions {
     maxBufferAhead?: number;
@@ -115,11 +107,16 @@ export interface ILoadVideoOptions {
     /** Custom implementation for performing segment requests. */
     segmentLoader?: ISegmentLoader;
     /** Custom logic to filter out unwanted qualities. */
-    representationFilter?: IRepresentationFilter;
+    representationFilter?: IRepresentationFilter | string;
     /** Base time for the segments in case it is not found in the Manifest. */
     referenceDateTime?: number;
     /** Allows to synchronize the server's time with the client's. */
     serverSyncInfos?: IServerSyncInfos;
+    /**
+     * Allows to force the RxPlayer to run in a specific "mode" (e.g.
+     * in "multithread" mode) for that content.
+     */
+    mode?: IRxPlayerMode | undefined;
 }
 /** Value of the `serverSyncInfos` transport option. */
 export interface IServerSyncInfos {
@@ -862,6 +859,28 @@ export interface IAudioTrackSetting {
      * Keeping it undefined means that all compatible qualities may be played.
      */
     lockedRepresentations?: string[] | undefined;
+    /**
+     * This only has an effect if the track switching operation lead to a small
+     * playback interruption (which can only happen if `switchingMode` is either
+     * set to `"reload"` or in some cases when it is undefined).
+     *
+     * `relativeResumingPosition` corresponds to the relative time in seconds at
+     * which we will resume playback with the new track.
+     *
+     * For example if switching from an audio track `A` to an audio track `B` at
+     * position `20` (seconds) and setting `relativeResumingPosition` to `-1`, we
+     * will resume playback with the audio track `B` at position `19`.
+     *
+     * You might want to set this value generally either because you want to
+     * replay some audio content after switching the audio track to give back
+     * context (e.g. picking back at the same sentence in the language of the new
+     * audio track) or to ensure the exact same position is played by setting it
+     * to `0`.
+     *
+     * If not set or set to `undefined`, the RxPlayer will automatically choose
+     * a suitable default value instead.
+     */
+    relativeResumingPosition?: number | undefined;
 }
 export interface IVideoTrackSetting {
     /** `id` of the video track you want to set. */
@@ -884,6 +903,28 @@ export interface IVideoTrackSetting {
      * Keeping it undefined means that all compatible qualities may be played.
      */
     lockedRepresentations?: string[] | undefined;
+    /**
+     * This only has an effect if the track switching operation lead to a small
+     * playback interruption (which can only happen if `switchingMode` is either
+     * set to `"reload"`, `"flush"` or in some cases when it is undefined).
+     *
+     * `relativeResumingPosition` corresponds to the relative time in seconds at
+     * which we will resume playback with the new track.
+     *
+     * For example if switching from a video track `A` to a video track `B` at
+     * position `20` (seconds) and setting `relativeResumingPosition` to `-1`, we
+     * will resume playback with the video track `B` at position `19` (only if the
+     * track switch operation led to a playback interruption, see top of comment).
+     *
+     * You might want to set this value generally either because you want to
+     * replay some video content after switching the video track to give back
+     * context or to ensure the exact same position is played by setting it to
+     * `0`.
+     *
+     * If not set or set to `undefined`, the RxPlayer will automatically choose
+     * a suitable default value instead.
+     */
+    relativeResumingPosition?: number | undefined;
 }
 export interface ITextTrackSetting {
     /** `id` of the text track you want to set. */
@@ -894,3 +935,7 @@ export interface ITextTrackSetting {
      */
     periodId?: string | undefined;
 }
+export interface IModeInformation {
+    isDirectFile: boolean;
+    useWorker: boolean;
+}

package/dist/commonjs/public_types.js

@@ -1,17 +1,7 @@
 "use strict";
 /**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * This file defines and exports types we want to expose to library users.
+ * Those types are considered as part of the API.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+;

package/dist/commonjs/text_displayer/html/html_parsers.d.ts

@@ -0,0 +1,15 @@
+export interface IHTMLCue {
+    start: number;
+    end: number;
+    element: HTMLElement;
+}
+/**
+ * Convert text track data into timed HTML Cues.
+ * @param {string} type - Text track format wanted
+ * @param {string} data - Text track data
+ * @param {Number} timestampOffset - offset to apply to every timed text
+ * @param {string} [language] - language of the text tracks
+ * @returns {Array.<Object>}
+ * @throws Error - Throw if no parser is found for the given type
+ */
+export default function parseTextTrackToElements(type: string, data: string, timestampOffset: number, language?: string): IHTMLCue[];

package/dist/commonjs/text_displayer/html/html_parsers.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var features_1 = require("../../features");
+var log_1 = require("../../log");
+/**
+ * Convert text track data into timed HTML Cues.
+ * @param {string} type - Text track format wanted
+ * @param {string} data - Text track data
+ * @param {Number} timestampOffset - offset to apply to every timed text
+ * @param {string} [language] - language of the text tracks
+ * @returns {Array.<Object>}
+ * @throws Error - Throw if no parser is found for the given type
+ */
+function parseTextTrackToElements(type, data, timestampOffset, language) {
+    log_1.default.debug("HTSB: Finding parser for html text tracks:", type);
+    var parser = features_1.default.htmlTextTracksParsers[type];
+    if (typeof parser !== "function") {
+        throw new Error("no parser found for the given text track");
+    }
+    log_1.default.debug("HTSB: Parser found, parsing...");
+    var parsed = parser(data, timestampOffset, language);
+    log_1.default.debug("HTTB: Parsed successfully!", parsed.length);
+    return parsed;
+}
+exports.default = parseTextTrackToElements;

package/dist/commonjs/text_displayer/html/html_text_displayer.d.ts

@@ -0,0 +1,100 @@
+import { IRange } from "../../utils/ranges";
+import { ITextDisplayer, ITextDisplayerData } from "../types";
+/**
+ * TextDisplayer implementation which display buffered TextTracks in the given
+ * HTML element.
+ * @class HTMLTextDisplayer
+ */
+export default class HTMLTextDisplayer implements ITextDisplayer {
+    /**
+     * The video element the cues refer to.
+     * Used to know when the user is seeking, for example.
+     */
+    private readonly _videoElement;
+    /** Allows to cancel the interval at which subtitles are updated. */
+    private _subtitlesIntervalCanceller;
+    /** HTMLElement which will contain the cues */
+    private readonly _textTrackElement;
+    /** Buffer containing the data */
+    private readonly _buffer;
+    /**
+     * We could need us to automatically update styling depending on
+     * `_textTrackElement`'s size. This TaskCanceller allows to stop that
+     * regular check.
+     */
+    private _sizeUpdateCanceller;
+    /** Information on cues currently displayed. */
+    private _currentCues;
+    /** TimeRanges implementation for this buffer. */
+    private _buffered;
+    /**
+     * If `true`, we're currently automatically refreshing subtitles in intervals
+     * (and on some playback events) based on the polled current position.
+     *
+     * TODO link it to `_subtitlesIntervalCanceller`? Or just use
+     * `_subtitlesIntervalCanceller.isUsed`? To check.
+     */
+    private _isAutoRefreshing;
+    /**
+     * @param {HTMLMediaElement} videoElement
+     * @param {HTMLElement} textTrackElement
+     */
+    constructor(videoElement: HTMLMediaElement, textTrackElement: HTMLElement);
+    /**
+     * Push text segment to the HTMLTextDisplayer.
+     * @param {Object} infos
+     * @returns {Object}
+     */
+    pushTextData(infos: ITextDisplayerData): IRange[];
+    /**
+     * Remove buffered data.
+     * @param {number} start - start position, in seconds
+     * @param {number} end - end position, in seconds
+     * @returns {Object}
+     */
+    removeBuffer(start: number, end: number): IRange[];
+    /**
+     * Returns the currently buffered data, in a TimeRanges object.
+     * @returns {TimeRanges}
+     */
+    getBufferedRanges(): IRange[];
+    reset(): void;
+    stop(): void;
+    /**
+     * Remove the current cue from being displayed.
+     */
+    private _disableCurrentCues;
+    /**
+     * Display a new Cue. If one was already present, it will be replaced.
+     * @param {HTMLElement} elements
+     */
+    private _displayCues;
+    /**
+     * Auto-refresh the display of subtitles according to the media element's
+     * position and events.
+     * @param {Object} cancellationSignal
+     */
+    private autoRefreshSubtitles;
+    /**
+     * Refresh current subtitles according to the current media element's
+     * position.
+     */
+    private refreshSubtitles;
+}
+/** Data of chunks that should be pushed to the `HTMLTextDisplayer`. */
+export interface ITextTracksBufferSegmentData {
+    /** The text track data, in the format indicated in `type`. */
+    data: string;
+    /** The format of `data` (examples: "ttml", "srt" or "vtt") */
+    type: string;
+    /**
+     * Language in which the text track is, as a language code.
+     * This is mostly needed for "sami" subtitles, to know which cues can / should
+     * be parsed.
+     */
+    language?: string | undefined;
+    /** start time from which the segment apply, in seconds. */
+    start?: number | undefined;
+    /** end time until which the segment apply, in seconds. */
+    end?: number | undefined;
+}