--- 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: Capacitor RealtimeKit Plugin for Android & iOS - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/realtimekit.png --- [Skip to content ](#capawesomecapacitor-realtimekit) [πŸ” Introducing the **Capacitor Vault** plugin β€” store secrets behind biometrics or a device passcode. ](/blog/announcing-the-capacitor-vault-plugin/) * [ SDKs ](/docs/sdks/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * RealtimeKit [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ iOS ](#ios) * [ Usage ](#usage) * [ API ](#api) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * [ Zip ](/docs/sdks/capacitor/zip/) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * APIs and SDKs * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ 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 17, 2026 Back to top