Aller au contenu

@capgo/capacitor-native-audio

Effets sonores à faible latence et streaming audio avec préchargement, contrôles Now Playing et options de lecture en arrière-plan.

Utiliser @capgo/capacitor-native-audio lorsque votre application Capacitor nécessite une lecture réactive pour des sons d'interface, des clips courts ou des sessions musicales sans avoir à jongler avec plusieurs API audio natives. Préchargez les assets, bouclez des pistes, gérez le fondu du volume, streamez des URL distantes ou du HLS, et affichez optionnellement les commandes de lecture sur l'écran de verrouillage.

Cas d'usage types : SFX de jeux, sons de notification, méditation guidée, lecteurs de podcasts ou tout flux devant coexister avec d'autres applications via la session audio de l'appareil.

PlateformeSupportNotes
iOSOuiAVFoundation, Now Playing optionnel et catégories de session audio
AndroidOuiLecture média, notifications, service de premier plan optionnel pour l'arrière-plan
Le WebPartielleLecture de base ; certains événements d'écoute ne sont pas émis sur le web
  • configure - Configurer le lecteur audio.
  • preload - Charger un fichier audio.
  • playOnce - Lire un fichier audio une seule fois avec nettoyage automatique.
  • isPreloaded - Vérifier si un fichier audio est préchargé.
MéthodeDescription
configureConfigurer le lecteur audio.
preloadCharger un fichier audio.
playOnceLire un fichier audio une seule fois avec nettoyage automatique.
isPreloadedVérifier si un fichier audio est préchargé.
playLire un fichier audio.
pauseMettre en pause un fichier audio.
resumeReprendre la lecture d'un fichier audio.
loopArrêter un fichier audio.
stopArrêter un fichier audio.
unloadDécharger un fichier audio.
setVolumeRégler le volume d'un fichier audio.
setRateRégler la vitesse d'un fichier audio.
setCurrentTimeRégler le temps actuel d'un fichier audio.
getCurrentTimeRécupérer le temps actuel d'un fichier audio.
getDurationRécupérer la durée d'un fichier audio en secondes.
isPlayingCheck if an audio file is playing.
addListenerÉcouter l'événement de fin de lecture.
addListenerÉcouter les mises à jour du temps actuel. Émis toutes les 100 ms pendant la lecture.
addListenerÉcouter les changements d'état de lecture, incluant les contrôles de notification et d'écran de verrouillage. Émis par Android et iOS. L'implémentation Web actuelle ne l'émet pas.
clearCacheVider le cache audio des fichiers audio distants.
setDebugModeConfigurer le logging du mode debug.
getPluginVersionRécupère la version du plugin natif Capacitor.
deinitPluginDésinitialise le plugin et restaure les paramètres de la session audio d'origine. Cette méthode arrête toute lecture audio en cours et annule les modifications de session audio effectuées par le plugin. Utilisez cette méthode pour garantir la compatibilité avec d'autres plugins audio.

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

Si vous utilisez @capgo/capacitor-native-audio pour planifier le comportement des médias et de l'interface natifs, connectez-l’à Utiliser @capgo/capacitor-native-audio pour la fonctionnalité native dans « Utiliser @capgo/capacitor-native-audio », Utiliser @capgo/capacitor-live-activities pour la capacité native dans Utiliser @capgo/capacitor-live-activities @capgo/capacitor-live-activities pour le détail d'implémentation dans @capgo/capacitor-live-activities Utiliser @capgo/capacitor-video-player pour la capacité native dans Utiliser @capgo/capacitor-video-player, et @capgo/capacitor-video-player pour le détail d'implémentation dans @capgo/capacitor-video-player.