开始使用

复制一个带有安装步骤和完整 Markdown 指南的设置提示。

        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.

安装

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

导入

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

API 介绍

`login`

将由您的后端生成的Twilio Video访问令牌存储并验证。

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

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

`logout`

清除缓存的访问令牌并离开活动房间。

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

await CapacitorTwilioVideo.logout();

`isLoggedIn`

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

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

await CapacitorTwilioVideo.isLoggedIn();

`joinRoom`

复制到剪贴板

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

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

`leaveRoom`

设置麦克风

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

await CapacitorTwilioVideo.leaveRoom();

`setMicrophoneEnabled`

复制到剪贴板

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

await CapacitorTwilioVideo.setMicrophoneEnabled({} as { enabled: boolean });

`setCameraEnabled`

启用/禁用本地摄像头发布。

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

await CapacitorTwilioVideo.setCameraEnabled({} as { enabled: boolean });

`getCallStatus`

返回当前房间名称、媒体状态和参与人数。

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

await CapacitorTwilioVideo.getCallStatus();

`checkMicrophonePermission`

检查麦克风权限状态。

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

await CapacitorTwilioVideo.checkMicrophonePermission();

`requestMicrophonePermission`

请求麦克风权限。

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

await CapacitorTwilioVideo.requestMicrophonePermission();

`checkCameraPermission`

检查相机权限状态。

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

await CapacitorTwilioVideo.checkCameraPermission();

`requestCameraPermission`

复制到剪贴板

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

await CapacitorTwilioVideo.requestCameraPermission();

Section titled “Source Of Truth”

当公共 __CAPGO_KEEP_0__ 上游发生变化时，请重新运行同步。 src/definitions.ts. Re-run the sync when the public API changes upstream.