Skip to main content
Back to plugins
@capgo/capacitor-realtimekit
Tutorial
@capgo/capacitor-realtimekit

RealtimeKit

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

Guide

Tutorial on RealtimeKit

Using @capgo/capacitor-realtimekit

Capacitor RealtimeKit Plugin for Cloudflare Calls integration.

Install

bun add @capgo/capacitor-realtimekit
bunx cap sync

What This Plugin Exposes

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

Example Usage

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.