Getting Started

Copiez un prompt de configuration avec les étapes d'installation et la guide Markdown complète 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.

Installation

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA en utilisant 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 au 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 à Twilio Video émis par votre serveur backend.

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

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

`logout`

Effacez le jeton d'accès en cache et quittez la salle active.

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

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

`isLoggedIn`

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

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

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

`joinRoom`

Rejoignez une salle Twilio et présentez l'overlay d'appel natif du plugin.

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

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

`leaveRoom`

Quitter la salle actuelle si connecté.

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

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

`setMicrophoneEnabled`

Activer/désactiver la publication du microphone local.

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

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

`setCameraEnabled`

Activer/désactiver la publication de la caméra locale.

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

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

`getCallStatus`

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

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

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

`checkMicrophonePermission`

Vérifier l'état des autorisations de microphone.

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

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

`requestMicrophonePermission`

Demander les autorisations de microphone.

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

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

`checkCameraPermission`

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

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

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

`requestCameraPermission`

Demander la permission de la caméra.

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

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

Source De Vérité

Cette page est générée à partir du plugin’s src/definitions.ts. Re-run le sync lorsque les modifications publiques API se produisent en amont.

Continuez de Getting Started

Si vous utilisez Prise en main pour planifier le comportement de médias et d'interface natifs, connectez-l’à Utilisation de @capgo/capacitor-twilio-video pour la capacité native dans Utilisation de @capgo/capacitor-twilio-video, Utilisation de @capgo/capacitor-live-activités pour la capacité native dans Utilisation de @capgo/capacitor-live-activités, @capgo/capacitor-live-activités pour le détail d'implémentation dans @capgo/capacitor-live-activités, Utilisation de @capgo/capacitor-joueur de vidéo pour la capacité native dans Utilisation de @capgo/capacitor-joueur de vidéo, et @capgo/capacitor-joueur de vidéo pour les détails d'implémentation dans @capgo/capacitor-player de vidéo.