Twilio Video Capacitor 插件

使用 @capgo/capacitor-twilio-video

Capacitor API，通过原生应用内通话界面加入 Twilio Video 会议。

安装

bun add @capgo/capacitor-twilio-video
bunx cap sync

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

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

API 概览

方法	描述
login	存储并验证由后端签发的 Twilio Video 访问令牌。
logout	清除缓存的访问令牌并退出当前房间。
isLoggedIn	检查设备当前是否缓存了有效的 Twilio 令牌。
joinRoom	加入 Twilio 房间并显示插件的原生应用内通话浮层。
leaveRoom	如果已连接，则退出当前房间。
setMicrophoneEnabled	启用/禁用本地麦克风发布。
setCameraEnabled	启用/禁用本地摄像头发布。
getCallStatus	返回当前房间名称、媒体状态和参与者人数。
checkMicrophonePermission	检查麦克风权限状态。
requestMicrophonePermission	请求麦克风权限。
checkCameraPermission	检查摄像头权限状态。
requestCameraPermission	请求摄像头权限。

示例

login()

存储并验证由后端签发的 Twilio Video 访问令牌。

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

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

logout()

清除缓存的访问令牌并退出当前房间。

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

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

isLoggedIn()

检查设备当前是否缓存了有效的 Twilio 令牌。

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

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

joinRoom()

加入 Twilio 房间并显示插件的原生应用内通话浮层。

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

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

leaveRoom()

如果已连接，则退出当前房间。

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

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

setMicrophoneEnabled()

启用/禁用本地麦克风发布。

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

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

上表列出了 12 个核心方法。监听器、版本辅助方法以及每个方法的完整接口约定，详见 GitHub 仓库.

监听事件

addListener 会返回一个句柄。调用 handle.remove() 在屏幕卸载时，或者调用 CapacitorTwilioVideo.removeAllListeners() 以清除所有监听器。

完整参考文档

• GitHub 仓库
• 文档
• API 参考文档

继续阅读：使用 @capgo/capacitor-twilio-video

如果你正在使用 使用 @capgo/capacitor-twilio-video 来规划原生媒体和界面行为，并将其与 @capgo/capacitor-twilio-video 有关 @capgo/capacitor-twilio-video 的实现细节， 快速入门 有关“入门指南”中的实现细节， 使用 @capgo/capacitor-live-activities 用于使用 @capgo/capacitor-live-activities 时的原生能力， @capgo/capacitor-live-activities 关于 @capgo/capacitor-live-activities 中的实现细节，以及 使用 @capgo/capacitor-video-player 有关“使用 @capgo/capacitor-video-player.”中的原生能力