Skip to main content
@capgo/capacitor-realtimekit Communication Open source

RealtimeKit Capacitor plugin

Cloudflare Calls integration with built-in UI for video meetings and real-time communication

Install

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

Guide

How to use RealtimeKit in Capacitor

Using @capgo/capacitor-realtimekit

Capacitor RealtimeKit Plugin for Cloudflare Calls integration.

Install

bun add @capgo/capacitor-realtimekit
bunx cap sync

bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.

Import

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

API at a glance

Method Description
initialize Initializes the RealtimeKit plugin before using other methods.
startMeeting Start a meeting using the built-in UI. Only available on Android and iOS.

Examples

initialize()

Initializes the RealtimeKit plugin before using other methods.

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

await CapacitorRealtimekit.initialize();

startMeeting()

Start a meeting using the built-in UI. Only available on Android and iOS.

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

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

Full reference

Keep going from Using @capgo/capacitor-realtimekit

If you are using Using @capgo/capacitor-realtimekit to plan native plugin work, connect it with @capgo/capacitor-realtimekit for the implementation detail in @capgo/capacitor-realtimekit, Getting Started for the implementation detail in Getting Started, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins.

FAQ

RealtimeKit plugin FAQ

How do I install the RealtimeKit plugin in a Capacitor app?

Run "bun add @capgo/capacitor-realtimekit" (or "npm install @capgo/capacitor-realtimekit"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-realtimekit" in your app code.

Does @capgo/capacitor-realtimekit work with React, Vue and Angular?

Yes. RealtimeKit is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

Which Capacitor version does @capgo/capacitor-realtimekit support?

Capgo plugins follow Capacitor's major version: use the plugin major version that matches your Capacitor major version (for example plugin v8 with Capacitor 8). The compatibility table in the GitHub README lists the maintained versions.

Is @capgo/capacitor-realtimekit free and open source?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-realtimekit/ and the package is free to install from npm. Bug reports and pull requests are welcome.

Can I update code that uses RealtimeKit without an App Store review?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

Ship RealtimeKit changes without waiting for app review

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Start with Capgo