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.