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.
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.
| Platform | Dukungan | Catatan |
|---|---|---|
| iOS | Ya | AVFoundation, kategori Now Playing dan sesi audio opsional |
| Android | Ya | Pemutaran media, notifikasi, foreground service opsional untuk background |
| Web | Parsial | Pemutaran 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.| Metode | Deskripsi |
|---|---|
configure | Konfigurasi audio player. |
preload | Muat file audio. |
playOnce | Putar file audio sekali dengan pembersihan otomatis. |
isPreloaded | Cek apakah file audio sudah di-preload. |
play | Putar file audio. |
pause | Jeda file audio. |
resume | Lanjutkan pemutaran audio. |
loop | Hentikan file audio. |
stop | Hentikan file audio. |
unload | Unload file audio. |
setVolume | Atur volume file audio. |
setRate | Atur kecepatan file audio. |
setCurrentTime | Atur waktu saat ini pada file audio. |
getCurrentTime | Dapatkan waktu saat ini dari file audio. |
getDuration | Dapatkan durasi file audio dalam detik. |
getPlaybackState | Snapshot 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. |
getRate | Kecepatan 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. |
setQueue | Siapkan antrean berurutan; gunakan ulang aset yang sudah dimuat sebelumnya jika id-nya cocok. |
clearQueue | Bersihkan antrean aktif. |
getQueueState | Item antrean aktif, indeks, jumlah, dan ID aset terurut. |
queueNext | Pilih item antrean berikutnya. Menghentikan item yang keluar dan memulai item yang dipilih. |
queuePrevious | Pilih item antrean sebelumnya. Menghentikan item yang keluar dan memulai item yang dipilih. |
queueSelect | Lompat ke item antrean dengan assetId. Menghentikan item yang keluar dan memulai item yang dipilih. |
setSpeaker | Utamakan speaker bawaan (iOS, Android). Di Web, memancarkan audioRouteChange dengan speaker (bukan no-op). |
setEarpiece | Arahkan audio gaya panggilan ke earpiece (iOS, Android). Di Web, memancarkan audioRouteChange dengan earpiece (bukan no-op). |
getAudioRoute | Rute 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. |
isPlaying | Cek apakah file audio sedang diputar. |
addListener | Dengarkan event complete. |
addListener | Dengarkan update waktu saat ini. Emit setiap 100ms saat audio diputar. |
addListener | Dengarkan 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. |
addListener | Dengarkan coarse progress event; interval dari configure({ progressInterval }). |
addListener | Pantau saat queueChange saat item antrean aktif berubah, termasuk Web setQueue dengan autoPlay: true (reason setQueue). |
addListener | Pantau 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). |
clearCache | Hapus cache audio untuk file audio remote. |
setDebugMode | Atur logging mode debug. |
getPluginVersion | Dapatkan versi plugin native Capacitor. |
deinitPlugin | Deinisialisasi 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.
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.