capacitor-realtimekit

Add video meetings to your Capacitor app with Cloudflare RealtimeKit and its built-in meeting UI on iOS and Android.

Capgo: push fixes to your Capacitor users in minutes, build signed iOS and Android apps without a Mac, and roll back in one click.

➡️ Get started for free

14-day unlimited free trial. No credit card required

Missing a feature? We'll build the plugin for you 💪

🤖 Building with an AI coding agent? Install Capgo skills so Claude Code, Codex, Cursor, Copilot, or Gemini CLI know how to install and use @capgo/capacitor-realtimekit in your Capacitor app: npx skills add Cap-go/capgo-skills. Then ask your agent: "Add @capgo/capacitor-realtimekit to my Capacitor app and wire it up." Agent setup guides · Hosted MCP

Key features

• Setup: initialize() prepares the SDK.
• Built-in UI: startMeeting() opens a full meeting screen from an auth token.
• Media options: start with audio and video on or off.
• Native SDKs: Cloudflare RealtimeKit and RealtimeKit UI on both platforms.
• Platforms: iOS and Android. Not available on web.

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/realtimekit/

Compatibility

Plugin version	Capacitor compatibility	Maintained
v8.*.*	v8.*.*	✅
v7.*.*	v7.*.*	On demand
v6.*.*	v6.*.*	❌
v5.*.*	v5.*.*	❌

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

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/capacitor-skills --skill capacitor-plugins

Then use the following prompt:

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

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

npm install @capgo/capacitor-realtimekit
npx cap sync

Dependencies

This plugin uses the Cloudflare RealtimeKit SDK:

• iOS: realtimekit-ios-ui plus its matching RealtimeKit core dependency (automatically installed via Swift Package Manager)
• Android: com.cloudflare.realtimekit:ui-android version 0.2.2 (can be customized via gradle variable realtimekitUiVersion)

Customizing Android RealtimeKit Version

In your app's build.gradle:

buildscript {
    ext {
        realtimekitUiVersion = '0.2.2'  // or your desired version
    }
}

Platform Support

• iOS: ✅ Supported (iOS 14.0+)
• Android: ✅ Supported (API 24+)
• Web: ❌ Not supported (native only)

iOS Configuration

Add the following to your app's Info.plist file:

<key>NSCameraUsageDescription</key>
<string>We need camera access for video calls</string>
<key>NSMicrophoneUsageDescription</key>
<string>We need microphone access for audio calls</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>We need photo library access to share images</string>
<key>NSBluetoothPeripheralUsageDescription</key>
<string>We need Bluetooth access for audio routing</string>

<key>UIBackgroundModes</key>
<array>
  <string>audio</string>
  <string>voip</string>
  <string>fetch</string>
  <string>remote-notification</string>
</array>

Android Configuration

Add the following permissions to your app's AndroidManifest.xml file:

<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />

<uses-feature android:name="android.hardware.camera" android:required="false" />
<uses-feature android:name="android.hardware.camera.autofocus" android:required="false" />

API

• initialize()
• startMeeting(...)
• getPluginVersion()
• Interfaces

Capacitor RealtimeKit Plugin for Cloudflare Calls integration.

initialize()

initialize() => Promise<void>

Initializes the RealtimeKit plugin before using other methods.

Since: 7.0.0

---

startMeeting(...)

startMeeting(options: StartMeetingOptions) => Promise<void>

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

Param	Type	Description
options	StartMeetingOptions	- Configuration options for the meeting

Since: 7.0.0

---

getPluginVersion()

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version.

Returns: Promise<{ version: string; }>

Since: 7.0.0

---

Interfaces

StartMeetingOptions

Configuration options for starting a meeting.

Prop	Type	Description	Default	Since
authToken	string	Authentication token for the participant. This token is required to join the Cloudflare Calls meeting.		7.0.0
enableAudio	boolean	Whether to join with audio enabled. Default is true.	true	7.0.0
enableVideo	boolean	Whether to join with video enabled. Default is true.	true	7.0.0