开始使用

复制一个包含安装步骤和本插件的全 Markdown 指南的设置提示.

        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.

安装

您可以使用我们的 AI 助手设置来安装插件。使用以下命令将 Capgo 技能添加到您的 AI 工具中：

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

然后使用以下提示：

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

如果您更喜欢手动设置，请运行以下命令并按照以下平台特定的说明进行操作：

bun add @capgo/capacitor-realtimekit
bunx cap sync

导入

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

API 概述

`initialize`

Initializes the RealtimeKit plugin before using other methods.

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

await CapacitorRealtimekit.initialize();

`startMeeting`

使用内置 UI 开始会议。仅在 Android 和 iOS 上可用。

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

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

类型参考

`StartMeetingOptions`

开始会议的配置选项。

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

数据源

该页面是由插件生成的 src/definitions.ts当公共API上游发生变化时，请重新同步。

继续从开始

如果您正在使用开始规划仪表板和API操作，请将其与使用@capgo/capacitor-实时工具使用@capgo/capacitor-实时工具 API概述为实现细节在API概述中简介为实现细节在简介中 API密钥为实现细节在API密钥中，和设备为实现细节在设备中。