Getting Started
Copy a setup prompt with the install steps and the full markdown guide for this plugin.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-twilio-video`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/twilio-video/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
Install
Section titled “Install”bun add @capgo/capacitor-twilio-videobunx cap syncImport
Section titled “Import”import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';API Overview
Section titled “API Overview”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
Section titled “logout”Clear the cached access token and leave the active room.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.logout();isLoggedIn
Section titled “isLoggedIn”Check whether a valid Twilio token is currently cached on the device.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.isLoggedIn();joinRoom
Section titled “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 });leaveRoom
Section titled “leaveRoom”Leave the current room if connected.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.leaveRoom();setMicrophoneEnabled
Section titled “setMicrophoneEnabled”Enable/disable local microphone publishing.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.setMicrophoneEnabled({} as { enabled: boolean });setCameraEnabled
Section titled “setCameraEnabled”Enable/disable local camera publishing.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.setCameraEnabled({} as { enabled: boolean });getCallStatus
Section titled “getCallStatus”Return the current room name, media state, and participant count.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.getCallStatus();checkMicrophonePermission
Section titled “checkMicrophonePermission”Check microphone permission state.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.checkMicrophonePermission();requestMicrophonePermission
Section titled “requestMicrophonePermission”Request microphone permission.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.requestMicrophonePermission();checkCameraPermission
Section titled “checkCameraPermission”Check camera permission state.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.checkCameraPermission();requestCameraPermission
Section titled “requestCameraPermission”Request camera permission.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.requestCameraPermission();Source Of Truth
Section titled “Source Of Truth”This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.