--- description: Unofficial Capacitor plugin for the RealtimeKit SDK. Add real-time audio, video, and chat to your Capacitor apps on Android, iOS, and Web. title: RealtimeKit Plugin for Capacitor - Capawesome image: https://capawesome.io/docs/assets/images/social/plugins/realtimekit.png --- [ Skip to content](#capawesomecapacitor-realtimekit) [ 🎉 Introducing **Capawesome Platform** — one platform for Live Updates, Native Builds, App Store Publishing, and Insider SDKs.](https://capawesome.io) * [ Formbricks ](/docs/plugins/formbricks/) * [ Geocoder ](/docs/plugins/geocoder/) * [ Google Sign-In ](/docs/plugins/google-sign-in/) * [ libSQL ](/docs/plugins/libsql/) * [ Live Update ](/docs/plugins/live-update/) * [ Managed Configurations ](/docs/plugins/managed-configurations/) * [ Media Session ](/docs/plugins/media-session/) * [ ML Kit ](/docs/plugins/mlkit/) * [ NFC ](/docs/plugins/nfc/) * [ OAuth ](/docs/plugins/oauth/) * [ Pedometer ](/docs/plugins/pedometer/) * [ Photo Editor ](/docs/plugins/photo-editor/) * [ PostHog ](/docs/plugins/posthog/) * [ Printer ](/docs/plugins/printer/) * [ Purchases ](/docs/plugins/purchases/) * RealtimeKit [ RealtimeKit ](/docs/plugins/realtimekit/) * [ iOS ](#ios) * [ Usage ](#usage) * [ API ](#api) * [ Screen Orientation ](/docs/plugins/screen-orientation/) * [ Screenshot ](/docs/plugins/screenshot/) * [ Secure Preferences ](/docs/plugins/secure-preferences/) * [ Speech Recognition ](/docs/plugins/speech-recognition/) * [ Speech Synthesis ](/docs/plugins/speech-synthesis/) * [ Share Target ](/docs/plugins/share-target/) * [ Square Mobile Payments ](/docs/plugins/square-mobile-payments/) * [ SQLite ](/docs/plugins/sqlite/) * [ Superwall ](/docs/plugins/superwall/) * [ Torch ](/docs/plugins/torch/) * [ Wifi ](/docs/plugins/wifi/) * [ Zip ](/docs/plugins/zip/) * [ Cloud ](/docs/cloud/) * [ Live Updates ](/docs/cloud/live-updates/) * Advanced * Integrations * [ Native Builds ](/docs/cloud/native-builds/) * [ Configuration ](/docs/cloud/native-builds/configuration/) * [ Environments ](/docs/cloud/native-builds/environments/) * Guides * [ Sample Projects ](/docs/cloud/native-builds/sample-projects/) * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ Automations ](/docs/cloud/automations/) * Account * Organizations * [ Organization and User Management ](/docs/cloud/organizations/memberships/) * [ Single Sign-On (SSO) ](/docs/cloud/organizations/sso/) * [ Teams ](/docs/cloud/organizations/teams/) * [ Two-Factor Authentication ](/docs/cloud/organizations/two-factor-authentication/) * [ Integrations ](/docs/cloud/integrations/) * [ License Keys ](/docs/cloud/license-keys/) * [ Webhooks ](/docs/cloud/webhooks/) * [ Pricing ](https://capawesome.io/pricing/) * [ FAQ ](/docs/cloud/faq/) * [ Support ](/docs/cloud/support/) * [ Contributing ](/docs/contributing/) * [ LLMs ](/docs/llms/) * [ Insiders ](/docs/insiders/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/insiders/support/) * [ FAQ ](/docs/insiders/faq/) * [ Blog ](/blog/) * Categories * [ iOS ](#ios) * [ Usage ](#usage) * [ API ](#api) # @capawesome/capacitor-realtimekit[¶](#capawesomecapacitor-realtimekit "Permanent link") Unofficial Capacitor plugin for using the [RealtimeKit SDK](https://docs.realtime.cloudflare.com/).[1](#fn:1) ## Newsletter[¶](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Compatibility[¶](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 0.2.x | \>=8.x.x | Active support | | 0.1.x | 7.x.x | Deprecated | ## Installation[¶](#installation "Permanent link") You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1) Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/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: `[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-realtimekit [](#%5F%5Fcodelineno-2-2)npx cap sync ` ### Android[¶](#android "Permanent link") This plugin is supported on Android SDK +24. #### Variables[¶](#variables "Permanent link") This plugin will use the following project variables (defined in your app’s `variables.gradle` file): * `$realtimekitUiVersion` version of `com.cloudflare.realtimekit:ui-android` (default: `0.3.1`) ### iOS[¶](#ios "Permanent link") #### Privacy Descriptions[¶](#privacy-descriptions "Permanent link") Add the following keys to the `ios/App/App/Info.plist` file: `[](#%5F%5Fcodelineno-3-1)NSBluetoothPeripheralUsageDescription [](#%5F%5Fcodelineno-3-2)We will use your Bluetooth to access your Bluetooth headphones. [](#%5F%5Fcodelineno-3-3)NSBluetoothAlwaysUsageDescription [](#%5F%5Fcodelineno-3-4)We will use your Bluetooth to access your Bluetooth headphones. [](#%5F%5Fcodelineno-3-5)NSCameraUsageDescription [](#%5F%5Fcodelineno-3-6)For people to see you during meetings, we need access to your camera. [](#%5F%5Fcodelineno-3-7)NSMicrophoneUsageDescription [](#%5F%5Fcodelineno-3-8)For people to hear you during meetings, we need access to your microphone. [](#%5F%5Fcodelineno-3-9)NSPhotoLibraryUsageDescription [](#%5F%5Fcodelineno-3-10)For people to share, we need access to your photos. [](#%5F%5Fcodelineno-3-11)UIBackgroundModes [](#%5F%5Fcodelineno-3-12) [](#%5F%5Fcodelineno-3-13) audio [](#%5F%5Fcodelineno-3-14) voip [](#%5F%5Fcodelineno-3-15) fetch [](#%5F%5Fcodelineno-3-16) remote-notification [](#%5F%5Fcodelineno-3-17) ` ## Usage[¶](#usage "Permanent link") `[](#%5F%5Fcodelineno-4-1)import { RealtimeKit } from '@capawesome/capacitor-realtimekit'; [](#%5F%5Fcodelineno-4-2) [](#%5F%5Fcodelineno-4-3)const initialize = async () => { [](#%5F%5Fcodelineno-4-4) await RealtimeKit.initialize(); [](#%5F%5Fcodelineno-4-5)}; [](#%5F%5Fcodelineno-4-6) [](#%5F%5Fcodelineno-4-7)const startMeeting = async (options: StartMeetingOptions) => { [](#%5F%5Fcodelineno-4-8) await RealtimeKit.startMeeting(options); [](#%5F%5Fcodelineno-4-9)}; ` ## API[¶](#api "Permanent link") * [initialize()](#initialize) * [startMeeting(...)](#startmeeting) * [Interfaces](#interfaces) ### initialize()[¶](#initialize "Permanent link") `[](#%5F%5Fcodelineno-5-1)initialize() => Promise ` Initialize the RealtimeKit plugin. This method must be called before using any other methods in the plugin. **Since:** 0.0.0 --- ### startMeeting(...)[¶](#startmeeting "Permanent link") `[](#%5F%5Fcodelineno-6-1)startMeeting(options: StartMeetingOptions) => Promise ` Start a meeting using the built-in UI. Only available on Android and iOS. | Param | Type | | ----------- | ------------------------------------------- | | **options** | [StartMeetingOptions](#startmeetingoptions) | **Since:** 0.0.0 --- ### Interfaces[¶](#interfaces "Permanent link") #### StartMeetingOptions[¶](#startmeetingoptions "Permanent link") | Prop | Type | Description | Default | Since | | --------------- | ------- | ----------------------------------------------- | ------- | ----- | | **authToken** | string | The authentication token for the participant. | 0.0.0 | | | **enableAudio** | boolean | Whether to join the meeting with audio enabled. | true | 0.0.0 | | **enableVideo** | boolean | Whether to join the meeting with video enabled. | true | 0.0.0 | --- 1. This project is not affiliated with, endorsed by, sponsored by, or approved by Cloudflare, Inc. or any of their affiliates or subsidiaries. [↩](#fnref:1 "Jump back to footnote 1 in the text") May 7, 2026 Back to top