vCarousel/src/vCarousel.ts

133 lines
6.1 KiB
TypeScript

const errors=require("./errors.js");
// La classe vCarousel est instanciée en recevant un tableau contenant les ids des conteneurs HTML des vidéos à afficher successivement.
// Le tableau n'est pas dédoublonné, de manière à rester libre d'afficher plusieurs fois la même vidéo durant un tour du carrousel.
// Plusieurs options sont possibles :
// - firstVideoId est une chaîne permettant de fournir l'id du conteneur de la première vidéo à afficher lors de l'appel. Par défaut la première vidéo de la liste sera affichée. Si on passe une chaîne vide, aucune ne sera affichée.
// - playFirstVideo et playNextVideos demandent de lancer automatiquement la lecture, respectivement de la première vidéo demandée et de celles ensuite chargées. Ce n'est pas le cas par défaut et peut être bloqué par le navigateur.
// - noStop permet de demander à ce que les vidéos continuent à tourner, même quand toutes ont été affichées. Par défaut, le carrousel s'arrête.
interface videoDOM
{
id: string;
containerElt: HTMLElement;
videoElt: HTMLMediaElement;
}
export class vCarousel
{
private _vContainers: videoDOM[] = [];
private _firstVideoId: string|undefined = undefined;
private _playFirstVideo: boolean = false;
private _playNextVideos: boolean = false;
private _noStop: boolean = false;
private nbVContainers: number = 0;
private _currentVideo: HTMLMediaElement|undefined = undefined;
// Les ids reçus doivent correspondre à des éléments HTML contenant une vidéo :
set vContainers(vContainersIds: string[])
{
for(const containerId of vContainersIds)
{
const checkContainerExist=document.getElementById(containerId);
if(checkContainerExist === null)
throw new Error(errors.elementNotFound+containerId);
else
{
const checkVideoExist=<HTMLMediaElement>document.querySelector("#"+containerId+" video");
if(checkVideoExist === null)
throw new Error(errors.videoNotFound+containerId);
else
this._vContainers.push({id:containerId, containerElt:checkContainerExist, videoElt:checkVideoExist});
}
}
// Il faut au moins 2 vidéos à faire tourner :
this.nbVContainers=this._vContainers.length;
if(this.nbVContainers < 2)
throw new Error(errors.need2Videos);
}
// this._firstVideoId doit être résent dans la liste des conteneurs de vidéos :
set firstVideoId(firstVideo: string|undefined)
{
if((firstVideo !== undefined && firstVideo !== "" && this._vContainers.findIndex(video => video.id === firstVideo) !== -1) || ( firstVideo === ""))
this._firstVideoId=firstVideo;
}
get firstVideoId() : string|undefined
{
return this._firstVideoId;
}
set playFirstVideo(playFirstVideo: boolean)
{
this._playFirstVideo=playFirstVideo;
}
set playNextVideos(playNextVideos: boolean)
{
this._playNextVideos=playNextVideos;
}
set noStop(noStop: boolean)
{
this._noStop=noStop;
}
get currentVideo() : HTMLMediaElement|undefined
{
return this._currentVideo;
}
public run(): void
{
const vCarousel=this; // évite les confusions avec le "this" des événements plus bas.
if(vCarousel.nbVContainers < 2) // permet en fait de tester que le setter vContainers a bien été appelé
throw new Error(errors.needVideosProvided);
for (let i = 0; i < vCarousel.nbVContainers; i++)
{
const vContainer=vCarousel._vContainers[i].containerElt;
const video=vCarousel._vContainers[i].videoElt;
if((vCarousel._firstVideoId !== undefined && vCarousel._vContainers[i].id !== vCarousel._firstVideoId) || (vCarousel._firstVideoId === undefined && i !== 0) || vCarousel._firstVideoId === "")
vContainer.style.display="none";
else
{
// Si une vidéo est déjà visible et en cours de lecture, je la stoppe
// Sinon elle risque de continuer à être lue tout en étant cachée.
if(vCarousel._currentVideo !== undefined && ! vCarousel._currentVideo.paused)
vCarousel._currentVideo.pause();
// On affiche la première vidéo et essaye de la lancer, si cela est demandé :
vContainer.style.display="block";
vCarousel._currentVideo=video;
if(vCarousel._playFirstVideo)
video.play();
}
var nbTurn=0;
video.addEventListener("ended", function()
{
// Sauf si demandé, le carrousel s'arrête lorsque toutes les vidéos ont été affichées une fois :
if(nbTurn < (vCarousel.nbVContainers-1) || vCarousel._noStop)
{
vContainer.style.display="none";
let nextVContainer: HTMLElement, nextVideo: HTMLMediaElement, nextHash: string, nextOne=0;
if(i < (vCarousel.nbVContainers-1))
nextOne=i+1;
nextVContainer=vCarousel._vContainers[nextOne].containerElt;
nextVideo=vCarousel._vContainers[nextOne].videoElt;
nextHash=vCarousel._vContainers[nextOne].id;
nextVContainer.style.display="block";
vCarousel._currentVideo=nextVideo;
// Remise à zéro de la vidéo suivante pour permettre sa lecture :
nextVideo.currentTime=0;
// On adapte l'ancre de l'url de manière à ce qu'elle soit cohérente avec la vidéo affichée.
// Attention car cela peut provoquer un déplacement dans la page pour atteindre l'ancre.
window.location.assign("#"+nextHash);
// On essaye de lancer la vidéo, si demandé :
if(vCarousel._playNextVideos)
nextVideo.play();
nbTurn++;
}
});
}
}
}