Guide
Comment utiliser Twilio Video dans Capacitor
En utilisant @capgo/capacitor-twilio-video
Capacitor API pour rejoindre des salles de Twilio Video avec une surface d'appel native dans l'application.
Installer
bun add @capgo/capacitor-twilio-video
bunx cap sync
bunx cap sync copie le plugin's native code dans vos projets natives. Exécutez-l’à nouveau après chaque mise à niveau du plugin.
Importer
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
API en un coup d'œil
| Méthode | Description |
|---|---|
login |
Stockez et validez un jeton d'accès Twilio Video généré par votre serveur backend. |
logout |
Effacez le jeton d'accès en cache et quittez la salle active. |
isLoggedIn |
Vérifiez si un jeton Twilio valide est actuellement en cache sur le dispositif. |
joinRoom |
Rejoignez une salle Twilio et présentez l'overlay d'appel natif du plugin. |
leaveRoom |
Quittez la salle actuelle si connecté. |
setMicrophoneEnabled |
Activer/désactiver la publication du microphone local. |
setCameraEnabled |
Activer/désactiver la publication de la caméra locale. |
getCallStatus |
Renvoyez le nom actuel de la salle, l'état des médias et le nombre de participants. |
checkMicrophonePermission |
Vérifiez l'état de la permission du microphone. |
requestMicrophonePermission |
Demandez la permission du microphone. |
checkCameraPermission |
Vérifiez l'état de la permission de la caméra. |
requestCameraPermission |
Demandez la permission de la caméra. |
Exemples
login()
Enregistrez et validez un jeton d'accès Twilio Video émis par votre serveur backend.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.login({ accessToken: 'access-token-123' });
console.log(result);
logout()
Vider le jeton d'accès en cache et quitter la salle active.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.logout();
console.log(result);
isLoggedIn()
Stockez et validez un jeton d'accès Twilio Video généré par votre serveur backend.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.isLoggedIn();
// The result holds sensitive values: use it without logging it.
joinRoom()
Rejoignez une salle Twilio et présentez l'overlay d'appel natif du plugin.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.joinRoom({ roomName: 'room' });
console.log(result);
leaveRoom()
Quitter la salle actuelle si connecté.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.leaveRoom();
console.log(result);
setMicrophoneEnabled()
Activer/désactiver la publication du microphone local.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.setMicrophoneEnabled({ enabled: true });
console.log(result);
La table ci-dessus répertorie les 12 méthodes de base. Les aides pour les listeners et les versions, ainsi que la pleine convention de chaque méthode, sont documentées dans le dépôt GitHub.
Écoutez les événements
addListener retourne un gestionnaire. Appelez handle.remove() lorsque l'écran est démonté, ou CapacitorTwilioVideo.removeAllListeners() pour supprimer tous les écouteurs.
Référence complète
Continuez à partir de l'utilisation de @capgo/capacitor-twilio-video
Si vous utilisez L'utilisation de @capgo/capacitor-twilio-video pour planifier le comportement des médias et de l'interface natives, connectez-l’avec @capgo/capacitor-vidéo-Twilio pour les détails d'implémentation dans @capgo/capacitor-twilio-video, Getting Started pour les détails d'implémentation dans Démarrage, Utilisation de @capgo/capacitor-live-activités pour la capacité native dans Utilisation de @capgo/capacitor-live-activités, @capgo/capacitor-live-activités pour les détails d'implémentation dans @capgo/capacitor-live-activités, et Utilisation de @capgo/capacitor-player de vidéo pour la capacité native dans Utilisation de @capgo/capacitor-player de vidéo.