Skip to main content
Capgo logo
Back to plugins
@capgo/capacitor-twilio-video
Tutorial
@capgo/capacitor-twilio-video

Twilio Video

Join Twilio Video rooms from Capacitor with native audio, camera, and room lifecycle events

Downloads/month

0

GitHub Stars

1

Guide

Tutorial on Twilio Video

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

What This Plugin Exposes

  • login - Store and validate a Twilio Video access token minted by your backend.
  • logout - Clear the cached access token and leave the active room.
  • isLoggedIn - Check whether a valid Twilio token is currently cached on the device.
  • joinRoom - Join a Twilio room and present the plugin's native in-app call overlay.

Example Usage

login

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

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

await CapacitorTwilioVideo.login({} as { accessToken: string });

logout

Clear the cached access token and leave the active room.

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

await CapacitorTwilioVideo.logout();

isLoggedIn

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

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

await CapacitorTwilioVideo.isLoggedIn();

joinRoom

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

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

await CapacitorTwilioVideo.joinRoom({} as { roomName: string; enableAudio?: boolean; enableVideo?: boolean });

Full 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.