Zum Hauptinhalt springen
@capgo/capacitor-twilio-video Kommunikation Open Source

Twilio Video Capacitor Plugin

Tritt Twilio Video-Räumen aus Capacitor bei – mit nativem Audio, Kamera und Room-Lifecycle-Events

Installieren

bun add @capgo/capacitor-twilio-video bunx cap sync
npm, pnpm oder yarn
  • npm install @capgo/capacitor-twilio-video
  • pnpm add @capgo/capacitor-twilio-video
  • yarn add @capgo/capacitor-twilio-video

Anleitung

Twilio Video in Capacitor nutzen

Nutzung von @capgo/capacitor-twilio-video

Capacitor API für den Beitritt zu 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 den nativen code des Plugins in deine nativen Projekte. Nach jedem Plugin-Upgrade erneut ausführen.

Importieren

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

API auf einen Blick

Methode Beschreibung
login Speichert und validiert einen Twilio Video Access Token, der von deinem Backend ausgestellt wurde.
logout Löscht den gecachten Access Token und verlässt den aktiven Raum.
isLoggedIn Prüft, ob aktuell ein gültiger Twilio Token auf dem Gerät im Cache liegt.
joinRoom Tritt einem Twilio-Raum bei und zeigt das native In-App-Call-Overlay des Plugins.
leaveRoom Verlasse den aktuellen Raum, wenn du verbunden bist.
setMicrophoneEnabled Lokales Mikrofon-Publishing aktivieren/deaktivieren.
setCameraEnabled Lokales Kamera-Publishing aktivieren/deaktivieren.
getCallStatus Gibt den aktuellen Raumnamen, den Media-Status und die Teilnehmerzahl zurück.
checkMicrophonePermission Prüft den Status der Mikrofon-Berechtigung.
requestMicrophonePermission Mikrofon-Berechtigung anfordern.
checkCameraPermission Status der Kamera-Berechtigung prüfen.
requestCameraPermission Kamera-Berechtigung anfordern.

Beispiele

login()

Speichert und validiert einen Twilio Video Access Token, der von deinem Backend ausgestellt wurde.

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

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

logout()

Löscht den gecachten Access Token und verlässt den aktiven Raum.

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

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

isLoggedIn()

Prüft, ob aktuell ein gültiger Twilio Token auf dem Gerät im Cache liegt.

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

const result = await CapacitorTwilioVideo.isLoggedIn();
// The result holds sensitive values: use it without logging it.

joinRoom()

Tritt einem Twilio-Raum bei und zeigt das native In-App-Call-Overlay des Plugins.

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

const result = await CapacitorTwilioVideo.joinRoom({ roomName: 'room' });
console.log(result);

leaveRoom()

Aktuellen Raum verlassen, falls verbunden.

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

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

setMicrophoneEnabled()

Lokales Mikrofon-Publishing aktivieren/deaktivieren.

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

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

Die obige Tabelle listet die 12 Kernmethoden auf. Listener und Versions-Helper sowie der vollständige Contract jeder Methode sind dokumentiert in der GitHub Repository.

Events abonnieren

addListener gibt ein Handle zurück. Rufe handle.remove() auf, wenn der Screen unmountet, oder CapacitorTwilioVideo.removeAllListeners() auf, um alle Listener zu entfernen.

Vollständige Referenz

Weiter mit der Nutzung von @capgo/capacitor-twilio-video

Wenn du es nutzt Nutzung von @capgo/capacitor-twilio-video , um natives Media- und Interface-Verhalten zu planen, verbinde es mit @capgo/capacitor-twilio-video für die Implementierungsdetails in @capgo/capacitor-twilio-video, Erste Schritte für die Implementierungsdetails in Erste Schritte, @capgo/capacitor-live-activities verwenden für die native Funktion in „@capgo/capacitor-live-activities verwenden“, @capgo/capacitor-live-activities für die Implementierungsdetails in @capgo/capacitor-live-activities und Verwendung von @capgo/capacitor-video-player für die native Funktionalität in „Verwendung von @capgo/capacitor-video-player.“

FAQ

Twilio Video Plugin FAQ

Wie installiere ich das Twilio Video Plugin in einer Capacitor App?

Führe "bun add @capgo/capacitor-twilio-video" (oder "npm install @capgo/capacitor-twilio-video") aus und danach "bunx cap sync", damit die iOS- und Android-Projekte die nativen code übernehmen. Importiere es in deiner App code aus "@capgo/capacitor-twilio-video".

Funktioniert @capgo/capacitor-twilio-video mit React, Vue und Angular?

Ja. Twilio Video ist ein Capacitor Package und funktioniert daher mit jedem Web-Framework, das in Capacitor läuft, einschließlich Ionic, React, Vue, Angular, Svelte und reinem JavaScript.

Welche Capacitor Version wird von @capgo/capacitor-twilio-video unterstützt?

Capgo Plugins folgen der Major-Version von Capacitor: Nutze die Plugin-Major-Version, die zu deiner Capacitor Major-Version passt (z. B. Plugin v8 bei Capacitor 8). Die Kompatibilitätstabelle im GitHub README listet die gepflegten Versionen auf.

Ist @capgo/capacitor-twilio-video kostenlos und Open Source?

Ja. Der code Quellcode ist öffentlich auf GitHub unter https://github.com/Cap-go/capacitor-twilio-video/ einsehbar und das Package kann kostenlos via npm installiert werden. Bug-Reports und Pull Requests sind willkommen.

Kann ich code mit Twilio Video ohne App Store Review aktualisieren?

Die Installation oder ein Upgrade des Plugins ändert den nativen code, weshalb ein neuer Store-Build nötig ist. Danach können JavaScript-, HTML- und CSS-Änderungen, die das Plugin aufrufen, sofort per Capgo Live Updates ausgeliefert werden.

Twilio Video-Änderungen deployen, ohne auf den App Review zu warten

Sobald das Plugin in deinem Store-Build ist, bringt Capgo mit Live-Updates deine JavaScript-, HTML- und CSS-Änderungen in Minuten zu den Nutzern.

Starte mit Capgo