快速入门

安装

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

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

然后使用以下 prompt：

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

快速入门

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

await CapacitorRealtimekit.initialize();

示例：startMeeting

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

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

常见坑点

• 初始化一次: 在应用启动时运行 setup。
• 原生同步：运行 bunx cap sync 在插件升级后。
• 唯一可信来源：信任 src/definitions.ts 在 GitHub 仓库中。

API 概览

initialize

在使用其他方法前，先初始化 RealtimeKit plugin。

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 发生变化时，请重新运行 sync。

从入门指南继续

如果你正在使用 快速入门 要规划 dashboard 和 API 操作，请将其连接到 使用 @capgo/capacitor-realtimekit 关于使用 @capgo/capacitor-realtimekit 中的原生能力， API 概览 关于 API Overview 中的实现细节， 简介 关于 Introduction 中的实现细节， API 密钥 有关 API Keys 的实现细节，以及 设备 有关 Devices 的实现细节。