Panduan
Cara menggunakan Twilio Video di Capacitor
Menggunakan @capgo/capacitor-twilio-video
Capacitor API untuk bergabung ke room Twilio Video dengan antarmuka panggilan native dalam aplikasi.
Instal
bun add @capgo/capacitor-twilio-video
bunx cap sync
bunx cap sync menyalin code native plugin ke dalam proyek native Anda. Jalankan kembali setiap kali melakukan upgrade plugin.
Impor
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
Sekilas tentang API
| Metode | Deskripsi |
|---|---|
login |
Simpan dan validasi access token Twilio Video yang dibuat oleh backend Anda. |
logout |
Hapus access token yang di-cache dan keluar dari room aktif. |
isLoggedIn |
Cek apakah token Twilio yang valid sedang tersimpan di cache perangkat. |
joinRoom |
Gabung ke room Twilio dan tampilkan overlay panggilan native in-app plugin. |
leaveRoom |
Keluar dari room saat ini jika sedang terhubung. |
setMicrophoneEnabled |
Aktifkan/nonaktifkan publikasi mikrofon lokal. |
setCameraEnabled |
Aktifkan/nonaktifkan publikasi kamera lokal. |
getCallStatus |
Kembalikan nama room, status media, dan jumlah partisipan saat ini. |
checkMicrophonePermission |
Cek status izin mikrofon. |
requestMicrophonePermission |
Minta izin akses mikrofon. |
checkCameraPermission |
Periksa status izin kamera. |
requestCameraPermission |
Request camera permission. |
Contoh
login()
Simpan dan validasi access token Twilio Video yang dibuat oleh backend Anda.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.login({ accessToken: 'access-token-123' });
console.log(result);
logout()
Hapus access token yang di-cache dan keluar dari room aktif.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.logout();
console.log(result);
isLoggedIn()
Cek apakah token Twilio yang valid sedang tersimpan di cache perangkat.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.isLoggedIn();
// The result holds sensitive values: use it without logging it.
joinRoom()
Gabung ke room Twilio dan tampilkan overlay panggilan native in-app plugin.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.joinRoom({ roomName: 'room' });
console.log(result);
leaveRoom()
Keluar dari room saat ini jika sedang terhubung.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.leaveRoom();
console.log(result);
setMicrophoneEnabled()
Aktifkan/nonaktifkan publikasi mikrofon lokal.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.setMicrophoneEnabled({ enabled: true });
console.log(result);
Tabel di atas mencantumkan 12 metode inti. Dokumentasi mengenai helper Listener, version, serta kontrak lengkap dari setiap metode tersedia di repositori GitHub.
Mendengarkan event
addListener mengembalikan sebuah handle. Panggil handle.remove() saat layar di-unmount, atau CapacitorTwilioVideo.removeAllListeners() untuk menghapus semua listener.
Referensi lengkap
Lanjutkan dari Menggunakan @capgo/capacitor-twilio-video
Jika Anda menggunakan Menggunakan @capgo/capacitor-twilio-video untuk merencanakan perilaku media dan antarmuka native, hubungkan dengan @capgo/capacitor-twilio-video untuk detail implementasi di @capgo/capacitor-twilio-video, Panduan Memulai untuk detail implementasi di Getting Started, 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, dan Menggunakan @capgo/capacitor-video-player untuk kapabilitas native saat menggunakan @capgo/capacitor-video-player.