@capgo/capacitor-youtube-player

Présentation

Interface du plugin YouTube Player pour Capacitor. Propose des méthodes pour contrôler la lecture vidéo YouTube dans votre application.

Capacités de base

• initialize - Initialiser une nouvelle instance de lecteur YouTube.
• destroy - Détruire une instance de joueur et libérer les ressources.
• stopVideo - Arrêter la lecture vidéo et annuler la charge. Utilisez cela avec parcimonie - pauseVideo() est généralement préféré.
• playVideo - Jouer la vidéo actuellement préchargée ou chargée. L'état final du joueur sera PLAYING (1).

Public API

Méthode	Description
initialize	Initialiser une nouvelle instance de joueur YouTube.
destroy	Détruire une instance de joueur et libérer les ressources.
stopVideo	Arrêter la lecture vidéo et annuler la charge. Utilisez cela avec parcimonie - pauseVideo() est généralement préféré.
playVideo	Jouer la vidéo actuellement préchargée ou chargée. L'état final du joueur sera PLAYING (1).
pauseVideo	Mettre en pause la vidéo actuellement jouée. L'état final du joueur sera PAUSED (2), à moins qu'il ne soit déjà TERMINÉ (0).
seekTo	Sélectionnez une heure spécifique dans la vidéo. Si le lecteur est en pause, il reste en pause. Si il joue, il continue à jouer.
loadVideoById	Charger et jouer une vidéo à partir de son ID YouTube.
cueVideoById	Définir une vidéo à l'aide de son ID sans la jouer. Charge l'icône et prépare le lecteur, mais ne demande pas la vidéo jusqu'à ce que playVideo() soit appelé.
loadVideoByUrl	Charger et jouer une vidéo à partir de son URL complète.
cueVideoByUrl	Définir une vidéo à l'aide d'une URL sans la jouer.
cuePlaylist	Définir une playlist sans la jouer. Charge la playlist et prépare la première vidéo.
loadPlaylist	Charger et jouer une playlist.
nextVideo	Jouer la vidéo suivante dans la playlist.
previousVideo	Jouer la vidéo précédente dans la playlist.
playVideoAt	Jouer une vidéo spécifique dans la playlist à l'aide de son index.
mute	Mettre au silence le son du lecteur.
unMute	Déverrouiller le son du lecteur.
isMuted	Vérifiez si le lecteur est actuellement muet.
setVolume	Définissez le niveau de volume du lecteur.
getVolume	Obtenez le niveau de volume actuel du lecteur. Renvoie le volume même si le lecteur est muet.
setSize	Définissez les dimensions du lecteur en pixels.
getPlaybackRate	Obtenez le taux de lecture actuel.
setPlaybackRate	Définissez la vitesse de lecture.
getAvailablePlaybackRates	Obtenez la liste des taux de lecture disponibles pour la vidéo actuelle.
setLoop	Activer ou désactiver la boucle de playlist. Lorsqu'il est activé, la playlist redémarre depuis le début après la dernière vidéo.
setShuffle	Activer ou désactiver le mélange de playlist.
getVideoLoadedFraction	Obtenez la fraction de la vidéo qui a été tamponnée. Plus fiable que la méthode dépréciée getVideoBytesLoaded/getVideoBytesTotal.
getPlayerState	Obtenez l'état actuel du lecteur.
getAllPlayersEventsState	Obtenez les états d'événement pour tous les lecteurs actifs. Utile pour suivre plusieurs instances de lecteur.
getCurrentTime	Obtenez la position de lecture actuelle en secondes.
toggleFullScreen	Activer ou désactiver le mode plein écran.
getPlaybackQuality	Obtenez la qualité de lecture actuelle.
setPlaybackQuality	Définir la qualité de lecture suggérée. La qualité réelle peut varier en fonction des conditions réseau.
getAvailableQualityLevels	Obtenez la liste des niveaux de qualité disponibles pour la vidéo actuelle.
getDuration	Obtenez la durée de la vidéo actuelle en secondes.
getVideoUrl	Obtenez l'URL YouTube.com pour la vidéo actuelle.
getVideoEmbedCode	Obtenez l'code d'incrustation pour la vidéo actuelle. Retourne un code iframe HTML d'incrustation.
getPlaylist	Obtenez un tableau des identifiants de vidéo dans la playlist actuelle.
getPlaylistIndex	Obtenez l'index de la vidéo actuellement en lecture dans la playlist.
getIframe	Obtenez l'élément DOM iframe du lecteur. Seulement disponible sur les plateformes web.
addEventListener	Ajoutez un écouteur d'événement au lecteur. Seulement disponible sur les plateformes web.
removeEventListener	Supprimer un écouteur d'événement du joueur. Seulement pour les plateformes web.
getPluginVersion	Obtenir le numéro de version du plugin. Retourne des informations de version spécifiques à la plateforme.

Source De Vérité

Cette référence est synchronisée à partir de src/definitions.ts dans capacitor-youtube-player.