Twilio Video Capacitor plugin

Using @capgo/capacitor-twilio-video

Capacitor API for joining Twilio Video rooms with a native in-app call surface.

Install

bun add @capgo/capacitor-twilio-video
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 { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

API at a glance

Examples

login()

Store and validate a Twilio Video access token minted by your backend.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.login({ accessToken: 'access-token-123' });
console.log(result);

logout()

Clear the cached access token and leave the active room.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.logout();
console.log(result);

isLoggedIn()

Check whether a valid Twilio token is currently cached on the device.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.isLoggedIn();
// The result holds sensitive values: use it without logging it.

joinRoom()

Join a Twilio room and present the plugin's native in-app call overlay.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.joinRoom({ roomName: 'room' });
console.log(result);

leaveRoom()

Leave the current room if connected.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.leaveRoom();
console.log(result);

setMicrophoneEnabled()

Enable/disable local microphone publishing.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.setMicrophoneEnabled({ enabled: true });
console.log(result);

The table above lists the 12 core methods. Listener and version helpers, and the full contract of each method, are documented in the GitHub repository.

Listen to events

addListener returns a handle. Call handle.remove() when the screen unmounts, or CapacitorTwilioVideo.removeAllListeners() to clear every listener.

Full reference

• GitHub repository
• Documentation
• API reference

Keep going from Using @capgo/capacitor-twilio-video

If you are using Using @capgo/capacitor-twilio-video to plan native media and interface behavior, connect it with @capgo/capacitor-twilio-video for the implementation detail in @capgo/capacitor-twilio-video, Getting Started for the implementation detail in Getting Started, Using @capgo/capacitor-live-activities for the native capability in Using @capgo/capacitor-live-activities, @capgo/capacitor-live-activities for the implementation detail in @capgo/capacitor-live-activities, and Using @capgo/capacitor-video-player for the native capability in Using @capgo/capacitor-video-player.