rx-player/src/compat/make_vtt_cue.ts

Canal+ HTML5 Video Player

/**
 * 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.
 */

import log from "../log";
import globalScope from "../utils/global_scope";
import isNullOrUndefined from "../utils/is_null_or_undefined";
import type { ICompatVTTCue } from "./browser_compatibility_types";

/**
 * Creates a cue using the best platform-specific interface available.
 *
 * @param {Number} startTime
 * @param {Number} endTime
 * @param {string} payload
 * @returns {VTTCue|TextTrackCue|null} Text track cue or null if the parameters
 * were invalid.
 */
export default function makeCue(
  startTime: number,
  endTime: number,
  payload: string,
): ICompatVTTCue | TextTrackCue | null {
  if (startTime >= endTime) {
    // IE/Edge will throw in this case.
    // See issue #501
    log.warn("text", `Invalid cue times: start after end.`, { startTime, endTime });
    return null;
  }

  if (isNullOrUndefined(globalScope.VTTCue)) {
    if (isNullOrUndefined(globalScope.TextTrackCue)) {
      throw new Error("VTT cues not supported in your target");
    }
    return new (TextTrackCue as unknown as typeof VTTCue)(startTime, endTime, payload);
  } else {
    return new VTTCue(startTime, endTime, payload);
  }
}