Twilio Video Plugin Capacitor

Utiliser @capgo/capacitor-twilio-video

Capacitor API pour rejoindre des rooms Twilio Video avec une interface d'appel native dans l'app.

Installer

bun add @capgo/capacitor-twilio-video
bunx cap sync

bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.

Importer

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

Aperçu de API

Méthode	Description
login	Stockez et validez un token d'accès Twilio Video généré par votre backend.
logout	Effacez le token d'accès en cache et quittez la room active.
isLoggedIn	Vérifiez si un token Twilio valide est actuellement en cache sur l'appareil.
joinRoom	Rejoignez une room Twilio et affichez l'overlay d'appel natif du plugin.
leaveRoom	Quittez la room actuelle si vous êtes connecté.
setMicrophoneEnabled	Activer/désactiver la diffusion du micro local.
setCameraEnabled	Activer/désactiver la diffusion de la caméra locale.
getCallStatus	Récupérez le nom de la room, l'état des médias et le nombre de participants.
checkMicrophonePermission	Vérifiez l'état des permissions du micro.
requestMicrophonePermission	Demander la permission d'utiliser le microphone.
checkCameraPermission	Vérifier l'état de l'autorisation de la caméra.
requestCameraPermission	Demander la permission d'utiliser la caméra.

Exemples

login()

Stockez et validez un token d'accès Twilio Video généré par votre backend.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.login({ accessToken: 'access-token-123' });
console.log(result);

logout()

Effacez le token d'accès en cache et quittez la room active.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.logout();
console.log(result);

isLoggedIn()

Vérifiez si un token Twilio valide est actuellement en cache sur l'appareil.

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 room Twilio et affichez 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()

Quittez la room actuelle si vous êtes connecté.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.leaveRoom();
console.log(result);

setMicrophoneEnabled()

Activer/désactiver la diffusion du micro local.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.setMicrophoneEnabled({ enabled: true });
console.log(result);

Le tableau ci-dessus liste les 12 méthodes principales. Les helpers de listener et de version, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.

Écouter les événements

addListener renvoie un handle. Appelez handle.remove() lors du démontage de l'écran, ou CapacitorTwilioVideo.removeAllListeners() pour supprimer tous les listeners.

Référence complète

• dépôt GitHub
• Documentation
• Référence API

Continuer à partir de « Utiliser @capgo/capacitor-twilio-video »

Si vous utilisez Utiliser @capgo/capacitor-twilio-video pour planifier le comportement des médias et de l'interface natifs, connectez-l’à @capgo/capacitor-twilio-video pour le détail d’implémentation dans @capgo/capacitor-twilio-video, Prise en main pour les détails d'implémentation dans Getting Started Utiliser @capgo/capacitor-live-activities pour la capacité native dans Utiliser @capgo/capacitor-live-activities @capgo/capacitor-live-activities pour les détails d'implémentation dans @capgo/capacitor-live-activities, et Utiliser @capgo/capacitor-video-player pour la fonctionnalité native dans Utilisation de @capgo/capacitor-video-player.