Joueur(étiquette, optionsopter , prêtopter)

Une instance de la Joueur La classe est créée lorsque l'une des méthodes de configuration Video.js est utilisée pour initialiser une vidéo.

Une fois qu'une instance a été créée, elle est accessible globalement de deux manières :

  1. En appelant videojs ('example_video_1') ;
  2. En l'utilisant directement via videojs.players.example_video_1 ;

Nouveau Joueur(étiquette, optionsopter , prêtopter)
player.js, ligne 292

Créez une instance de cette classe.

Paramètres :
Prénom Type Attributs Description
étiquette Element

L'élément DOM vidéo d'origine utilisé pour configurer les options.
options Objet <facultatif>

Les noms et valeurs des objets d'options.
prêt Composant ~ Ready Callback <facultatif>

Fonction de rappel prêt.

S'étend

Membres

lecteurs statiques : Object
player.js, ligne 5243

Dénombrement mondial des joueurs.

Les clés sont les identifiants des joueurs et les valeurs sont soit les Joueur exemple ou nul pour les joueurs disposés.

origine croisée
player.js, ligne 5233

Obtenez ou définissez le Joueurl'option d'origine croisée. Pour le lecteur HTML5, cela définit le croixOrigine propriété sur le < vidéo> balise pour contrôler le comportement de CORS.

Voir :

Méthodes

statique getTagSettings(tag) → {Objet}
player.js, ligne 5020

Obtient les paramètres d'étiquette

Paramètres :
Prénom Type Description
étiquette Element

Le tag joueur
Retours :
Objet -

Un objet contenant tous les paramètres d'une balise de lecteur

$(selector, contextopt) → {Element|null}
component.js, ligne 778

Trouvez un seul élément DOM correspondant à un sélecteur. Cela peut être dans le Composants contenuEl() ou un autre contexte personnalisé.

Paramètres :
Prénom Type Attributs Défaut Description
sélecteur chaîne

Un sélecteur CSS valide, qui sera transmis à QuerySelector.
contexte Element | chaîne <facultatif>
 Ce .contenTel ()

Un élément DOM dans lequel effectuer une requête. Il peut également s'agir d'une chaîne de sélection, auquel cas le premier élément correspondant sera utilisé comme contexte. S'il manque This.contentel () est utilisé. Si this.contenTel () ne renvoie rien, il revient au document.
Retours :
Element | null -

l'élément dom qui a été trouvé, ou null

Remplace :
Voir :

$$(selector, contextopt) → {NodeList}
component.js, ligne 800

Recherche tous les éléments DOM correspondant à un sélecteur. Cela peut être dans le Composants contenuEl() ou un autre contexte personnalisé.

Paramètres :
Prénom Type Attributs Défaut Description
sélecteur chaîne

Un sélecteur CSS valide, qui sera transmis à QuerySelectorAll.
contexte Element | chaîne <facultatif>
 Ce .contenTel ()

Un élément DOM dans lequel effectuer une requête. Il peut également s'agir d'une chaîne de sélection, auquel cas le premier élément correspondant sera utilisé comme contexte. S'il manque This.contentel () est utilisé. Si this.contenTel () ne renvoie rien, il revient au document.
Retours :
NodeList -

une liste des éléments Dom qui ont été trouvés

Remplace :
Voir :

addChild(child, optionsopt, indexopt) → {Component}
component.js, ligne 469

Ajoutez un composant enfant dans le composant actuel.

Paramètres :
Prénom Type Attributs Défaut Description
enfant chaîne | Composant

Le nom ou l'instance d'un enfant à ajouter.
options Objet <facultatif>
 {}

Le magasin de clé/valeur des options qui seront transmises aux enfants de l'enfant.
index numéro <facultatif>
 cette longueur .children_.length

L'index dans laquelle tenter d'ajouter un enfant.
Retours :
Composante-

Composant qui est ajouté en tant qu'enfant. Lors de l'utilisation d'une chaîne, le Composant sera créé par ce processus.

Remplace :

Ajouter une classe(classe à ajouter)
component.js, ligne 824

Ajoutez un nom de classe CSS à l' élément Component.

Paramètres :
Prénom Type Description
Classe à ajouter chaîne

Nom de classe CSS à ajouter
Remplace :

addRemoteTextTrack(options, manualCleanupopt) → {HtmlTrackElement}
player.js, ligne 4542

Créez un TextTrack distant et un élément HTMLTrackElement. Lorsque manualCleanup est défini sur false, la piste sera automatiquement supprimée lors des changements de source.

Paramètres :
Prénom Type Attributs Défaut Description
options Objet

Options à transmettre à HtmlTrkElement lors de la création. Voir HtmlTrackElement pour connaître les propriétés d'objet que vous devez utiliser.

Nettoyage manuel booléen <facultatif>
 true

s'il est défini sur false, le TextTrack sera supprimé lors d'un changement de source
Retours :
HtmlTrackElement -

le HTMLTrackElement qui a été créé et ajouté au HtmlTrackElementList et au TextTrackList distant

Obsolète :
  • La valeur par défaut du paramètre « ManualCleanup » sera par défaut « false » dans les prochaines versions de Video.js.

addTextTrack(kindopt, labelopt, languageopt) → {TextTrack|indéfini}
player.js, ligne 4516

Méthode d'aide pour ajouter un TextTrack à notre TextTrackList.

En plus des paramètres du W3C, nous autorisons l'ajout d'informations supplémentaires via des options.

Paramètres :
Prénom Type Attributs Description
gentil chaîne <facultatif>

le type de TextTrack que vous ajoutez
étiquette chaîne <facultatif>

l'étiquette pour donner l'étiquette TextTrack
langue chaîne <facultatif>

la langue à définir sur le TextTrack
Retours :
TextTrack | non défini -

TextTrack qui a été ajouté ou non défini s'il n'y a pas de technologie

Voir :

aspectRatio(ratioopt) → {string|undefined}
player.js, ligne 1017

Un getter/setter pour le Joueurrapport d'aspect de.

Paramètres :
Prénom Type Attributs Description
ratio chaîne <facultatif>

La valeur pour définir le Joueurrapport d'aspect à.
Retours :
string | indéfini -
  • Le rapport d'aspect actuel du lecteur lorsqu'il est obtenu. - indéfini lors de la définition

audioOnlyMode(valueopt) → {Promesse|booléen}
player.js, ligne 4370

Obtenir l'état actuel de l'audioOnlyMode ou définir l'audioOnlyMode sur true ou false.

La valeur true permet de masquer tous les composants du lecteur à l'exception de la barre de contrôle, ainsi que les composants de la barre de contrôle nécessaires uniquement pour la vidéo.

Paramètres :
Prénom Type Attributs Description
valeur booléen <facultatif>

Valeur à attribuer à audioOnlyMode.
Retours :
Promesse | booléenne -

Une promesse est renvoyée lors de la définition de l'état, et un booléen lors de l'obtention de l'état actuel

audioPosterMode(valueopt) → {Promesse|booléen}
player.js, ligne 4447

Obtenir l'état actuel de audioPosterMode ou définir audioPosterMode à true ou false

Paramètres :
Prénom Type Attributs Description
valeur booléen <facultatif>

La valeur à attribuer à audioPosterMode.
Retours :
Promesse | booléenne -

Une promesse est renvoyée lors de la définition de l'état, et un booléen lors de l'obtention de l'état actuel

audioTracks() → {AudioTrackList}
player.js, ligne 5164

Obtenir la liste AudioTrackList

Retours :
Liste des pistes audio -

la liste des pistes audio actuelles

autoplay(valueopt) → {booléen|chaîne}
player.js, ligne 3721

Obtenez ou définissez l'option de lecture automatique. Lorsqu'il s'agit d'un booléen, il modifiera l'attribut sur la technologie. Lorsqu'il s'agit d'une chaîne, l'attribut sur la technologie sera supprimé et Joueur gérera la lecture automatique au démarrage du chargement.

Paramètres :
Prénom Type Attributs Description
valeur booléen | chaîne de caractères <facultatif>
  • true : autoplay en utilisant le comportement du navigateur - false : pas d'autoplay - 'play' : appeler play() à chaque chargement - 'muted' : appeler muted() puis play() à chaque chargement - 'any' : appeler play() à chaque chargement. en cas d'échec, appeler muted() puis play(). - * : les valeurs autres que celles listées ici seront réglées sur " autoplay" à true
Retours :
booléen | chaîne de caractères -

La valeur actuelle de la lecture automatique lors de l'obtention

flou()
component.js, ligne 1164

Supprimer le focus de ce composant

Remplace :

breakpoints(breakpointsopt) → {Objet}
player.js, ligne 4800

Obtenez ou définissez des points d'arrêt sur le lecteur.

Appeler cette méthode avec un objet ou vrai supprimera tous les points d'arrêt personnalisés précédents et recommencera à partir des valeurs par défaut.

Paramètres :
Prénom Type Attributs Description
points d'arrêt Objet | booléen <facultatif>

Si un objet est fourni, il peut être utilisé pour fournir des points d'arrêt personnalisés. Si vrai est donné, définira des points d'arrêt par défaut. Si cet argument n'est pas fourni, renverra simplement les points d'arrêt actuels.

Propriétés
Prénom Type Attributs Description
minuscule numéro <facultatif>

La largeur maximale de la classe "vjs-layout-tiny".
très petit numéro <facultatif>

La largeur maximale de la classe "vjs-layout-x-small".
petit numéro <facultatif>

La largeur maximale de la classe "vjs-layout-small".
moyen numéro <facultatif>

La largeur maximale de la classe "vjs-layout-medium".
grand numéro <facultatif>

La largeur maximale de la classe "vjs-layout-large".
xlarge numéro <facultatif>

La largeur maximale de la classe "vjs-layout-x-large".
énorme numéro <facultatif>

La largeur maximale de la classe "vjs-layout-huge".
Retours :
Objet -

Un objet mappant les noms des points d'arrêt aux valeurs de largeur maximale.

buffered() → {TimeRange}
player.js, ligne 2651

Obtenez un objet TimeRange avec un tableau des heures de la vidéo téléchargée. Si vous voulez simplement le pourcentage de la vidéo téléchargée, utilisez BufferedPercent.

Retours :
Plage de temps -

Un objet TimeRange simulé (suivant les spécifications HTML)

Voir :

bufferedEnd() → {nombre}
player.js, ligne 2680

Obtenir l'heure de fin de la dernière plage temporelle mise en mémoire tampon Cette option est utilisée dans la barre de progression pour encapsuler toutes les plages horaires.

Retours :
numéro -

La fin de la dernière plage temporelle mise en mémoire tampon

bufferedPercent() → {nombre}
player.js, ligne 2669

Obtenez le pourcentage (sous forme décimale) de la vidéo téléchargée. Cette méthode ne fait pas partie de l'API vidéo HTML native.

Retours :
numéro -

Une décimale entre 0 et 1 représentant le pourcentage mis en mémoire tampon 0 étant 0% et 1 étant 100%

abstrait buildCSSClass() → {string}
component.js, ligne 695

Construit le nom de classe DOM par défaut. Doive être remplacée par des sous-composants.

Retours :
corde -

Nom de classe DOM de cet objet.

Remplace :

cancelAnimationFrame(id) → {nombre}
component.js, ligne 1598

Annule un rappel en file d'attente transmis au composant #requestAnimationFrame (RaF).

Si vous placez en file d'attente un rappel RaF via Component #requestAnimationFrame, utilisez cette fonction au lieu de Window.CancelAnimationFrame. Si ce n'est pas le cas, votre écouteur Dispose ne sera pas nettoyé avant le composant #dispose!

Paramètres :
Prénom Type Description
ID numéro

L'ID RaF à effacer. La valeur de retour du composant #requestAnimationFrame.
Retours :
numéro -

Renvoie l'ID RaF qui a été effacé.

Remplace :
Voir :

Cadre d'animation CancelNamedAnimation(nom)
component.js, ligne 1573

Annule une image d'animation nommée actuelle si elle existe.

Paramètres :
Prénom Type Description
nom chaîne

Nom du RequestAnimationFrame à annuler.
Remplace :

canPlayType(type) → {string}
player.js, ligne 3271

Vérifiez si le joueur peut jouer un type MIME donné

Paramètres :
Prénom Type Description
type chaîne

Le type MIME à vérifier
Retours :
corde -

"probablement", "peut-être" ou '' (chaîne vide)

Voir :

children() → {Array}
component.js, ligne 386

Obtenez un tableau de tous les composants enfants

Retours :
Array -

Les enfants

Remplace :

clearInterval(intervalId) → {nombre}
component.js, ligne 1477

Efface un intervalle créé via Window.setInterval ou Component #setInterval. Si vous définissez un intervalle via Component #setInterval, utilisez cette fonction au lieu de Window.ClearInterval. Si vous ne le faites pas, votre écouteur Disposez ne sera pas nettoyé avant le composant #dispose!

Paramètres :
Prénom Type Description
Intervalides numéro

ID de l'intervalle à effacer. La valeur de retour de Component #setInterval ou Window.setInterval.

Retours :
numéro -

Renvoie l'identifiant d'intervalle qui a été effacé.

Remplace :
Voir :

clearTimeout(timeoutId) → {nombre}
component.js, ligne 1421

Efface un délai d'attente créé via Window.setTimeout ou Component #setTimeout. Si vous définissez un délai d'attente via le composant #setTimeout, utilisez cette fonction au lieu de Window.ClearIMout. Si vous ne le faites pas, votre écouteur Disposez ne sera pas nettoyé avant le composant #dispose!

Paramètres :
Prénom Type Description
ID de l'heure numéro

L'identifiant du délai d'expiration à effacer. La valeur de retour de Component #setTimeout ou Window.setTimeout.

Retours :
numéro -

Renvoie l'identifiant du délai d'attente effacé.

Remplace :
Voir :

contentEl() → {Element}
component.js, ligne 355

Renvoie l' élémentDOM du composant. C'est ici que les enfants sont insérés. Il s'agit généralement de la même chose que l'élément renvoyé dans Component #el.

Retours :
Élément -

L'élément de contenu de ce composant.

Remplace :

controls(boolopt) → {boolean}
player.js, ligne 3882

Obtenir ou définir si les contrôles sont affichés ou non.

Paramètres :
Prénom Type Attributs Description
livre booléen <facultatif>
  • true pour activer les contrôles - false pour les désactiver
Incendies :
Retours :
booléen -

La valeur actuelle des contrôles lors de l'obtention

createEl() → {Element}
player.js, ligne 679

Créer le Joueurélément DOM de .

Retours :
Élément -

L'élément DOM créé.

Remplace :

createModal(content, optionsopt) → {ModalDialog}
player.js, ligne 4698

Crée une boîte de dialogue modale simple (une instance du Boîte de dialogue Modale composant) qui recouvre immédiatement le lecteur d'un contenu arbitraire et se supprime lorsqu'il est fermé.

Paramètres :
Prénom Type Attributs Description
contenu chaîne | fonction | Elément | Array | null

Pareil que ModalDialog#content's param du même nom. L'utilisation la plus simple consiste à fournir une chaîne ou un élément DOM.
options Objet <facultatif>

Options supplémentaires qui seront transmises à ModalDialog.
Retours :
Boîte de dialogue Modale -

le ModalDialog qui a été créé

crossOrigin(valueopt) → {string|undefined}
player.js, ligne 849

Obtenez ou définissez le Joueurl'option crossOrigin de . Pour le lecteur HTML5, cela définit le croixOrigine propriété sur le < vidéo> balise pour contrôler le comportement de CORS.

Paramètres :
Prénom Type Attributs Description
valeur chaîne <facultatif>

La valeur pour définir le Joueur's crossOrigine to. Si un argument est donné, doit être l'un des anonyme ou utiliser-identifiants.
Retours :
string | indéfini -
  • La valeur crossOrigin actuelle du lecteur lors de l'obtention. - indéfini lors de la définition
Voir :

currentBreakpoint() → {string}
player.js, ligne 4870

Obtenez le nom du point d'arrêt actuel, le cas échéant.

Retours :
corde -

S'il existe actuellement un point d'arrêt défini, renvoie la clé de l'objet points d'arrêt correspondant. Sinon, renvoie une chaîne vide.

currentBreakpointClass() → {string}
player.js , ligne 4882

Obtenez le nom de la classe du point d'arrêt actuel.

Retours :
corde -

Le nom de classe correspondant (par exemple "vjs-layout-minuscule" ou "vjs-layout-large" ) pour le point d'arrêt actuel. Chaîne vide s'il n'y a pas de point d'arrêt actuel.

currentDimension(widthOrHeight) → {number}
component.js, ligne 1077

Obtenez la largeur calculée ou la hauteur de l'élément du composant.

Utilise Window.GetComputedStyle.

Paramètres :
Prénom Type Description
Largeur et Hauteur chaîne

Une chaîne contenant "width" ou "height". Celui que vous voulez obtenir.
Retours :
numéro -

La dimension demandée ou 0 si rien n'a été défini pour cette dimension.

Remplace :

currentDimensions() → {Component~DimensionObject}
component.js, ligne 1123

Obtenir un objet qui contient des valeurs de largeur et de hauteur calculées de l'élément du composant.

Utilise Window.GetComputedStyle.

Retours :
Component~DimensionObject-

Les dimensions calculées de l'élément du composant.

Remplace :

currentHeight() → {nombre}
component.js, ligne 1150

Obtenez la hauteur calculée de l'élément du composant.

Utilise Window.GetComputedStyle.

Retours :
numéro -

Hauteur calculée de l'élément du composant.

Remplace :

currentSource() → {Tech~SourceObject}
player.js, ligne 3659

Renvoie l'objet source actuel.

Retours :
Tech~SourceObject-

L'objet source actuel

currentSources() → {Array.<Tech~SourceObject> }
player.js, ligne 3641

Renvoie tous les objets source actuels.

Retours :
Déployer.<Tech~ObjetSource> -

Les objets source actuels

currentSrc() → {string}
player.js, ligne 3670

Renvoie l'URL complète de la valeur source actuelle, par exemple http://mysite.com/video.mp4 Peut être utilisé avec typecourant pour aider à reconstruire l'objet source actuel.

Retours :
corde -

La source actuelle

currentTime(secondsopt) → {nombre}
player.js, ligne 2529

Obtenir ou définir l'heure actuelle (en secondes)

Paramètres :
Prénom Type Attributs Description
secondes numéro | chaîne <facultatif>

Le temps de chercher en quelques secondes
Retours :
numéro -
  • l'heure actuelle en secondes lors de l'obtention

currentType() → {string}
player.js, ligne 3682

Obtenir le type de source actuel, par exemple vidéo/mp4. Cela peut vous permettre de reconstruire l'objet source actuel afin de pouvoir charger la même source et la même technologie ultérieurement.

Retours :
corde -

Le type MIME source

currentWidth() → {number}
component.js, ligne 1138

Obtenez la largeur calculée de l'élément du composant.

Utilise Window.GetComputedStyle.

Retours :
numéro -

Largeur calculée de l'élément du composant.

Remplace :

déboguer(activée)
player.js , ligne 5097

Définissez le mode de débogage pour activer/désactiver les journaux au niveau des informations.

Paramètres :
Prénom Type Description
activé booléen
Incendies :
  • Player#event:debugon
  • Player#event:débogage

defaultMuted(defaultMutedopt) → {boolean|Player}
player.js, ligne 2770

Obtenez l'état defaultMuted actuel, ou activez ou désactivez defaultMuted. defaultMuted indique l'état de muet lors de la lecture initiale.

  var myPlayer = videojs('some-player-id') ;

  myPlayer.src("http://www.example.com/path/to/video.mp4") ;

  // obtenir, devrait être faux
  console.log(myPlayer.defaultMuted()) ;
  // mis à true (vrai)
  myPlayer.defaultMuted(true) ;
  // get devrait être vrai
  console.log(myPlayer.defaultMuted()) ;
Paramètres :
Prénom Type Attributs Description
Sourdine par défaut booléen <facultatif>
  • true pour couper le son - false pour rétablir le son
Retours :
booléen | Joueur -
  • true si defaultMuted est activé et obtenu - false si defaultMuted est désactivé et obtenu - Une référence au joueur actuel lors du réglage

defaultPlaybackRate(rateopt) → {number|Player}
player.js, ligne 4287

Obtient ou définit la vitesse de lecture par défaut actuelle. Un taux de lecture par défaut de 1,0 représente la vitesse normale et 0,5 indiquerait une lecture à demi-vitesse, par exemple. defaultPlaybackRate ne représentera que le taux de lecture initial d'une vidéo, pas le taux de lecture actuel.

Paramètres :
Prénom Type Attributs Description
tarif numéro <facultatif>

Nouveau taux de lecture par défaut à définir.
Retours :
numéro | Joueur -
  • Le taux de lecture par défaut lors de l'obtention ou 1.0 - le lecteur lors du réglage de la vitesse de lecture
Voir :
  • https://html.spec.whatwg.org/multipage/embedded-content.html#dom-media-defaultplaybackrate

dimension(dimension, valueopt) → {nombre}
player.js, ligne 906

Un getter/setter pour le Joueurla largeur et la hauteur.

Paramètres :
Prénom Type Attributs Description
dimension chaîne

Cette chaîne peut être : - "largeur" - "hauteur
valeur numéro <facultatif>

Valeur de la dimension spécifiée dans le premier argument.
Retours :
numéro -

La valeur des arguments de dimension lors de l'obtention (largeur/hauteur).

Remplace :

dimensions(largeur, hauteur)
component.js, ligne 980

Définissez simultanément la largeur et la hauteur de l' élément Component.

Paramètres :
Prénom Type Description
largeur numéro | chaîne

Largeur à laquelle définir l' élément du composantsur.
hauteur numéro | chaîne

Hauteur pour définir l' élément du composantsur.
Remplace :

disablePictureInPicture(valeur)
player.js, ligne 3074

Désactivez le mode Image dans l'image.

Paramètres :
Prénom Type Description
valeur booléen
  • true désactive le mode Image dans l'image - false active le mode Image dans l'image

jetez()
player.js, ligne 608

Détruit le lecteur vidéo et effectue tout nettoyage nécessaire.

Cela est particulièrement utile si vous ajoutez et supprimez dynamiquement des vidéos vers/depuis le DOM.

Incendies :
Remplace :

documentFullscreenChange_()
player.js, ligne 2111

lorsque l'événement document fschange se déclenche, il appelle ceci

durée(secondesopt) → {nombre}
player.js, ligne 2580

Récupère normalement la durée de la vidéo en secondes ; dans tous les cas d'utilisation, sauf dans les rares cas d'utilisation, un argument NE sera PAS transmis à la méthode

REMARQUE: La vidéo doit avoir commencé à se charger avant que la durée puisse être connue, et selon le comportement de préchargement, elle peut ne pas être connue tant que la vidéo n'a pas commencé à jouer.

Paramètres :
Prénom Type Attributs Description
secondes numéro <facultatif>

La durée de la vidéo à définir en secondes
Incendies :
Retours :
numéro -
  • Durée de la vidéo en secondes lors de l'obtention

el() → {Element}
component.js, ligne 248

Obtenir l' élémentDOM du composant

Retours :
Élément -

L'élément DOM de ce composant.

Remplace :

Activer l'activité tactile()
component.js, ligne 1320

Cette fonction signale l'activité de l'utilisateur lorsque des événements tactiles se produisent. Cela peut être désactivé par tous les sous-composants qui souhaitent que les événements tactiles agissent autrement.

Signaler l'activité tactile de l'utilisateur lorsque des événements tactiles se produisent. L'activité des utilisateurs permet de déterminer quand les contrôles doivent s'afficher/masquer. C'est simple lorsqu'il s'agit d'événements de souris, car tout événement de souris doit afficher les commandes. Nous capturons donc les événements de souris qui se déplacent vers le joueur et signalons l'activité lorsque cela se produit. Avec les événements tactiles, il n'est pas aussi facile que les commandes Touchstart et Touchend Toggle Player. Les événements tactiles ne peuvent donc pas non plus nous aider au niveau du joueur.

L'activité des utilisateurs est vérifiée de façon asynchrone. Ce qui pourrait arriver, c'est qu'un événement de tapotage sur la vidéo désactive les commandes. Puis le toucher événement bouillonne jusqu'au joueur. Ce qui, s'il signalait une activité utilisateur, réactiverait les contrôles. Nous ne voulons pas non plus empêcher complètement les événements tactiles de bouillonner. De plus un toucher déplacer événement et quoi que ce soit d'autre qu'un tapotement, ne doit pas réactiver les commandes.

Écoute les événements :
  • Composant #événement:Touchstart
  • Composant #événement:Touchmove
  • Composante #événement:Touchend
  • Composant #événement:Touchannuler
Remplace :

ended() → {Booléen}
player.js, ligne 5307

Indique si le joueur est dans l'état « terminé » ou non.

Retours :
Booléen -

Cette propriété a la valeur True si le joueur est en état de fin, false sinon.

entrerFullWindow()
player.js, ligne 3000

Lorsque le mode plein écran n'est pas pris en charge, nous pouvons étendre le conteneur vidéo aussi large que le navigateur le permettra.

Incendies :

error(erropt) → {MediaError|null}
player.js, ligne 3991

Définir ou obtenir l'erreur MediaError actuelle

Paramètres :
Prénom Type Attributs Description
erreur MediaError | chaîne | nombre <facultatif>

Une erreur MediaError ou une chaîne ou un numéro à transformer en MediaError
Incendies :
Retours :
MediaError | null -

L'erreur MediaError actuelle lors de l'obtention (ou null)

Quitter le mode plein écran()
player.js, ligne 2940

Retournez la vidéo à sa taille normale après avoir été en mode plein écran

Incendies :

exitFenêtrePleine()
player.js, ligne 3047

Quitter la fenêtre complète

Incendies :

exitPictureInPicture() → {Promesse}
player.js, ligne 3137

Quittez le mode Image dans l'image.

Incendies :
Retours :
Promesse -

Une promesse.

Voir :

fill(boolopt) → {boolean|undefined}
player.js, ligne 982

Un getter/setter/toggler pour le vjs-fill nom du cours sur le Joueur.

L'activer désactivera le mode fluide.

Paramètres :
Prénom Type Attributs Description
livre booléen <facultatif>
  • Une valeur de true ajoute la classe. - La valeur false supprime la classe. - Aucune valeur ne sera un getter.
Retours :
booléen | indéfini -
  • La valeur du fluide lorsqu'il est obtenu. - indéfinie lorsqu'elle est définie.

flexNotSupported_() → {boolean}
player.js, ligne 5077

Déterminer si flexbox est pris en charge ou non

Retours :
booléen -
  • true si la boîte à outils est prise en charge - false si la boîte à outils n'est pas prise en charge

fluid(boolopt) → {boolean|undefined}
player.js, ligne 945

Un getter/setter/basculer pour le nom de classe vjs-fluide sur le lecteur.

L'activer désactivera le mode de remplissage.

Paramètres :
Prénom Type Attributs Description
livre booléen <facultatif>
  • Une valeur de true ajoute la classe. - La valeur false supprime la classe. - Aucune valeur ne sera un getter.
Retours :
booléen | indéfini -
  • La valeur du fluide lorsqu'il est obtenu. - indéfinie lorsqu'elle est définie.

focus()
component.js, ligne 1157

Définissez le focus sur ce composant

Remplace :

fullWindowOnEscKey(un événement)
player.js, ligne 3030

Vérifiez si vous appelez pour quitter la fenêtre complète ou le plein écran sur la touche ESC

Paramètres :
Prénom Type Description
événement chaîne

Événement pour vérifier s'il y a une touche

getAttribute(attribute) → {string|null}
component.js, ligne 904

Obtenez la valeur d'un attribut sur l' élément Components.

Paramètres :
Prénom Type Description
attribut chaîne

Nom de l'attribut à partir de laquelle récupérer la valeur.
Retours :
chaîne | null -
  • La valeur de l'attribut qui a été demandé. - Peut être une chaîne vide sur certains navigateurs si l'attribut n'existe pas ou n'a pas de valeur - La plupart des navigateurs renverront null si l'attribut n'existe pas ou n'a pas de valeur.
Remplace :
Voir :

getCache() → {Objet}
player.js, ligne 2239

Obtenir un objet pour les valeurs mises en cache.

Retours :
Objet -

récupérer le cache d'objets actuel

getChild(name) → {Component|undefined}
component.js, ligne 412

Renvoie le composant enfant portant le prénom.

Paramètres :
Prénom Type Description
nom chaîne

Nom du composant enfant à obtenir.
Retours :
Composant | non défini -

Composant enfant portant le prénom ou non défini.

Remplace :

getChildById(id) → {Component|undefined}
component.js, ligne 399

Renvoie le composant enfant avec l' identifiant donné.

Paramètres :
Prénom Type Description
ID chaîne

ID du composant enfant à obtenir.
Retours :
Composant | non défini -

Composant enfant avec l' identifiant donné ou non défini.

Remplace :

getDescendant(...names) → {Component|undefined}
component.js, ligne 434

Renvoie le composant descendant suivant les noms de descendants donnés. Par exemple, ['foo', 'bar', 'baz'] essaierait d'obtenir 'foo' dans le composant actuel, 'bar' dans le composant 'foo' et 'baz' dans le composant 'bar' et renverrait une valeur indéfinie si l'un de ces éléments n'existait pas.

Paramètres :
Prénom Type Attributs Description
noms ... tableau.<string> | corde <répétable>

Nom du composant enfant à obtenir.
Retours :
Composant | non défini -

Composant descendant suivant les noms de descendants donnés ou non défini.

Remplace :

getMedia() → {Player~MediaObject}
player.js, ligne 4983

Obtenez un clone du courant Player~MediaObject pour ce joueur.

Si la loadMedia méthode n'a pas été utilisée, tentera de retourner un Player~MediaObject en fonction de l'état actuel du lecteur.

Retours :
Player~MediaObject

getVideoPlaybackQuality() → {Objet|non défini}
player.js, ligne 4583

Obtient les mesures de qualité de lecture multimédia disponibles telles que spécifiées par l'API Media Playback Quality du W3C.

Retours :
Objet | non défini -

Objet avec des mesures de qualité de lecture multimédia prises en charge ou non défini s'il n'y a pas de technologie ou si la technologie ne le prend pas en charge.

Voir :

poignéeRaccourcis clavier(un événement)
player.js, ligne 3222

Appelé lorsque ce lecteur reçoit un événement de raccourci clavier. Les raccourcis clavier pris en charge à l'échelle du lecteur sont :

f - basculer en plein écran m - basculer en sourdine k ou Espace - basculer entre lecture/pause

Paramètres :
Prénom Type Description
événement Cible de l'événement ~ événement

Les touche Bas événement qui a provoqué l'appel de cette fonction.

HandleKeyDown(événement)
player.js, ligne 3160

Appelé lorsque ce lecteur a le focus et qu'une touche est enfoncée, ou lorsqu'un composant de ce lecteur reçoit une pression sur une touche qu'il ne gère pas. Cela permet des raccourcis clavier à l'échelle du joueur (soit comme défini ci-dessous, soit éventuellement par une fonction externe).

Paramètres :
Prénom Type Description
événement Cible de l'événement ~ événement

Les touche Bas événement qui a provoqué l'appel de cette fonction.
Écoute les événements :
  • événement : keydown
Remplace :

HandleKeyPress(événement)
component.js, ligne 1196

De nombreux composants avaient un poignéeKeyPress méthode, mal nommée car elle écoutait un touche Bas un événement. Ce nom de méthode est désormais délégué à HandleKeyDown. Cela signifie que quiconque appelle HandleKeyPress ne verra pas ses appels de méthode cesser de fonctionner.

Paramètres :
Prénom Type Description
événement Cible de l'événement ~ événement

Événement qui a provoqué l'appel de cette fonction.
Remplace :

Manche abstrait LanguageChange()
component.js, ligne 346

Gère le changement de langue du lecteur dans les composants. Doive être remplacée par des sous-composants.

Remplace :

handleSrc_(sourceopt, isRetry) → {string|undefined}
player.js, ligne 3391

Exécute le réglage de la source et obtient la logique

Paramètres :
Prénom Type Attributs Description
source Tech~SourceObject | Tableau.<Tech~SourceObject> | chaîne <facultatif>

Un objet SourceObject, un tableau d'objets SourceObjects ou une chaîne référençant une URL vers une source multimédia. Il est fortement recommandé d'utiliser ici un objet ou un tableau d'objets, afin que les algorithmes de sélection des sources puissent prendre en compte le type .

   Si elle n'est pas fournie, cette méthode agit comme un getter.
isRetry booléen

Indique si cela est appelé en interne à la suite d'une nouvelle tentative
Retours :
string | indéfini -

Si la la source l'argument est manquant, renvoie l'URL source actuelle. Sinon, ne renvoie rien ou non défini.

hasClass(classToCheck) → {boolean}
component.js, ligne 814

Vérifiez si l'élément d'un composant possède un nom de classe CSS.

Paramètres :
Prénom Type Description
Cours à vérifier chaîne

Nom de classe CSS à vérifier.
Retours :
booléen -
  • True si le composant possède la classe. - False si le composant n'a pas la classe`
Remplace :

hasPlugin(name) → {boolean}
player.js, ligne 5416

Indique si un joueur a ou non un plugin disponible.

Cela ne signale pas si le plugin a déjà été initialisé sur ce lecteur. Pour ça, usingPlugin.

Paramètres :
Prénom Type Description
nom chaîne

Le nom d'un plugin.
Retours :
booléen -

Si ce lecteur a ou non le plugin demandé disponible.

hasStarted(request) → {boolean}
player.js, ligne 1665

Ajouter/supprimer la classe vjs-has-started

Paramètres :
Prénom Type Description
demander booléen
  • true : ajoute la classe - false : supprime la classe
Incendies :
Retours :
booléen -

la valeur booléenne de hasStarted_

height(valueopt) → {number}
player.js, ligne 888

Un getter/setter pour le Joueurla hauteur. Renvoie la valeur configurée du joueur. Pour obtenir la hauteur actuelle, utilisez hauteur actuelle().

Paramètres :
Prénom Type Attributs Description
valeur numéro <facultatif>

La valeur pour définir le Joueurest à la hauteur de.
Retours :
numéro -

La hauteur actuelle du Joueur en obtenant.

Remplace :

cacher()
component.js, ligne 865

Masquez l' élément Components'il est actuellement affiché en y ajoutant le nom de classe « vjs-hidden ».

Remplace :

id() → {string}
component.js, ligne 365

Obtenez ceci ComposantIdentifiant

Retours :
corde -

L'identifiant de ce composant

Remplace :

Enfants en TI()
component.js, ligne 592

Ajoutez et initialisez des composantsenfants par défaut en fonction des options.

Remplace :

isAudio(bool) → {boolean}
player.js, ligne 4308

Obtient ou définit l'indicateur audio

Paramètres :
Prénom Type Description
livre booléen
  • true signale qu'il s'agit d'un lecteur audio - false signale qu'il ne s'agit pas d'un lecteur audio
Retours :
booléen -

La valeur actuelle de isAudio lors de l'obtention

isDisposed() → {boolean}
component.js, ligne 208

Déterminez si ce composant a été éliminé ou non.

Retours :
booléen -

Si le composant a été éliminé, sera vrai. Sinon, faux.

Remplace :

isFullscreen(isFSopt) → {boolean}
player.js, ligne 2825

Vérifiez si le lecteur est en mode plein écran ou indiquez au joueur qu'il est ou non en mode plein écran.

REMARQUE : En ce qui concerne la dernière spécification HTML5, IsFullScreen n'est plus une propriété officielle et document.FullScreenElement est utilisé. Mais IsFullScreen reste une propriété précieuse pour le fonctionnement interne des joueurs.

Paramètres :
Prénom Type Attributs Description
ISF booléen <facultatif>

Définir l'état plein écran actuel du lecteur
Retours :
booléen -
  • true si le fullscreen est activé et obtenu - false si le fullscreen est désactivé et obtenu

isInPictureInPicture(isPiPopt) → {boolean}
player.js, ligne 3094

Vérifiez si le lecteur est en mode Picture-in-Picture ou indiquez au lecteur qu'il est ou non en mode Picture-in-Picture.

Paramètres :
Prénom Type Attributs Description
isPiP booléen <facultatif>

Définir l'état actuel de l'image dans l'image des joueurs
Retours :
booléen -
  • vrai si l'incrustation d'image est activée et obtient - faux si l'incrustation d'image est désactivée et obtient

language(codeopt) → {string}
player.js, ligne 4624

Le code de langue du joueur.

Le changement de langue déclenche un changement de langue que les composants peuvent utiliser pour mettre à jour le texte du contrôle. ClickableComponent mettra à jour son texte de contrôle par défaut sur changement de langue.

Paramètres :
Prénom Type Attributs Description
code chaîne <facultatif>

le code de langue pour définir le lecteur sur
Incendies :
Retours :
corde -

Le code de langue actuel lors de l'obtention

languages() → {Array}
player.js, ligne 4653

Obtenez le dictionnaire de langue du lecteur Fusionner à chaque fois, car un nouveau plugin peut appeler VideoJs.addLanguage () à tout moment Les langues spécifiées directement dans les options du lecteur ont priorité

Retours :
Array -

Un éventail de langues prises en charge

charge()
player.js, ligne 3557

Commencez à charger les données src.

loadMedia(médias, prêt)
player.js, ligne 4940

Remplissez le lecteur à l'aide d'un MediaObject.

Paramètres :
Prénom Type Description
médias Player~MediaObject

Un objet média.
prêt fonction

Un rappel à appeler lorsque le joueur est prêt.

localize(string, tokensopt, defaultValueopt) → {string}
component.js, ligne 309

Localisez une chaîne avec la chaîne en anglais.

Si des jetons sont fournis, il essaiera d'exécuter un simple remplacement de jeton sur la chaîne fournie. Les éléments recherchés ressemblent à {1} , l'index étant indexé à 1 dans le tableau des éléments.

Si une valeur par défaut est fournie, elle utilisera cette valeur au-dessus de la chaîne, si aucune valeur n'est trouvée dans les fichiers linguistiques fournis. Ceci est utile si vous souhaitez avoir une clé descriptive pour le remplacement du jeton mais avoir une chaîne localisée succincte et ne pas exiger fr.json pour être inclus.

Actuellement, il est utilisé pour la synchronisation de la barre de progression.

{
  "Barre de progression : currentTime={1} duration={2}" : "{1} de {2}"
}

Il est ensuite utilisé comme suit :

this.localize('progress bar timing : currentTime={1} duration{2}',
              [this.player_.currentTime(), this.player_.duration()],
              '{1} de {2}') ;

Ce qui produit quelque chose comme : 01:23 de 24 h 56.

Paramètres :
Prénom Type Attributs Description
chaîne chaîne

Chaîne à localiser et clé à rechercher dans les fichiers de langue.
jetons matrice.<corde> <facultatif>

Si l'article actuel a des remplacements de jetons, indiquez les jetons ici.
Valeur par défaut chaîne <facultatif>

La valeur par défaut est chaîne. Il peut s'agir d'une valeur par défaut à utiliser pour le remplacement de jetons si la clé de recherche doit être séparée.
Retours :
corde -

La chaîne localisée ou si aucune localisation n'existe, la chaîne anglaise.

Remplace :

loop(valueopt) → {boolean}
player.js, ligne 3791

Obtenez ou définissez l'attribut de boucle sur l'élément vidéo.

Paramètres :
Prénom Type Attributs Description
valeur booléen <facultatif>
  • true signifie que la vidéo doit être mise en boucle - false signifie que la vidéo ne doit pas être mise en boucle
Retours :
booléen -

La valeur actuelle de la boucle lors de l'obtention

manuelAutoplay_()
player.js, ligne 1448

Gérez les valeurs de chaîne de lecture automatique, plutôt que les valeurs booléennes typiques qui devraient être gérées par le technicien. Notez que cela ne fait partie d'aucune spécification. Les valeurs valides et ce qu'elles font peuvent être trouvées sur le getter de lecture automatique à Player#autoplay()

muted(mutedopt) → {booléen}
player.js, ligne 2736

Obtenir l'état silencieux actuel, ou activer ou désactiver le sourdine

Paramètres :
Prénom Type Attributs Description
en sourdine booléen <facultatif>
  • true pour couper le son - false pour rétablir le son
Retours :
booléen -
  • vrai si la sourdine est activée et obtient - faux si la sourdine est désactivée et obtient

name() → {string}
component.js, ligne 376

Obtenir le ComposantLe nom de. Le nom est utilisé pour référencer le composant et est défini lors de l'enregistrement.

Retours :
corde -

Le nom de ce composant.

Remplace :

networkState() → {nombre}
player.js, ligne 5329

Renvoie l'état actuel de l'activité réseau de l'élément, à partir des codes de la liste ci-dessous.

  • NETWORK_EMPTY (valeur numérique 0) L'élément n'a pas encore été initialisé. Tous les attributs sont dans leur état initial.
  • NETWORK_IDLE (valeur numérique 1) L'algorithme de sélection des ressources de l'élément est actif et a sélectionné une ressource, mais il n'utilise pas réellement le réseau pour le moment.
  • NETWORK_LOADING (valeur numérique 2) L'agent utilisateur tente activement de télécharger des données.
  • NETWORK_NO_SOURCE (valeur numérique 3) L'algorithme de sélection des ressources de l'élément est actif, mais il n'a pas encore trouvé de ressource à utiliser.
Retours :
numéro -

état actuel de l'activité réseau

Voir :

options(obj) → {Objet}
component.js, ligne 233

Fusion approfondie des objets options avec de nouvelles options.

Remarque : Lorsque obj et options contiennent des propriétés dont les valeurs sont des objets. Les deux propriétés sont fusionnées à l'aide de Module:MergeOptions

Paramètres :
Prénom Type Description
obj Objet

Objet qui contient de nouvelles options.
Retours :
Objet -

Un nouvel objet de ce .options_ et obj a fusionné ensemble.

Remplace :

pause() → {Player}
player.js, ligne 2467

Suspendre la lecture vidéo

Retours :
Joueur-

Une référence à l'objet joueur sur lequel cette fonction a été appelée.

paused() → {booléen}
player.js, ligne 2478

Vérifiez si le joueur est en pause ou s'il n'a pas encore joué

Retours :
booléen -
  • false : si le média est en cours de lecture - true : si le média n'est pas en cours de lecture

play() → {Promesse|non défini}
player.js, ligne 2366

Essayez de commencer la lecture à la première occasion.

Retours :
Promesse | indéfinie -

Renvoie une promesse si le navigateur prend en charge les promesses (ou si une promesse a été transmise en option). Cette promesse sera résolue sur la valeur de retour du jeu. Si cela n'est pas défini, la chaîne de promesse sera remplie, sinon la chaîne de promesse sera remplie lorsque la promesse du jeu sera remplie.

playbackRate(rateopt) → {nombre}
player.js, ligne 4258

Obtient ou définit le taux de lecture actuel. Un taux de lecture de 1,0 représente la vitesse normale et 0,5 indique une lecture à demi-vitesse, par exemple.

Paramètres :
Prénom Type Attributs Description
tarif numéro <facultatif>

Nouveau taux de lecture à définir.
Retours :
numéro -

Le taux de lecture actuel lors de l'obtention ou 1,0

Voir :

playbackRates(newRates) → {Array.<nombre> }
player.js, ligne 5127

Définir ou obtenir les taux de lecture actuels. Prend un tableau et met à jour le menu des taux de lecture avec les nouveaux éléments. Passez un tableau vide pour cacher le menu. Les valeurs autres que les tableaux sont ignorées.

Paramètres :
Prénom Type Description
nouveauxTaux Array.<numéro>

Les nouveaux taux que le menu des taux de lecture doit mettre à jour. Un tableau vide masquera le menu
Incendies :
Retours :
Array.<numéro> -

Lorsqu'il est utilisé comme getter, il renvoie les taux de lecture actuels

played() → {TimeRange}
player.js, ligne 2491

Obtenez un objet TimeRange représentant les plages de temps actuelles auxquelles l'utilisateur a joué.

Retours :
Plage de temps -

Un objet de plage de temps qui représente tous les incréments de temps qui ont été joués.

player() → {Player}
component.js, ligne 218

Renvoie le joueur auquel le composant s'est attaché.

Retours :
Joueur-

Le lecteur auquel ce composant est attaché.

Remplace :

playsinline(valueopt) → {string|Player}
player.js, ligne 3772

Définissez ou désdéfinissez l'attribut playsinline. Playsinline indique au navigateur que la lecture non plein écran est préférée.

Paramètres :
Prénom Type Attributs Description
valeur booléen <facultatif>
  • true signifie que nous devons essayer de lire en ligne par défaut - false signifie que nous devons utiliser le mode de lecture par défaut du navigateur, qui dans la plupart des cas est en ligne. iOS Safari est une exception notable et joue en plein écran par défaut.
Retours :
chaîne de caractères | Joueur -
  • la valeur actuelle de playsinline - le lecteur lors du réglage
Voir :

poster(srcopt) → {string}
player.js, ligne 3811

Obtenir ou définir l'URL source de l'image de l'affiche

Paramètres :
Prénom Type Attributs Description
src chaîne <facultatif>

URL source de l'image de l'affiche
Incendies :
Retours :
corde -

La valeur actuelle de poster lors de l'obtention

preload(valueopt) → {string}
player.js, ligne 3696

Obtenir ou définir l'attribut de préchargement

Paramètres :
Prénom Type Attributs Description
valeur booléen <facultatif>
  • true signifie qu'il faut précharger - false signifie qu'il ne faut pas précharger
Retours :
corde -

La valeur de l'attribut de préchargement lors de l'obtention

ready() → {Component}
component.js, ligne 709

Liez un écouteur à l'état prêt du composant. Différent des écouteurs d'événements en ce sens que si l'événement prêt a déjà eu lieu, il déclenchera immédiatement la fonction.

Retours :
Composante-

Renvoie elle-même ; la méthode peut être enchaînée.

Remplace :

readyState() → {nombre}
player.js, ligne 5350

Renvoie une valeur qui exprime l'état actuel de l'élément par rapport au rendu de la position de lecture actuelle, à partir des codes de la liste ci-dessous.

  • HAVE_NOTHING (valeur numérique 0) Aucune information concernant la ressource multimédia n'est disponible.
  • HAVE_METADATA (valeur numérique 1) Une quantité suffisante de la ressource a été obtenue pour que la durée de la ressource soit disponible.
  • HAVE_CURRENT_DATA (valeur numérique 2) Les données de la position de lecture actuelle immédiate sont disponibles.
  • HAVE_FUTURE_DATA (valeur numérique 3) Les données de la position de lecture actuelle immédiate sont disponibles, ainsi que suffisamment de données pour que l'agent utilisateur puisse avancer la position de lecture actuelle dans le sens de la lecture.
  • HAVE_ENOUGH_DATA (valeur numérique 4) L'agent utilisateur estime qu'il y a suffisamment de données disponibles pour que la lecture continue sans interruption.
Retours :
numéro -

état de rendu de lecture actuel

Voir :

remainingTime() → {nombre}
player.js, ligne 2623

Calcule le temps restant dans la vidéo. Ne fait pas partie de l'API vidéo native.

Retours :
numéro -

Le temps restant en secondes

remainingTimeDisplay() → {nombre}
player.js, ligne 2634

Une fonction de temps restant destinée à être utilisée lorsque le temps doit être affiché directement à l'utilisateur.

Retours :
numéro -

Le temps arrondi restant en secondes

remoteTextTrackEls( ) → {HtmlTrackElementList}
player.js, ligne 5194

Obtenez la télécommande HtmlTrackElementList des pistes.

Retours :
HtmlTrackElementList -

La liste actuelle des éléments de la piste de texte distant

remoteTextTracks( ) → {TextTrackList}
player.js, ligne 5185

Obtenez la télécommande TextTrackList

Retours :
Liste TextTrackList-

La liste actuelle des pistes de texte à distance

RemoveAttribute(attribut)
component.js, ligne 931

Supprimez un attribut de l' élément Components.

Paramètres :
Prénom Type Description
attribut chaîne

Nom de l'attribut à supprimer.
Remplace :
Voir :

RemoveChild(composant)
component.js, ligne 553

Supprimer un enfant Composant de ceci Composants liste des enfants. Supprime également l' élément Components enfant de cet élément Component.

Paramètres :
Prénom Type Description
composant Composante

Composant enfant à supprimer.
Remplace :

Supprimer la classe(classe à supprimer)
component.js, ligne 834

Supprimez un nom de classe CSS de l' élément Components.

Paramètres :
Prénom Type Description
Classe à supprimer chaîne

Nom de classe CSS à supprimer
Remplace :

removeRemoteTextTrack(track) → {undefined}
player.js, ligne 4558

Supprimer une télécommande TextTrack de la respective TextTrackList et HtmlTrackElementList.

Paramètres :
Prénom Type Description
piste Objet

Remote TextTrack à supprimer
Retours :
non défini -

ne retourne rien

rapportUserActivity(un événement)
player.js, ligne 4067

Signaler l'activité des utilisateurs

Paramètres :
Prénom Type Description
événement Objet

Objet événement

requestAnimationFrame(fn) → {nombre}
component.js, ligne 1511

Met en file d'attente un rappel à transmettre à RequestAnimationFrame (RaF), mais avec quelques bonus supplémentaires :

  • Prend en charge les navigateurs qui ne prennent pas en charge RaF en revenant au composant #setTimeout.

  • Le rappel est transformé en composant Component~GenericCallback (c'est-à-dire lié au composant).

  • L'annulation automatique du rappel RaF est gérée si le composant est éliminé avant son appel.

Paramètres :
Prénom Type Description
fn Composant ~ rappel générique

Fonction qui sera liée à ce composant et exécutée juste avant la prochaine peinture du navigateur.
Écoute les événements :
Retours :
numéro -

Renvoie un ID RaF utilisé pour identifier le délai d'expiration. Il peut également être utilisé dans le composant #cancelAnimationFrame pour annuler le rappel de la trame d'animation.

Remplace :
Voir :

demandePlein écran(options plein écranopter)
player.js, ligne 2862

Augmentez la taille de la vidéo en plein écran Dans certains navigateurs, le plein écran n'est pas pris en charge en mode natif. Il passe donc en « mode pleine fenêtre », où la vidéo remplit la fenêtre du navigateur. Dans les navigateurs et les appareils prenant en charge le mode plein écran natif, les contrôles par défaut du navigateur sont parfois affichés, et non l'habillage personnalisé Video.js. Cela inclut la plupart des appareils mobiles (iOS, Android) et les anciennes versions de Safari.

Paramètres :
Prénom Type Attributs Description
Options plein écran Objet <facultatif>

Ignorer les options plein écran du lecteur
Incendies :

RequestNamedAnimation Frame(nom, fn)
component.js, ligne 1547

Demandez une image d'animation, mais une seule image d'animation nommée sera mise en file d'attente. Un autre ne sera jamais ajouté avant la fin de la précédente.

Paramètres :
Prénom Type Description
nom chaîne

Le nom à donner à cette RequestAnimationFrame
fn Composant ~ rappel générique

Fonction qui sera liée à ce composant et exécutée juste avant la prochaine peinture du navigateur.
Remplace :

requestPictureInPicture() → {Promesse}
player.js, ligne 3115

Créez une fenêtre vidéo flottante toujours au-dessus d'autres fenêtres afin que les utilisateurs puissent continuer à consommer des médias pendant qu'ils interagissent avec d'autres sites de contenu ou applications sur leur appareil.

Incendies :
Retours :
Promesse -

Une promesse avec une fenêtre Picture-in-Picture.

Voir :

reset()
player.js, ligne 3566

Réinitialisez le lecteur. Charge la première technologie dans le techOrder, supprime toutes les pistes de texte dans l'existant technologie , et appelle réinitialiser sur le technologie.

resetControlBarUI_()
player.js, ligne 3596

Réinitialiser l'interface utilisateur de la barre de contrôle en appelant des sous-méthodes qui réinitialisent tous les composants de la barre de contrôle

resetPlaybackRate_()
player.js, ligne 3622

Réinitialiser le taux de lecture

resetProgressBar_()
player.js, ligne 3605

Réinitialiser la progression de la technologie afin que la barre de progression soit réinitialisée dans l'interface utilisateur

resetVolumeBar_()
player.js, ligne 3630

Réinitialiser la barre de volume

responsive(value) → {boolean}
player.js, ligne 4830

Obtenez ou définissez un drapeau indiquant si ce joueur doit ou non ajuster son interface utilisateur en fonction de ses dimensions.

Paramètres :
Prénom Type Description
valeur booléen

Devrait être vrai si le joueur doit ajuster son interface utilisateur en fonction de ses dimensions ; sinon, devrait être faux.
Retours :
booléen -

Sera vrai si ce joueur doit ajuster son interface utilisateur en fonction de ses dimensions ; sinon, sera faux.

runPlayCallbacks_(val)
player.js, ligne 2449

Lorsqu'un rappel de jeu est retardé, nous devons exécuter ces rappels lorsque le jeu est réellement appelé sur la technologie. Cette fonction exécute les rappels qui ont été retardés et accepte la valeur de retour de la technologie.

Paramètres :
Prénom Type Description
val indéfini | Promesse

La valeur de retour du tech.

runPlayTerminatedQueue_()
player.js , ligne 2430

Ces fonctions seront exécutées si la lecture est terminée. Si play runPlayCallbacks_ est exécuté, cette fonction ne sera pas exécutée. Cela nous permet de faire la différence entre un jeu terminé et un appel réel à jouer.

scrubbing(isScrubbingopt) → {boolean}
player.js, ligne 2506

Indique si l'utilisateur « nettoie » ou non. Le nettoyage se produit lorsque l'utilisateur a cliqué sur la poignée de la barre de progression et le fait glisser le long de la barre de progression.

Paramètres :
Prénom Type Attributs Description
Iss-frottement booléen <facultatif>

si l'utilisateur frotte ou non
Retours :
booléen -

La valeur du nettoyage lors de l'obtention

seekable() → {TimeRanges}
player.js, ligne 5321

Renvoie les fourrages de temps des médias actuellement disponibles pour la recherche.

Retours :
Plages de temps -

les intervalles recherchés de la chronologie médiatique

seeking() → {Booléen}
player.js, ligne 5314

Indique si le joueur est dans l'état « recherche » ou non.

Retours :
Booléen -

True si le joueur est dans l'état de recherche, faux sinon.

selectSource(sources) → {Objet|booléen}
player.js, ligne 3315

Sélectionner la source en fonction de l'ordre technique ou de l'ordre source Utilise la sélection de l'ordre source si Options.SourceOrder est vrai. Sinon, la sélection par défaut de l'ordre technique

Paramètres :
Prénom Type Description
sources baie

Les sources d'une ressource multimédia
Retours :
Objet | booléen -

Objet de l'ordre source et technique ou faux

SetAttribute(attribut, valeur)
component.js, ligne 919

Définir la valeur d'un attribut sur le Composantélément de

Paramètres :
Prénom Type Description
attribut chaîne

Nom de l'attribut à définir.
valeur chaîne

Valeur sur laquelle définir l'attribut.
Remplace :
Voir :

setInterval(fn, intervalle) → {nombre}
component.js, ligne 1450

Crée une fonction qui est exécutée toutes les x millisecondes. Cette fonction est une enveloppe autour de Window.setInterval. Il y a cependant quelques raisons d'utiliser celle-ci à la place.

  1. Il est effacé via le composant #clearInterval lorsque le composant #dispose est appelé.
  2. La fonction de rappel sera un composant ~GenericCallback
Paramètres :
Prénom Type Description
fn Composant ~ rappel générique

Fonction à exécuter toutes les x secondes.
intervalle numéro

Exécutez la fonction spécifiée toutes les x millisecondes.
Écoute les événements :
Retours :
numéro -

Renvoie un identifiant qui peut être utilisé pour identifier l'intervalle. Il peut également être utilisé dans le composant #clearInterval pour effacer l'intervalle.

Remplace :
Voir :

setTimeout(fn, timeout) → {nombre}
component.js, ligne 1385

Crée une fonction qui s'exécute après un délai d'expiration de x millisecondes. Cette fonction est une enveloppe autour de Window.setTimeout. Il y a cependant quelques raisons d'utiliser celle-ci à la place :

  1. Il est effacé via le composant #clearTimeout lorsque le composant #dispose est appelé.
  2. La fonction de rappel sera transformée en composant ~GenericCallback

Remarque : Vous ne pouvez pas utiliser Window.CleartimeOut sur l'identifiant renvoyé par cette fonction. Cela fera en sorte que son auditeur de disposition ne soit pas nettoyé ! Veuillez utiliser Composant#clearTimeout ou Composant#disposer au lieu.

Paramètres :
Prénom Type Description
fn Composant ~ rappel générique

Fonction qui sera exécutée après le délai d'expiration.
temps libre numéro

Délai d'expiration en millisecondes avant l'exécution de la fonction spécifiée.
Écoute les événements :
Retours :
numéro -

Renvoie un ID de délai d'attente utilisé pour identifier le délai d'expiration. Il peut également être utilisé dans le composant #clearTimeout pour effacer le délai d'attente défini.

Remplace :
Voir :

spectacle()
component.js, ligne 857

Afficher l'élément Componentss'il est caché en supprimant le nom de classe "vjs-hidden".

Remplace :

src(sourceopt) → {string|undefined}
player.js, ligne 3500

Obtenez ou définissez la source vidéo.

Paramètres :
Prénom Type Attributs Description
source Tech~SourceObject | Tableau.<Tech~SourceObject> | chaîne <facultatif>

Un objet SourceObject, un tableau d'objets SourceObjects ou une chaîne référençant une URL vers une source multimédia. Il est fortement recommandé d'utiliser ici un objet ou un tableau d'objets, afin que les algorithmes de sélection des sources puissent prendre en compte le type .

   Si elle n'est pas fournie, cette méthode agit comme un getter.
Retours :
string | indéfini -

Si la la source l'argument est manquant, renvoie l'URL source actuelle. Sinon, ne renvoie rien ou non défini.

supportsFullScreen() → {boolean}
player.js, ligne 2806

Vérifiez si la technologie actuelle peut prendre en charge le plein écran natif (par exemple avec des commandes intégrées comme iOS)

Retours :
booléen -

si le mode plein écran natif est pris en charge

tech(safetyopt) → {Tech}
player.js, ligne 1311

Renvoyer une référence au courant Technologie. Il imprimera un avertissement par défaut sur le danger d'utiliser la technologie directement, mais tout argument transmis fera taire l'avertissement.

Paramètres :
Prénom Type Attributs Description
sécurité * <facultatif>

Tout est passé pour faire taire l'avertissement
Retours :
Technologie -

La Tech

textTracks() → {TextTrackList}
player.js, ligne 5174

Obtenir la liste TextTrackList

Retours :
Liste TextTrackList-

la liste de pistes de texte actuelle

Basculer la classe(ClasseToToggle, prédicateopt)
component.js, ligne 849

Ajoutez ou supprimez un nom de classe CSS de l'élément du composant.

Paramètres :
Prénom Type Attributs Description
Classe à bascule chaîne

La classe à ajouter ou à supprimer en fonction de (@link Component #hasClass}
prédicat booléen | DOM~Predicate <facultatif>

Une fonction DOM~Predicate ou un booléen
Remplace :

toJSON() → {Objet}
player.js, ligne 4664

renvoie un objet JavaScript représentant les informations de piste actuelles. NE LE RENVOIE PAS EN JSON

Retours :
Objet -

Objet représentant le courant des informations de piste

Déclencheur prêt()
component.js, ligne 733

Déclenchez tous les écouteurs prêts pour ce composant.

Incendies :
Remplace :

updateSourceCaches_(srcObj)
player.js, ligne 1517

Mettre à jour les caches des sources internes afin que nous retournions la source correcte à partir de src() , source actuelle() , et Sourcescourantes().

Noter: Sources actuelles ne sera pas mis à jour si la source transmise existe dans le Sources actuelles cache.

Paramètres :
Prénom Type Description
Srco BJ Objet Tech~Source

Une chaîne ou une source d'objet vers laquelle mettre à jour nos caches.

userActive(boolopt) → {boolean}
player.js, ligne 4084

Obtier/définir si l'utilisateur est actif

Paramètres :
Prénom Type Attributs Description
livre booléen <facultatif>
  • true si l'utilisateur est actif - false si l'utilisateur est inactif
Incendies :
Retours :
booléen -

La valeur actuelle de userActive lors de l'obtention

usingNativeControls(boolopt) → {boolean}
player.js, ligne 3942

Activer/désactiver les commandes natives. Les contrôles natifs sont les contrôles intégrés aux appareils (par exemple, les contrôles par défaut de l'iPhone) ou à d'autres technologies (par exemple, les contrôles Vimeo) Cela ne devrait être défini que par le technicien actuel, car seul le technicien sait s'il peut prendre en charge les contrôles natifs

Paramètres :
Prénom Type Attributs Description
livre booléen <facultatif>
  • true pour activer les contrôles natifs - false pour les désactiver
Incendies :
Retours :
booléen -

La valeur actuelle des contrôles natifs lors de l'obtention

usingPlugin(name) → {boolean}
player.js, ligne 5430

Indique si un joueur utilise ou non un plugin par son nom.

Pour les plugins de base, cela indique seulement si le plugin a déjà été initialisé sur ce lecteur.

Paramètres :
Prénom Type Description
nom chaîne

Le nom d'un plugin.
Retours :
booléen -

Si ce lecteur utilise ou non le plugin demandé.

videoHeight() → {nombre}
player.js, ligne 4603

Obtenir la hauteur vidéo

Retours :
numéro -

hauteur vidéo actuelle

videoTracks() → {VideoTrackList}
player.js, ligne 5154

Obtenir la vidéo TrackList

Retours :
Liste des pistes vidéo -

la liste des pistes vidéo actuelle

videoWidth() → {number}
player.js, ligne 4593

Obtenir la largeur vidéo

Retours :
numéro -

largeur vidéo actuelle

volume(percentAsDecimalopt) → {nombre}
player.js, ligne 2704

Obtenir ou définir le volume actuel du support

Paramètres :
Prénom Type Attributs Description
Pourcentage en décimal numéro <facultatif>

Le nouveau volume en pourcentage décimal : - 0 correspond à la sourdine/0%/off - 1.0 correspond à 100%/plein - 0.5 correspond à la moitié du volume ou 50%
Retours :
numéro -

Le volume actuel en pourcentage lors de l'obtention

width(valueopt) → {number}
player.js, ligne 874

Un getter/setter pour le Joueur's largeur. Renvoie la valeur configurée du joueur. Pour obtenir la largeur actuelle, utilisez largeur actuelle().

Paramètres :
Prénom Type Attributs Description
valeur numéro <facultatif>

La valeur pour définir le Joueur's largeur à.
Retours :
numéro -

La largeur actuelle du Joueur en obtenant.

Remplace :

Définitions de types

Objet multimédia
player.js, ligne 4886

Un objet qui décrit un seul média.

Les propriétés qui ne font pas partie de cette description de type seront conservées ; ainsi, cela peut également être considéré comme un mécanisme de stockage de métadonnées générique.

Propriétés :
Prénom Type Attributs Description
album chaîne <facultatif>

Inutilisé, sauf si cet objet est passé au Session Média API.
artiste chaîne <facultatif>

Inutilisé, sauf si cet objet est passé au Session Média API.
ouvrages d'art matrice.<Objet> <facultatif>

Inutilisé, sauf si cet objet est passé au Session Média API. Si non spécifié, sera renseigné via le affiche , si disponible.
affiche chaîne <facultatif>

URL vers une image qui s'affichera avant la lecture.
src Tech~SourceObject | Tableau.<Tech~SourceObject> | chaîne <facultatif>

Un objet source unique, un tableau d'objets source ou une chaîne référençant une URL vers une source multimédia. Il est fortement recommandé d'utiliser ici un objet ou un tableau d'objets, afin que les algorithmes de sélection des sources puissent prendre en compte le type .
titre chaîne <facultatif>

Inutilisé, sauf si cet objet est passé au Session Média API.
Pistes textuelles matrice.<Objet> <facultatif>

Un tableau d'objets à utiliser pour créer des pistes de texte, en suivant le format natif des éléments de piste. Pour faciliter leur suppression, ceux-ci seront créés en tant que pistes de texte « à distance » et configurés pour être automatiquement nettoyés lors des modifications de la source.

      Ces objets peuvent avoir des propriétés telles que `src`, `kind`, `label`,
      et `language`, voir Tech#createRemoteTextTrack.
Voir :
  • https://wicg.github.io/mediasession/#the-mediametadata-interface

Evénements

avant la configuration du plugin : $name
plugin.js , ligne 488

Signale qu'un plugin est sur le point d'être configuré sur un lecteur - par son nom. Le nom est le nom du plugin.

Type:

avorter
player.js, ligne 77

Se déclenche lorsque le chargement d'un audio/vidéo est interrompu.

Type:

avant la configuration du plug-in
plugin.js , ligne 481

Signale qu'un plugin est sur le point d'être configuré sur un lecteur.

Type:

peut jouer
player.js, ligne 1776

Le média a un état ReadyState de HAVE_FUTURE_DATA ou supérieur.

Type:

peut jouer
player.js, ligne 1794

Le média a un état ReadyState de HAVE_ENOUGH_DATA ou supérieur. Cela signifie que l'ensemble du fichier multimédia peut être lu sans mise en mémoire tampon.

Type:

taille du composant
component.js, ligne 1032

Déclenché lorsqu'un composant est redimensionné.

Type:
Remplace :

contrôles désactivés
player.js, ligne 3914

Type:

contrôles activés
player.js, ligne 3903

Type:

disposer
player.js, ligne 609

Appelé lorsque le joueur est éliminé.

Type:
Les auditeurs de cet événement :
Remplace :

changement de durée
player.js, ligne 2607

Type:
Les auditeurs de cet événement :

vidé
player.js, ligne 109

Se déclenche lorsque la liste de lecture actuelle est vide.

Type:

terminé
player.js, ligne 1925

Début lorsque la fin de la ressource multimédia est atteinte (CurrentTime == durée)

Type:
Les auditeurs de cet événement :
  • PlayToggle#handleEnded

Entrer dans la fenêtre complète
player.js, ligne 3016

Type:

entrez l'image dans l'image
player.js, ligne 3117

Cet événement se déclenche lorsque le lecteur entre dans l'image en mode image

Type:
Les auditeurs de cet événement :

erreur
player.js, ligne 4049

Type:

Exit Full Window
player.js, ligne 3060

Type:

première pièce
player.js, ligne 1877

Défilé la première fois qu'une vidéo est lue. Ne fait pas partie de la spécification HLS, et ce n'est probablement pas encore la meilleure implémentation, donc utilisez-le avec parcimonie. Si vous n'avez aucune raison d'empêcher la lecture, utilisez myPlayer.one('jouer'); au lieu.

Type:
Obsolète :
  • À partir de la version 6.0, l'événement firstplay est obsolète.

changement plein écran
player.js, ligne 2835

Type:
Les auditeurs de cet événement :

changement de langue
player.js, ligne 4634

se déclenche lorsque la langue du lecteur change

Type:

laisser l'image dans l'image
player.js, ligne 3139

Cet événement se déclenche lorsque le lecteur quitte l'image en mode image

Type:
Les auditeurs de cet événement :

données chargées
player.js, ligne 156

Se déclenche lorsque le navigateur a chargé l'image actuelle de l'audio/vidéo.

Type:
  • événement

données chargées
player.js, ligne 5393

Défilé lorsque le lecteur a téléchargé des données à la position de lecture actuelle

Type:

métadonnées chargées
player.js, ligne 140

Se déclenche lorsque le navigateur a chargé des métadonnées pour l'audio/vidéo.

Type:
Les auditeurs de cet événement :

métadonnées chargées
player.js, ligne 5386

Défilé lorsque le joueur dispose d'informations sur la durée initiale et la dimension

Type:

Chargement
player.js, ligne 1423

Début lorsque l'agent utilisateur commence à rechercher des données multimédias

Type:
Les auditeurs de cet événement :

pause
player.js, ligne 1899

Déviré chaque fois que les médias ont été mis en pause

Type:
Les auditeurs de cet événement :

jouer
player.js, ligne 1700

Déclenché chaque fois qu'un Tech#play l'événement se produit. Indique que la lecture a démarré ou repris.

Type:
Les auditeurs de cet événement :

playbackrateschange
player.js, ligne 5144

se déclenche lorsque les taux de lecture d'un lecteur sont modifiés

Type:
Les auditeurs de cet événement :

redimensionnement du joueur
resize-manager.js, ligne 108

Appelé lorsque la taille du lecteur a changé

Type:

jouant
player.js, ligne 1813

La lecture du média n'est plus bloquée et a commencé à jouer.

Type:

configuration du plug-in
plugin.js , ligne 496

Signale qu'un plugin vient d'être installé sur un lecteur.

Type:

changement d'affiche
player.js, ligne 3835

Cet événement se déclenche lorsque l'image de l'affiche est modifiée sur le joueur.

Type:
Les auditeurs de cet événement :

progrès
player.js, ligne 61

Déconnecté pendant que l'agent utilisateur télécharge des données multimédias.

Type:
Les auditeurs de cet événement :

changement de taux
player.js, ligne 1727

Se déclenche lorsque la vitesse de lecture de l'audio/vidéo est modifiée

Type:
  • événement
Les auditeurs de cet événement :
  • PlaybackRateMenuButton#updateLabel
  • PlaybackRateMenuItem#update

prêt
component.js, ligne 750

Déclenché lorsqu'un composant est prêt.

Type:
Remplace :

redimensionner
player.js, ligne 188

Se déclenche lorsque les dimensions intrinsèques de la vidéo changent

Type:
  • événement

cherché
player.js, ligne 1850

Déjoué lorsque le joueur a fini de sauter à une nouvelle heure

Type:
Les auditeurs de cet événement :

cherchant
player.js, ligne 1831

Fait chaque fois que le joueur saute à une nouvelle heure

Type:

jeu de sources
player.js, ligne 1569

EXPÉRIMENTALE Déclenchée lorsque la source est définie ou modifiée sur le Tech , ce qui entraîne le rechargement de l'élément de média.

Il se déclenchera pour la source initiale et chaque source suivante. Cet événement est un événement personnalisé de Video.js et est déclenché par le Technologie.

L'objet événement de cet événement contient un src propriété qui contiendra la source qui était disponible lorsque l'événement a été déclenché. Cela n'est généralement nécessaire que si Video.js change de technologie pendant que la source a été modifiée.

Il est également tiré lorsque charge est appelé sur le lecteur (ou élément multimédia) car le spécification pour charge indique que l'algorithme de sélection des ressources doit être abandonné et redémarré. Dans ce cas, il est fort probable que le src la propriété sera définie sur la chaîne vide "" pour indiquer que nous ne savons pas quelle sera la source mais qu'elle est en train de changer.

Cet événement est actuellement encore expérimental et peut être modifié dans les versions mineures. Pour l'utiliser, passez enableSourceset option au joueur.

Type:
Propriétés :
Prénom Type Description
src chaîne

L'URL source disponible lorsque le ensemble de sources a été déclenché. Ce sera une chaîne vide si nous ne pouvons pas savoir quelle est la source mais savons que la source changera.

au point mort
player.js, ligne 124

Se déclenche lorsque le navigateur tente d'obtenir des données multimédias, mais que les données ne sont pas disponibles.

Type:

suspendre
player.js, ligne 93

Se déclenche lorsque le navigateur ne reçoit intentionnellement pas de données multimédia.

Type:

robinet
component.js, ligne 1282

Déclenché lorsqu'un composant est tapé.

Type:
Remplace :

données textuelles
player.js, ligne 2224

Se déclenche lorsque nous recevons un événement textdata de la part de la technologie

Type:

changement de piste de texte
player.js, ligne 220

Se déclenche lorsque la piste de texte a été modifiée

Type:
  • événement
Les auditeurs de cet événement :

mise à jour
player.js, ligne 172

Se déclenche lorsque la position de lecture actuelle a changé.

Type:
  • événement
Les auditeurs de cet événement :

mise à jour
player.js, ligne 5400

Actionné lorsque la position de lecture actuelle a changé * Pendant la lecture, cette opération est allumée toutes les 15 à 250 millisecondes, en fonction de la technologie de lecture utilisée.

Type:

utilisateur actif
player.js, ligne 4101

Type:

utilisateur inactif
player.js, ligne 4127

Type:

à l'aide de contrôles personnalisés
player.js, ligne 3969

le lecteur utilise les contrôles HTML personnalisés

Type:

à l'aide de commandes natives
player.js, ligne 3959

le lecteur utilise les commandes natives de l'appareil

Type:

changement de volume
player.js, ligne 204

Se déclenche lorsque le volume a été modifié

Type:
  • événement
Les auditeurs de cet événement :

changement de volume
player.js, ligne 5409

Défilé lorsque le volume change

Type:

en attente
player.js , ligne 1745

Une modification ReadyState sur l'élément DOM a provoqué l'arrêt de la lecture.

Type:

plugin setup : $name
plugin.js , ligne 503

Signale qu'un plugin vient d'être installé sur un lecteur - par son nom. Le nom est le nom du plugin.

Type: