rx-player/src/parsers/texttracks/webvtt/native/to_native_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 type { ICompatVTTCue } from "../../../../compat/browser_compatibility_types";
import makeVTTCue from "../../../../compat/make_vtt_cue";
import type { IStyleElements } from "../parse_style_block";

/**
 * @param {Object} cueObj
 * @param {Object} _styling
 * @returns {TextTrackCue|ICompatVTTCue|null}
 */
export default function toNativeCue(
  cueObj: {
    start: number;
    end: number;
    settings: Partial<Record<string, string>>;
    header?: string | undefined;
    payload: string[];
  },
  _styling: { classes: IStyleElements; global?: string | undefined },
): ICompatVTTCue | TextTrackCue | null {
  // TODO: Some amount of styling?
  const { start, end, payload } = cueObj;
  const text = payload.join("\n");
  return makeVTTCue(start, end, text);
}