Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem KI-Tool hinzu, indem Sie die folgende Befehl ausführen:

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

Dann verwenden Sie die folgende Anfrage:

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

Wenn Sie eine manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die unten angegebenen Plattform-spezifischen Anweisungen befolgen:

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

Importieren

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

API Übersicht

login

Speichern und überprüfen Sie einen von Ihrem Backend generierten Twilio-Video-Zugriffstoken.

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

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

logout

Löschen Sie den gecacheten Zugriffstoken und verlassen Sie das aktive Raum.

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 gecacht ist.

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

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

joinRoom

Beitreten Sie einen Twilio-Raum und präsentieren Sie das Plugin’s native in-app-Call-Overlay.

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);

setCameraEnabled

Aktivieren/Deaktivieren der lokalen Kameraübertragung.

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

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

getCallStatus

Geben Sie den aktuellen Raumnamen, den Medienzustand 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

Überprüfe den Zustand der Mikrofonberechtigung.

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

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

requestMicrophonePermission

Mikrofon-Berechtigung anfordern.

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

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

checkCameraPermission

Zustand der Kamera-Berechtigung überprüfen.

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

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

requestCameraPermission

Quelle der Wahrheit

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

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

Quelle der Wahrheit

Abschnitt mit dem Titel “Quelle der Wahrheit” src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API upstream geändert wird.

Weiter geht es von Getting Started

Wenn Sie Capgo verwenden Getting Started zur Planung von native Medien- und Schnittstellenverhalten, verbinden Sie es mit Verwendung von @capgo/capacitor-twilio-video für die native Fähigkeit in Using @capgo/capacitor-twilio-video, Verwendung von @capgo/capacitor-live-aktivitäten für die native Fähigkeit in Using @capgo/capacitor-live-activities, Using @capgo/capacitor-live-activities für die Implementierungsdetails in @capgo/capacitor-live-activities, Mit @capgo/capacitor-Video-Player für die native Fähigkeit in Mit @capgo/capacitor-Video-Player, und @capgo/capacitor-Video-Player für die Implementierungsdetails in @capgo/capacitor-Video-Player.