Anleitung zum Einstieg

GitHub

Kopieren Sie eine Einrichtungsanweisung mit den Installationsanweisungen und der vollständigen Markdown-Guide 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-realtimekit`
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/realtimekit/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

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

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-realtimekit` 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-realtimekit
bunx cap sync

Importieren

import { CapacitorRealtimekit } from '@capgo/capacitor-realtimekit';

API Übersicht

`initialize`

Initialisiert den RealtimeKit-Plugin vor der Verwendung anderer Methoden.

import { CapacitorRealtimekit } from '@capgo/capacitor-realtimekit';

await CapacitorRealtimekit.initialize();

`startMeeting`

Mit der integrierten Benutzeroberfläche eine Sitzung starten. Nur auf Android und iOS verfügbar.

import { CapacitorRealtimekit } from '@capgo/capacitor-realtimekit';

await CapacitorRealtimekit.startMeeting({
  authToken: 'your-auth-token',
  enableAudio: true,
  enableVideo: true,
});

Typenverweis

`StartMeetingOptions`

Konfigurationsoptionen für das Starten einer Sitzung.

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

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API upstream ändert.

Weiter von Getting Started

Wenn Sie "Getting Started" verwenden, um das Dashboard und die __CAPGO_KEEP_0__-Operationen zu planen, verbinden Sie es mit Mit @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-realtimekit für die native Fähigkeit in Mit @API/__CAPGO_KEEP_1__-realtimekit Using @capgo/capacitor-realtimekit for the native capability in Using @capgo/capacitor-realtimekit, Mit @API/__CAPGO_KEEP_1__-realtimekit für die Implementierungsdetails in API Übersicht, Einführung für die Implementierungsdetails in Einführung, API Schlüssel für die Implementierungsdetails in API Schlüssel, und Geräte für die Implementierungsdetails in Geräte.