@capawesome/capacitor-realtimekit¶

Unofficial Capacitor plugin for using the RealtimeKit SDK.¹

Installation¶

npm install @capawesome/capacitor-realtimekit
npx cap sync

Android¶

This plugin is supported on Android SDK +24.

Variables¶

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.2.2)

iOS¶

Privacy Descriptions¶

Add the following keys to the ios/App/App/Info.plist file:

<key>NSBluetoothPeripheralUsageDescription</key>
<string>We will use your Bluetooth to access your Bluetooth headphones.</string>
<key>NSBluetoothAlwaysUsageDescription</key>
<string>We will use your Bluetooth to access your Bluetooth headphones.</string>
<key>NSCameraUsageDescription</key>
<string>For people to see you during meetings, we need access to your camera.</string>
<key>NSMicrophoneUsageDescription</key>
<string>For people to hear you during meetings, we need access to your microphone.</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>For people to share, we need access to your photos.</string>
<key>UIBackgroundModes</key>
    <array>
        <string>audio</string>
        <string>voip</string>
        <string>fetch</string>
        <string>remote-notification</string>
    </array>

Usage¶

import { RealtimeKit } from '@capawesome/capacitor-realtimekit';

const initialize = async () => {
  await RealtimeKit.initialize();
};

const startMeeting = async (options: StartMeetingOptions) => {
  await RealtimeKit.startMeeting(options);
};

initialize()¶

initialize() => Promise<void>

Initialize the RealtimeKit plugin.

This method must be called before using any other methods in the plugin.

Since: 0.0.0

startMeeting(...)¶

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

Start a meeting using the built-in UI.

Only available on Android and iOS.

Param	Type
`options`	`StartMeetingOptions`

Since: 0.0.0

Interfaces¶

StartMeetingOptions¶

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

This project is not affiliated with, endorsed by, sponsored by, or approved by Cloudflare, Inc. or any of their affiliates or subsidiaries. ↩