Langsung ke konten

@capgo/capacitor-native-audio

Efek suara latensi rendah dan streaming audio dengan preload, kontrol Now Playing, serta opsi playback di background.

Antrean playlist

setQueue, queueNext, queuePrevious, queueSelect, getQueueState, clearQueue, dan queueChange listener untuk track berurutan. Lock screen dan notifikasi skip next/previous di iOS dan Android dengan showNotification.

Snapshot pemutaran

getPlaybackState mengembalikan playing, paused, atau stopped dengan posisi dan durasi untuk rehidrasi UI. Jika aset sedang diputar, status elemen live menang atas snapshot tracked yang usang. Jika tidak, snapshot sesuai dengan terakhir playbackState event untuk aset tersebut. getRate membaca kecepatan saat ini yang diatur dengan setRate. Di Web, play membuat ulang elemen audio dan mengatur ulang rate, jadi panggil setRate setelah play.

Event progres

Panduan progress listener dipicu pada interval dari configure({ progressInterval }) (default 0,5 dtk) untuk scrubber dan UI bab.

Routing audio

Native setSpeaker, setEarpiece, dan getAudioRoute di iOS dan Android. Panggilan yang berhasil setSpeaker dan setEarpiece memancarkan audioRouteChange, bahkan jika rute tidak berubah (panggilan Web berulang tetap memancarkan). Event tidak dipicu saat headphone atau Bluetooth terhubung secara mandiri. Di Android, getAudioRoute laporan earpiece hanya dalam mode komunikasi setelah setEarpiece; jika tidak, dilaporkan speaker ketika tidak ada headset atau Bluetooth yang terhubung. Di Web, setSpeaker mengeluarkan audioRouteChange dengan speaker, setEarpiece mengeluarkannya dengan earpiece, dan getAudioRoute mengembalikan rute yang diminta terakhir (speaker setelah setSpeaker, earpiece setelah setEarpiece). Platform web tidak dapat mengubah output aktual.

Gunakan @capgo/capacitor-native-audio ketika aplikasi Capacitor Anda membutuhkan playback responsif untuk suara UI, klip pendek, atau sesi bergaya musik tanpa harus mengelola beberapa API audio native. Pramuat aset, loop trek, fade volume, stream URL remote atau HLS, dan secara opsional tampilkan kontrol transport di layar kunci.

Kasus penggunaan umum: SFX game, nada notifikasi, meditasi terpandu, pemutar podcast, dan alur apa pun yang harus berkoeksistensi dengan aplikasi lain di sesi audio perangkat.

PlatformDukunganCatatan
iOSYaAVFoundation, kategori Now Playing dan sesi audio opsional
AndroidYaPemutaran media, notifikasi, foreground service opsional untuk background
WebParsialPemutaran inti; playbackState dan progress di web; API queue dan routing resolve sesuai batas platform
  • configure - Konfigurasikan audio player.
  • preload - Muat file audio.
  • playOnce - Putar file audio sekali dengan cleanup otomatis.
  • isPreloaded - Cek apakah file audio sudah di-preload.
MetodeDeskripsi
configureKonfigurasi audio player.
preloadMuat file audio.
playOncePutar file audio sekali dengan pembersihan otomatis.
isPreloadedCek apakah file audio sudah di-preload.
playPutar file audio.
pauseJeda file audio.
resumeLanjutkan pemutaran audio.
loopHentikan file audio.
stopHentikan file audio.
unloadUnload file audio.
setVolumeAtur volume file audio.
setRateAtur kecepatan file audio.
setCurrentTimeAtur waktu saat ini pada file audio.
getCurrentTimeDapatkan waktu saat ini dari file audio.
getDurationDapatkan durasi file audio dalam detik.
getPlaybackStateSnapshot pemutaran untuk rehidrasi UI setelah navigasi atau event yang terlewat. Jika aset sedang diputar, state live yang berlaku; jika tidak, snapshot yang dilacak digunakan untuk memberi tahu stopped dari paused.
getRateKecepatan pemutaran saat ini untuk aset yang diberikan (nilai yang sama yang diset dengan setRate). Di Web, play membuat ulang elemen audio dan mereset kecepatan; panggil setRate setelah play.
setQueueSiapkan antrean berurutan; gunakan ulang aset yang sudah dimuat sebelumnya jika id-nya cocok.
clearQueueBersihkan antrean aktif.
getQueueStateItem antrean aktif, indeks, jumlah, dan ID aset terurut.
queueNextPilih item antrean berikutnya. Menghentikan item yang keluar dan memulai item yang dipilih.
queuePreviousPilih item antrean sebelumnya. Menghentikan item yang keluar dan memulai item yang dipilih.
queueSelectLompat ke item antrean dengan assetId. Menghentikan item yang keluar dan memulai item yang dipilih.
setSpeakerUtamakan speaker bawaan (iOS, Android). Di Web, memancarkan audioRouteChange dengan speaker (bukan no-op).
setEarpieceArahkan audio gaya panggilan ke earpiece (iOS, Android). Di Web, memancarkan audioRouteChange dengan earpiece (bukan no-op).
getAudioRouteRute aktif: speaker, earpiece, atau external. Di Android, earpiece hanya dilaporkan dalam mode komunikasi setelah setEarpiece; selain itu speaker ketika tidak ada headset atau Bluetooth yang terhubung. Di Web, mengembalikan rute terakhir yang diminta (speaker setelah setSpeaker, earpiece setelah setEarpiece). Platform web tidak dapat mengubah output aktual.
isPlayingCek apakah file audio sedang diputar.
addListenerDengarkan event complete.
addListenerDengarkan update waktu saat ini. Emit setiap 100ms saat audio diputar.
addListenerDengarkan perubahan status pemutaran, termasuk kontrol transport di notifikasi dan layar kunci pada iOS dan Android. Dipancarkan di Android, iOS, dan Web ketika metode transport plugin mengubah status pemutaran, termasuk play, pause, resume, loop, dan complete.
addListenerDengarkan coarse progress event; interval dari configure({ progressInterval }).
addListenerPantau saat queueChange saat item antrean aktif berubah, termasuk Web setQueue dengan autoPlay: true (reason setQueue).
addListenerPantau saat audioRouteChange saat panggilan berhasil setSpeaker atau setEarpiece memancarkan event, meskipun rute tidak berubah. Tidak dipicu untuk perubahan rute sistem seperti headphone atau Bluetooth. Dipancarkan di iOS, Android, dan Web (setSpeaker laporan speaker, setEarpiece laporan earpiece).
clearCacheHapus cache audio untuk file audio remote.
setDebugModeAtur logging mode debug.
getPluginVersionDapatkan versi plugin native Capacitor.
deinitPluginDeinisialisasi plugin dan kembalikan pengaturan audio session semula. Metode ini menghentikan semua audio yang sedang diputar dan mengembalikan perubahan audio session yang dibuat oleh plugin. Gunakan ini saat Anda perlu memastikan kompatibilitas dengan plugin audio lain.

Referensi ini disinkronkan dari src/definitions.ts di capacitor-native-audio.

Lanjutkan dari @capgo/capacitor-native-audio

Bagian berjudul “Lanjutkan dari @capgo/capacitor-native-audio”

Jika Anda menggunakan @capgo/capacitor-native-audio untuk merencanakan perilaku media dan antarmuka native, hubungkan dengan Menggunakan @capgo/capacitor-native-audio untuk kapabilitas native di Using @capgo/capacitor-native-audio, Menggunakan @capgo/capacitor-live-activities untuk kemampuan native di Menggunakan @capgo/capacitor-live-activities, @capgo/capacitor-live-activities untuk detail implementasi di @capgo/capacitor-live-activities, Menggunakan @capgo/capacitor-video-player untuk kemampuan native di Menggunakan @capgo/capacitor-video-player, dan @capgo/capacitor-video-player untuk detail implementasi di @capgo/capacitor-video-player.