Passer à la navigation principale

@capgo/capacitor-player de YouTube

L'interface du plugin Player de YouTube pour Capacitor. Elle fournit des méthodes pour contrôler la lecture vidéo YouTube dans votre application.

Vue d'ensemble

Vue d'ensemble

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

Capacités de base

Vue d'ensemble
  • initialize - Créez une nouvelle instance de lecteur YouTube.
  • destroy - Détrousssez une instance de lecteur et libérez les ressources.
  • stopVideo - Arrêtez la lecture vidéo et annulez la charge. Utilisez cela avec parcimonie - pauseVideo() est généralement préféré.
  • playVideo - Jouez la vidéo actuellement chargée ou chargée. L'état final du lecteur sera PLAYING (1).
MéthodeDescription
initializeInitialisez une nouvelle instance de lecteur YouTube.
destroyDétrousssez une instance de lecteur et libérez les ressources.
stopVideoArrêtez la lecture vidéo et annulez la charge. Utilisez cela avec parcimonie - pauseVideo() est généralement préféré.
playVideoJouez la vidéo actuellement chargée ou chargée. L'état final du lecteur sera PLAYING (1).
pauseVideoArrêtez la vidéo en cours de lecture. L'état final du lecteur sera PAUSED (2), à moins qu'il ne soit déjà ENDED (0).
seekToRecherchez une position spécifique dans la vidéo. Si le lecteur est en pause, il reste en pause. Si il joue, il continue de jouer.
loadVideoByIdChargez et jouez une vidéo en fonction de son ID YouTube.
cueVideoByIdAffichez une vidéo en fonction de son ID sans la jouer. Chargez l'icône de la vidéo et préparez le lecteur, mais n'obtenez pas la vidéo jusqu'à ce que playVideo() soit appelé.
loadVideoByUrlChargez et jouez une vidéo en fonction de son URL complète.
cueVideoByUrlAffichez une vidéo en fonction de son URL sans la jouer.
cuePlaylistAffichez une playlist sans la jouer. Chargez la playlist et préparez la première vidéo.
loadPlaylistChargez et jouez une playlist.
nextVideoJouez la vidéo suivante dans la playlist.
previousVideoJouez la vidéo précédente dans la playlist.
playVideoAtJouez une vidéo spécifique dans la playlist en fonction de son index.
muteÉteignez le son du lecteur.
unMuteRéactiver le son du lecteur.
isMutedVérifiez si le lecteur est actuellement mis en sourdine.
setVolumeDéfinir le niveau de volume du lecteur.
getVolumeRécupérer le niveau de volume actuel du lecteur. Renvoie le volume même si le lecteur est mis en sourdine.
setSizeDéfinir les dimensions du lecteur en pixels.
getPlaybackRateRécupérer la vitesse de lecture actuelle.
setPlaybackRateDéfinir la vitesse de lecture.
getAvailablePlaybackRatesRécupérer la liste des vitesses de lecture disponibles pour la vidéo actuelle.
setLoopActiver ou désactiver la boucle de playlist. Lorsqu'elle est activée, la playlist redémarre depuis le début après la dernière vidéo.
setShuffleActiver ou désactiver le mélange aléatoire de playlist.
getVideoLoadedFractionRécupérer la fraction de la vidéo qui a été tamponnée. Plus fiable que la méthode dépréciée getVideoBytesLoaded/getVideoBytesTotal.
getPlayerStateRécupérer l'état actuel du lecteur.
getAllPlayersEventsStateObtenez les états d'événement pour tous les joueurs actifs. Utile pour suivre plusieurs instances de joueur.
getCurrentTimeObtenez la position de lecture actuelle en secondes.
toggleFullScreenActiver ou désactiver le mode plein écran.
getPlaybackQualityObtenez la qualité de lecture actuelle.
setPlaybackQualityDéfinir la qualité de lecture recommandée. La qualité réelle peut varier en fonction des conditions réseau.
getAvailableQualityLevelsObtenez la liste des niveaux de qualité disponibles pour la vidéo actuelle.
getDurationObtenez la durée de la vidéo actuelle en secondes.
getVideoUrlObtenez l'URL YouTube.com pour la vidéo actuelle.
getVideoEmbedCodeObtenez l'code d'embed pour la vidéo actuelle. Retourne un code iframe HTML d'embed.
getPlaylistObtenez un tableau des ID de vidéo dans la playlist actuelle.
getPlaylistIndexObtenez l'index de la vidéo actuellement jouée dans la playlist.
getIframeObtenez l'élément DOM iframe du joueur. Seulement disponible sur les plateformes web.
addEventListenerAjoutez un écouteur d'événements au lecteur. Seulement pour les plateformes web.
removeEventListenerSupprimez un écouteur d'événements du lecteur. Seulement pour les plateformes web.
getPluginVersionObtenez le numéro de version du plugin. Retourne des informations de version spécifiques à la plateforme.

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

Si vous utilisez @capgo/capacitor-player-youtube pour planifier le travail de plugin natif, connectez-l’à En utilisant @capgo/capacitor-youtube-player pour la capacité native dans En utilisant @capgo/capacitor-youtube-player, Répertoire de plugin Capgo pour le flux de travail du produit dans Répertoire de plugin Capgo, Plugins Capacitor par Capgo pour le détail d'implémentation dans Plugins Capacitor par Capgo, Ajouter ou Mettre à jour les plugins pour le détail d'implémentation dans Ajouter ou Mettre à jour les plugins, et Alternatives de plugins d'entreprise Ionic pour le flux de travail du produit dans Alternatives de plugins d'entreprise Ionic.