Aller au contenu

@capgo/capacitor-youtube-player

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

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

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

PlateformeSupportNotes
iOSOuiNatif
AndroidOuiNatif
WebNonSécurisez 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
initializeInitialise une nouvelle instance du lecteur YouTube.
destroyDétruit une instance du lecteur et libère 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.
playVideoLance 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 player sera PAUSED (2), sauf s'il est déjà en état ENDED (0).
seekToAccéder à un moment précis de la vidéo. Si le player est en pause, il reste en pause. S'il est en lecture, la lecture continue.
loadVideoByIdCharge et lance une vidéo via son ID YouTube.
cueVideoByIdPréparez une vidéo par son ID sans la lancer. Charge la miniature et prépare le player, mais ne demande la vidéo qu'une fois playVideo() appelé.
loadVideoByUrlCharge et lance une vidéo via son URL complète.
cueVideoByUrlPréparez une vidéo via son URL sans la lancer.
cuePlaylistPréparez une playlist sans la lancer. 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 spécifique de la playlist par son index.
muteCouper le son du lecteur.
unMuteRéactiver le son du lecteur.
isMutedVérifier si le lecteur est actuellement en mode muet.
setVolumeRégler le niveau du volume du lecteur.
getVolumeObtenir le niveau de volume actuel. Retourne le volume même si le lecteur est en muet.
setSizeDéfinir les dimensions du lecteur en pixels.
getPlaybackRateObtenir la vitesse de lecture actuelle.
setPlaybackRateRégler la vitesse de lecture.
getAvailablePlaybackRatesRécupérer la liste des vitesses de lecture disponibles pour la vidéo actuelle.
setLoopActiver ou désactiver la lecture en boucle de la playlist. Si 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 fraction de la vidéo mise en mémoire tampon. Plus fiable que les fonctions obsolètes getVideoBytesLoaded/getVideoBytesTotal.
getPlayerStateRécupérer l'état actuel du lecteur.
getAllPlayersEventsStateRécupérer les états d'événement pour tous les lecteurs actifs. Utile pour suivre plusieurs instances de lecteurs.
getCurrentTimeRécupérer 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 réseau.
getAvailableQualityLevelsRécupérer la liste des niveaux de qualité disponibles pour la vidéo actuelle.
getDurationRécupérer la durée de la vidéo actuelle en secondes.
getVideoUrlRécupérer l'URL YouTube.com de la vidéo actuelle.
getVideoEmbedCodeRécupérer l'embed code de la vidéo actuelle. Retourne l'embed iframe HTML code.
getPlaylistRécupérer le tableau des IDs vidéo de la playlist actuelle.
getPlaylistIndexRécupérer l'index de la vidéo en cours de lecture dans la playlist.
getIframeRécupérer l'élément DOM iframe du player. Plateforme Web uniquement.
addEventListenerAjouter un écouteur d'événement au player. Plateforme Web uniquement.
removeEventListenerSupprimer un écouteur d'événement du player. Plateforme Web uniquement.
getPluginVersionRécupère le numéro de version du plugin. Renvoie les informations de version spécifiques à 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 un plugin natif, connectez-l’à Utiliser @capgo/capacitor-youtube-player pour la fonctionnalité native dans « Utiliser @capgo/capacitor-youtube-player », Répertoire des plugins Capgo pour le workflow produit dans le répertoire des plugins Capgo, Plugins Capacitor par Capgo pour les détails d'implémentation dans les plugins Capacitor par Capgo, Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans « Ajouter ou mettre à jour des plugins », et Alternatives aux plugins Ionic Enterprise pour le workflow produit dans les alternatives aux plugins Ionic Enterprise.