rx-player
Version:
Canal+ HTML5 Video Player
76 lines (75 loc) • 2.52 kB
JavaScript
/**
* 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 { addFeatures } from "../../features";
import HTMLTextDisplayer from "../../main_thread/text_displayer/html";
/**
* Display custom text tracks in the given `textTrackElement`, synchronized
* with the given `videoElement`.
* @class TextTrackRenderer
*/
export default class TextTrackRenderer {
/**
* Add a given parser from the list of features.
* @param {Array.<Function>} parsersList
*/
static addParsers(parsersList) {
addFeatures(parsersList);
}
/**
* @param {Object} opts
* @param {HTMLMediaElement} opts.videoElement - The media element the text
* track has to be synchronized to.
* @param {HTMLElement} opt.textTrackElement - The HTML element which will
* contain the text tracks.
*/
constructor({ videoElement, textTrackElement, }) {
this._displayer = new HTMLTextDisplayer(videoElement, textTrackElement);
}
/**
* Set the currently displayed text track.
* Replace previous one if one was already set.
* @param {Object} args
*/
setTextTrack(args) {
this._displayer.reset();
const timestampOffset = typeof args.timeOffset === "number" ? args.timeOffset : 0;
this._displayer.pushTextData({
timestampOffset,
appendWindow: [0, Infinity],
chunk: {
start: 0,
end: Number.MAX_VALUE,
data: args.data,
language: args.language,
type: args.type,
},
});
}
/**
* Completely remove the current text track.
*/
removeTextTrack() {
this._displayer.removeBuffer(0, Number.MAX_VALUE);
}
/**
* Dispose of most ressources taken by the TextTrackRenderer.
* /!\ The TextTrackRenderer will be unusable after this method has been
* called.
*/
dispose() {
this._displayer.stop();
}
}