Getting Started

GitHub

Kopieren Sie einen Einrichtungsvorschlag mit den Installationsanweisungen und der vollständigen Markdown-Guideline für diesen Plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-twilio-video`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/twilio-video/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool mit der folgenden Befehl hinzu:

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

Verwenden Sie dann den folgenden Vorschlag:

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

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

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

await CapacitorTwilioVideo.login({} as { accessToken: string });

`logout`

Löschen Sie den gecacheten Zugriffstoken und verlassen Sie den aktiven Raum.

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

await CapacitorTwilioVideo.logout();

`isLoggedIn`

Überprüfen Sie, ob ein gültiger Twilio-Token derzeit auf dem Gerät gecached ist.

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

await CapacitorTwilioVideo.isLoggedIn();

`joinRoom`

Beitreten Sie ein Twilio-Raum und präsentieren Sie das Plugin-Überschneidungs-Overlay.

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

await CapacitorTwilioVideo.joinRoom({} as { roomName: string; enableAudio?: boolean; enableVideo?: boolean });

`leaveRoom`

Verlassen Sie den aktuellen Raum, wenn Sie verbunden sind.

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

await CapacitorTwilioVideo.leaveRoom();

`setMicrophoneEnabled`

Aktivieren/Sperren Sie die lokale Mikrofonveröffentlichung.

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

await CapacitorTwilioVideo.setMicrophoneEnabled({} as { enabled: boolean });

`setCameraEnabled`

Aktivieren/Sperren Sie die lokale Kamera-Veröffentlichung.

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

await CapacitorTwilioVideo.setCameraEnabled({} as { enabled: boolean });

`getCallStatus`

Geben Sie den aktuellen Raumnamen, den Medienzustand und die Teilnehmerzahl zurück.

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

await CapacitorTwilioVideo.getCallStatus();

`checkMicrophonePermission`

Überprüfen Sie den Zustand der Mikrofonberechtigung.

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

await CapacitorTwilioVideo.checkMicrophonePermission();

`requestMicrophonePermission`

Berechtigung für das Mikrofon anfordern.

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

await CapacitorTwilioVideo.requestMicrophonePermission();

`checkCameraPermission`

Überprüfen Sie den Zustand der Kamera-Berechtigung.

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

await CapacitorTwilioVideo.checkCameraPermission();

`requestCameraPermission`

Kamera-Berechtigung anfordern.

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

await CapacitorTwilioVideo.requestCameraPermission();

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsWenn sich die öffentliche API im Quellcode ändert, führen Sie die Synchronisierung erneut durch.

Weitermachen von Getting Started

Wenn Sie native Medien und Schnittstellenverhalten planen, verbinden Sie es mit Getting Started mit @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-twilio-video Wenn Sie native Medien und Schnittstellenverhalten planen, verbinden Sie es mit @capgo/capacitor-twilio-video Für die native Fähigkeit in @capgo/capacitor-twilio-video, Mit @capgo/capacitor-live-activities Für die native Fähigkeit in @capgo/capacitor-live-activities, @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.