跳转至正文

RealtimeKit Capacitor 插件

Cloudflare Calls 集成,内置 UI,支持视频会议和实时通信

安装

bun add @capgo/capacitor-realtimekit bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-realtimekit
  • pnpm add @capgo/capacitor-realtimekit
  • yarn add @capgo/capacitor-realtimekit

指南

如何在 Capacitor 中使用 RealtimeKit

使用 @capgo/capacitor-realtimekit

Capacitor RealtimeKit 插件,用于 Cloudflare 通话集成。

安装

bun add @capgo/capacitor-realtimekit
bunx cap sync

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

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

API 概览

方法 描述
initialize 在使用其他方法前,先初始化 RealtimeKit plugin。
startMeeting 使用内置 UI 开启会议。仅支持 Android 和 iOS。

示例

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

完整参考文档

从使用 @capgo/capacitor-realtimekit 继续

如果你正在使用 使用 @capgo/capacitor-realtimekit 要规划原生插件工作,请将其与 @capgo/capacitor-realtimekit 关于 @capgo/capacitor-realtimekit 中的实现细节, 快速入门 有关“入门指南”中的实现细节, Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 有关 Capgo 开发的 Capacitor 插件的实现细节,以及 添加或更新插件 有关添加或更新插件的实现细节。

常见问题

RealtimeKit 插件常见问题

如何在 Capacitor 应用中安装 RealtimeKit 插件?

运行 "bun add @capgo/capacitor-realtimekit"(或 "npm install @capgo/capacitor-realtimekit"),然后运行 "bunx cap sync",让 iOS 和 Android 项目引入原生 code。再在你的应用 code 中从 "@capgo/capacitor-realtimekit" 导入。

@capgo/capacitor-realtimekit 支持 React、Vue 和 Angular 吗?

支持。RealtimeKit 是一个 Capacitor 包,因此任何运行在 Capacitor 里的 Web 框架都能用,包括 Ionic、React、Vue、Angular、Svelte 和纯 JavaScript。

@capgo/capacitor-realtimekit 支持哪个 Capacitor 版本?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-realtimekit 是免费开源的吗?

是的。code 的源码已在 GitHub 上公开,地址为 https://github.com/Cap-go/capacitor-realtimekit/,该包可在 npm 免费安装。欢迎提交 Bug 报告和 Pull Request。

我能不经过 App Store 审核就更新使用了 RealtimeKit 的 code 吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

发布 RealtimeKit 更新,无需等待应用审核

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo