Aller au contenu

Prise en main

GitHub

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

Fenêtre de terminal
bunx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Utilisez ensuite le prompt suivant :

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

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

Fenêtre de terminal
bun add @capgo/capacitor-realtimekit
bunx cap sync
import { CapacitorRealtimekit } from '@capgo/capacitor-realtimekit';
import { CapacitorRealtimekit } from '@capgo/capacitor-realtimekit';
await CapacitorRealtimekit.initialize();
import { CapacitorRealtimekit } from '@capgo/capacitor-realtimekit';
await CapacitorRealtimekit.startMeeting({
authToken: 'your-auth-token',
enableAudio: true,
enableVideo: true,
});
  • Initialiser une seule fois: exécutez le setup lors du bootstrap de l'app.
  • Sync native : exécuter bunx cap sync après les mises à jour du plugin.
  • Source de vérité : fiez-vous src/definitions.ts au repo GitHub.

Initialise le plugin RealtimeKit avant d'utiliser les autres méthodes.

import { CapacitorRealtimekit } from '@capgo/capacitor-realtimekit';
await CapacitorRealtimekit.initialize();

Démarrer une réunion à l’aide de l’interface intégrée. Disponible uniquement sur Android et iOS.

import { CapacitorRealtimekit } from '@capgo/capacitor-realtimekit';
await CapacitorRealtimekit.startMeeting({
authToken: 'your-auth-token',
enableAudio: true,
enableVideo: true,
});

Options de configuration pour démarrer une réunion.

export interface StartMeetingOptions {
/**
* Authentication token for the participant.
* This token is required to join the Cloudflare Calls meeting.
*
* @since 7.0.0
*/
authToken: string;
/**
* Whether to join with audio enabled.
* Default is true.
*
* @default true
* @since 7.0.0
*/
enableAudio?: boolean;
/**
* Whether to join with video enabled.
* Default is true.
*
* @default true
* @since 7.0.0
*/
enableVideo?: boolean;
}

Cette page est générée à partir de src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Si vous utilisez Prise en main pour planifier les opérations du dashboard et de API, connectez-l’avec Utiliser @capgo/capacitor-realtimekit pour la fonctionnalité native de la section « Utiliser @capgo/capacitor-realtimekit », Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans « Clés API », et Appareils pour les détails d'implémentation dans Devices.