Aller au contenu

@capgo/capacitor-youtube-player

Intégrez des vidéos YouTube avec un contrôle complet du player API et la gestion des événements

Intégrez des vidéos YouTube avec un contrôle complet du player API et la gestion des événements

Commencez par initialize() et les autres méthodes principales listées ci-dessous.

PlateformeSupportNotes
iOSOuiNatif
AndroidOuiNatif
Le WebNonProtéger avec Capacitor.getPlatform()
  • initialize - Initialiser une nouvelle instance du lecteur YouTube.
  • destroy - Détruire une instance du lecteur et libérer les ressources.
  • stopVideo - Arrête la lecture de la vidéo et annule le chargement. À utiliser avec parcimonie — pauseVideo() est généralement préférable.
  • playVideo - Lire la vidéo actuellement en file d'attente ou chargée. L'état final du lecteur sera PLAYING (1).
MéthodeDescription
initializeInitialiser une nouvelle instance du lecteur YouTube.
destroyDétruire une instance du lecteur et libérer les ressources.
stopVideoArrête la lecture de la vidéo et annule le chargement. À utiliser avec parcimonie — pauseVideo() est généralement préférable.
playVideoLire la vidéo actuellement en file d'attente ou chargée. L'état final du lecteur sera PLAYING (1).
pauseVideoMet en pause la vidéo en cours de lecture. L’état final du lecteur sera PAUSED (2), sauf s’il est déjà ENDED (0).
seekToAller à un moment précis de la vidéo. Si le lecteur est en pause, il reste en pause. S’il est en lecture, la lecture continue.
loadVideoByIdCharger et lire une vidéo à partir de son ID YouTube.
cueVideoByIdCharge une vidéo par ID sans la lire. Charge la miniature et prépare le lecteur, sans demander la vidéo avant l’appel de playVideo().
loadVideoByUrlCharger et lire une vidéo à partir de son URL complète.
cueVideoByUrlPréparer une vidéo par URL sans la lire.
cuePlaylistPrépare une playlist sans la lire. Charge la playlist et prépare la première vidéo.
loadPlaylistCharger et lire une playlist.
nextVideoLire la vidéo suivante de la playlist.
previousVideoLire la vidéo précédente de la playlist.
playVideoAtLire une vidéo précise de la playlist par son index.
muteCouper le son du lecteur.
unMuteRéactiver le son du lecteur.
isMutedVérifier si le son du lecteur est actuellement coupé.
setVolumeDéfinit le niveau de volume du lecteur.
getVolumeRenvoie le niveau de volume actuel du lecteur. Renvoie le volume même si le lecteur est en sourdine.
setSizeDéfinissez les dimensions du lecteur en pixels.
getPlaybackRateRécupérer le débit de lecture actuel.
setPlaybackRateRégler la vitesse de lecture.
getAvailablePlaybackRatesRécupérer la liste des vitesses de lecture disponibles pour la vidéo actuelle.
setLoopActivez ou désactivez la lecture en boucle de la playlist. Une fois activée, la playlist redémarrera du début après la dernière vidéo.
setShuffleEnable or disable playlist shuffle.
getVideoLoadedFractionRécupérer la part de la vidéo mise en mémoire tampon. Plus fiable que les méthodes obsolètes getVideoBytesLoaded/getVideoBytesTotal.
getPlayerStateRécupérez l'état actuel du player.
getAllPlayersEventsStateRécupérer les états d'événement de tous les lecteurs actifs. Utile pour suivre plusieurs instances de lecteur.
getCurrentTimeRécupérez la position de lecture actuelle en secondes.
toggleFullScreenActiver ou désactiver le mode plein écran.
getPlaybackQualityRécupérer la qualité de lecture actuelle.
setPlaybackQualityDéfinir la qualité de lecture suggérée. La qualité réelle peut varier selon les conditions du réseau.
getAvailableQualityLevelsRécupérer la liste des niveaux de qualité disponibles pour la vidéo actuelle.
getDurationRécupérer la durée en secondes de la vidéo en cours.
getVideoUrlRécupérer l'URL YouTube.com de la vidéo en cours.
getVideoEmbedCodeRécupère le code d'intégration pour la vidéo actuelle. Retourne le code d'intégration iframe HTML.
getPlaylistRécupérer le tableau des ID des vidéos de la playlist actuelle.
getPlaylistIndexRécupérez l'index de la vidéo en cours de lecture dans la playlist.
getIframeRécupère l'élément DOM de l'iframe du player. Plateforme Web uniquement.
addEventListenerAjoute un écouteur d'événements au player. Plateforme Web uniquement.
removeEventListenerSupprime un écouteur d'événements du player. Plateforme Web uniquement.
getPluginVersionRécupère le numéro de version du plugin. Retourne les informations de version propres à la plateforme.

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

Si vous utilisez @capgo/capacitor-youtube-player pour planifier le travail sur les plugins natifs, connectez-l’à Utiliser @capgo/capacitor-youtube-player pour la capacité native dans Utiliser @capgo/capacitor-youtube-player, Capgo Répertoire des plugins pour le workflow produit dans Capgo Plugin Directory, Plugins Capacitor par Capgo pour les détails d'implémentation dans Plugins Capacitor par Capgo, Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Ajout ou mise à jour de plugins, et Alternatives aux plugins Ionic Enterprise pour le workflow produit dans Alternatives aux plugins Ionic Enterprise.