Erste Schritte

Installieren

Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Nutze dann diesen Prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-twilio-video` plugin in my project.

Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:

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

Importieren

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

Quickstart

import { TwilioVideo } from '@capgo/capacitor-twilio-video';
await TwilioVideo.login({ accessToken: 'token' });
await TwilioVideo.joinRoom({ roomName: 'room' });

Häufige Stolperfallen

• Tokens nur auf deinem Server minten.
• Kamera- und Mikrofonberechtigungen anfordern.
• iOS Audio-Unterbrechungen handhaben.

API Übersicht

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 zeige das native In-App-Call-Overlay des Plugins an.

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

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

leaveRoom

Verlasse den aktuellen Raum, 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);

setCameraEnabled

Lokales Kamera-Publishing aktivieren/deaktivieren.

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

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

getCallStatus

Gibt den aktuellen Raumnamen, den Media-Status und die Teilnehmerzahl zurück.

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

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

checkMicrophonePermission

Prüft den Status der Mikrofon-Berechtigung.

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

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

requestMicrophonePermission

Mikrofonberechtigung anfordern.

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

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

checkCameraPermission

Status der Kameraberechtigung prüfen.

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

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

requestCameraPermission

Kameraberechtigung anfordern.

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

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

Source of Truth

Diese Seite wird aus dem Plugin generiert src/definitions.ts. Führe den Sync erneut aus, wenn sich das öffentliche API upstream ändert.

Weiter geht's nach Getting Started

Wenn du es nutzt Erste Schritte , um natives Media- und Interface-Verhalten zu planen, verbinde es mit Nutzung von @capgo/capacitor-twilio-video für die native Funktion bei der Nutzung von @capgo/capacitor-twilio-video, @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, Verwendung von @capgo/capacitor-video-player für die native Funktion in „@capgo/capacitor-video-player verwenden“, und @capgo/capacitor-video-player für das Implementierungsdetail in @capgo/capacitor-video-player.