Getting Started

Copiez un prompt de configuration avec les étapes d'installation et le guide markdown complet pour ce 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.

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

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

Importer

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

API Vue d'ensemble

`login`

Stockez et validez un jeton d'accès à la vidéo Twilio généré par votre serveur backend.

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

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

`logout`

Supprimer le jeton d'accès en cache et quitter la salle active.

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

await CapacitorTwilioVideo.logout();

`isLoggedIn`

Vérifier si un jeton Twilio valide est actuellement enregistré sur le dispositif.

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

await CapacitorTwilioVideo.isLoggedIn();

`joinRoom`

Rejoindre une salle Twilio et présenter l'overlay de la communication vocale native du plugin.

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

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

`leaveRoom`

Quitter la salle actuelle si connecté.

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

await CapacitorTwilioVideo.leaveRoom();

`setMicrophoneEnabled`

Activer/désactiver la publication du microphone local.

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

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

`setCameraEnabled`

Activer/désactiver la publication du camera local.

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

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

`getCallStatus`

Renvoyer le nom de la salle actuelle, l'état des médias et le nombre de participants.

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

await CapacitorTwilioVideo.getCallStatus();

`checkMicrophonePermission`

Vérifier l'état de la permission du microphone.

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

await CapacitorTwilioVideo.checkMicrophonePermission();

`requestMicrophonePermission`

Demandez la permission d'accès au microphone.

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

await CapacitorTwilioVideo.requestMicrophonePermission();

`checkCameraPermission`

Vérifiez l'état de la permission de la caméra.

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

await CapacitorTwilioVideo.checkCameraPermission();

`requestCameraPermission`

Demandez la permission d'accès à la caméra.

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

await CapacitorTwilioVideo.requestCameraPermission();

Source De Vérité

Cette page est générée à partir du plugin. src/definitions.tsRe-générez la synchronisation lorsque les modifications publiques API sont mises à jour en amont.

Continuez de l'interface d'accueil

Si vous utilisez L'interface d'accueil pour planifier le comportement de médias et d'interface natives, connectez-le avec En utilisant @capgo/capacitor-twilio-video pour la capacité native dans En utilisant @capgo/capacitor-twilio-video, En utilisant @capgo/capacitor-live-activities pour la capacité native dans En utilisant @capgo/capacitor-live-activities, @capgo/capacitor-live-activities pour le détail d'implémentation dans @capgo/capacitor-live-activities, En utilisant @capgo/capacitor-video-player pour la capacité native en utilisant @capgo/capacitor-video-player, et @capgo/capacitor-video-player pour le détail d'implémentation en @capgo/capacitor-video-player.