Skip to content

@capgo/capacitor-twilio-video

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

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

  • 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.
MethodDescription
loginStore and validate a Twilio Video access token minted by your backend.
logoutClear the cached access token and leave the active room.
isLoggedInCheck whether a valid Twilio token is currently cached on the device.
joinRoomJoin a Twilio room and present the plugin’s native in-app call overlay.
leaveRoomLeave the current room if connected.
setMicrophoneEnabledEnable/disable local microphone publishing.
setCameraEnabledEnable/disable local camera publishing.
getCallStatusReturn the current room name, media state, and participant count.
checkMicrophonePermissionCheck microphone permission state.
requestMicrophonePermissionRequest microphone permission.
checkCameraPermissionCheck camera permission state.
requestCameraPermissionRequest camera permission.
addListenerListen for room connected events.
addListenerListen for room disconnected events.
addListenerListen for participant connected events.
addListenerListen for participant disconnected events.
addListenerListen for reconnection start events.
addListenerListen for reconnection success events.
removeAllListenersRemove every listener registered through this plugin instance.

This reference is synced from src/definitions.ts in capacitor-twilio-video.