Panduan
Bagaimana menggunakan Twilio Video di Capacitor
Menggunakan @capgo/capacitor-twilio-video
Capacitor API untuk bergabung dengan ruang Twilio Video dengan permukaan panggilan native di dalam aplikasi.
Instal
bun add @capgo/capacitor-twilio-video
bunx cap sync
bunx cap sync Menggandakan plugin code native ke proyek native Anda. Jalankan lagi setelah setiap pembaruan plugin.
Impor
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
Pandangan API sekaligus
| Metode | Deskripsi |
|---|---|
login |
Simpan dan validasi token akses Twilio Video yang dihasilkan backend Anda. |
logout |
Hapus token akses yang disimpan dan tinggalkan ruang yang aktif. |
isLoggedIn |
Periksa apakah token Twilio yang valid saat ini disimpan di perangkat. |
joinRoom |
Bergabunglah dengan ruang Twilio dan tampilkan overlay panggilan native plugin di dalam aplikasi. |
leaveRoom |
Keluar dari ruang yang sedang terhubung. |
setMicrophoneEnabled |
Aktifkan/nonaktifkan publikasi mikrofon lokal. |
setCameraEnabled |
Aktifkan/nonaktifkan publikasi kamera lokal. |
getCallStatus |
Kembalikan nama ruang saat ini, status media, dan jumlah peserta. |
checkMicrophonePermission |
Periksa status izin mikrofon. |
requestMicrophonePermission |
Berikan izin mikrofon. |
checkCameraPermission |
Periksa status izin kamera. |
requestCameraPermission |
Permintaan izin kamera. |
Contoh
login()
Simpan dan validasi token akses Twilio Video yang dihasilkan oleh backend Anda.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.login({ accessToken: 'access-token-123' });
console.log(result);
logout()
Hapus token akses yang disimpan di cache dan tinggalkan ruang obrolan aktif.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.logout();
console.log(result);
isLoggedIn()
Simpan dan validasi token akses Twilio yang diterbitkan oleh backend Anda.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.isLoggedIn();
// The result holds sensitive values: use it without logging it.
joinRoom()
Bergabunglah dengan ruang Twilio dan tampilkan overlay panggilan native plugin di dalam aplikasi.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.joinRoom({ roomName: 'room' });
console.log(result);
leaveRoom()
Keluar dari ruang saat sedang terhubung.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.leaveRoom();
console.log(result);
setMicrophoneEnabled()
Aktifkan/matikan publikasi mikrofon lokal.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.setMicrophoneEnabled({ enabled: true });
console.log(result);
Tabel di atas menampilkan 12 metode inti. Bantuan pemanggil dan versi, serta kontrak lengkap dari setiap metode, dapat dilihat dalam dokumentasi. repositori GitHub.
Dengarkan event
addListener mengembalikan sebuah handle. Panggil handle.remove() ketika layar dihapus, atau CapacitorTwilioVideo.removeAllListeners() untuk menghapus setiap pendengar.
Referensi lengkap
Teruskan dari Menggunakan @capgo/capacitor-twilio-video
Teruskan dari Menggunakan @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-twilio-video Menggunakan @capgo/capacitor-twilio-video Untuk merencanakan perilaku media dan antarmuka asli, hubungkannya dengan untuk merencanakan perilaku media dan antarmuka native, hubungkannya dengan @capgo/capacitor-twilio-video untuk detail implementasi di @capgo/capacitor-twilio-video, Mulai Menggunakan untuk detail implementasi di Mulai, Menggunakan @capgo/capacitor-live-activities untuk kemampuan asli di Menggunakan @capgo/capacitor-live-activities, @capgo/capacitor-aktivitas-nyata untuk detail implementasi di @capgo/capacitor-live-activities, dan Menggunakan @capgo/capacitor-video-player untuk kemampuan asli di Menggunakan @capgo/capacitor-video-player.