Richtlinie
Verwendung von Twilio Video in Capacitor
Verwendung von @capgo/capacitor-twilio-video
Capacitor API für das Beitreten von Twilio Video-Räumen mit einer nativen in-app-Anrufoberfläche.
Installieren
bun add @capgo/capacitor-twilio-video
bunx cap sync
bunx cap sync kopiert die Plugin-code in Ihre native Projekte. Führen Sie es erneut aus, nachdem jede Plugin-Upgrade durchgeführt wurde.
Importieren
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
API im Überblick
| Methode | Beschreibung |
|---|---|
login |
Speichern und überprüfen Sie einen von Ihrem Backend generierten Twilio-Video-Zugriffstoken. |
logout |
Löschen Sie das gecachte Zugriffstoken und verlassen Sie den aktiven Raum. |
isLoggedIn |
Überprüfen Sie, ob ein gültiger Twilio-Token auf dem Gerät gecacht ist. |
joinRoom |
Beteile dich an einem Twilio-Raum und präsentiere das Plugin mit seinem nativen in-app-Überlagerungsansicht. |
leaveRoom |
Verlasse den aktuellen Raum, wenn verbunden. |
setMicrophoneEnabled |
Aktivieren/Sperren Sie die lokale Mikrofonveröffentlichung. |
setCameraEnabled |
Aktivieren/Sperren Sie die lokale Kamera-Veröffentlichung. |
getCallStatus |
Rufen Sie den aktuellen Raumnamen, Medienstatus und Teilnehmerzähler ab. |
checkMicrophonePermission |
Überprüfen Sie den Mikrofonberechtigungsstatus. |
requestMicrophonePermission |
Bitten Sie um Mikrofonberechtigung. |
checkCameraPermission |
Überprüfen Sie den Zustand der Kamera-Berechtigung. |
requestCameraPermission |
Berechtigung für die Kamera anfordern. |
Beispiele
login()
Ein Twilio-Video-Zugriffstoken speichern und validieren, das von Ihrem Backend generiert wurde.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.login({ accessToken: 'access-token-123' });
console.log(result);
logout()
Den im Cache gespeicherten Zugriffstoken löschen und den aktiven Raum verlassen.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.logout();
console.log(result);
isLoggedIn()
Überprüfen Sie, ob ein gültiger Twilio-Token derzeit auf dem Gerät im Cache ist.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.isLoggedIn();
// The result holds sensitive values: use it without logging it.
joinRoom()
Beteilige dich an einem Twilio-Raum und präsentiere das native in-app-Überblendungsfenster des Plugins.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.joinRoom({ roomName: 'room' });
console.log(result);
leaveRoom()
Verlasse den aktuellen Raum, wenn verbunden.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.leaveRoom();
console.log(result);
setMicrophoneEnabled()
Aktivieren/Schalten Sie die lokale Mikrofonveröffentlichung.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.setMicrophoneEnabled({ enabled: true });
console.log(result);
Die Tabelle oben listet die 12 Kernmethoden auf. Helfer für Listener und Versionen sowie die vollständige Vertragsstruktur jeder Methode sind im GitHub Repository.
Zu Ereignissen hören
addListener erhält eine Verbindung. Aufrufen handle.remove() wenn das Bildschirmfenster sich auflöst oder CapacitorTwilioVideo.removeAllListeners() um alle Listener zu löschen.
Vollständige Referenz
Weitermachen von @capgo/capacitor-twilio-video
Wenn Sie @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-twilio-video verwenden Verwendung von @capgo/capacitor-twilio-video Um native Medien- und Schnittstellenverhalten zu planen, verbinden Sie es mit @capgo/capacitor-Twilio-Video für die Implementierungsdetails in @capgo/capacitor-twilio-video, Getting Started für die Implementierungsdetails in Einstieg, Verwendung von @capgo/capacitor-live-aktivitäten für die native Fähigkeit in Verwendung von @capgo/capacitor-live-aktivitäten, @capgo/capacitor-live-aktivitäten für die Implementierungsdetails in @capgo/capacitor-live-aktivitäten und Verwendung von @capgo/capacitor-video-player für die native Fähigkeit in Verwendung von @capgo/capacitor-video-player.