跳过内容

开始

GitHub
终端窗口
bun add @capgo/capacitor-twilio-video
bunx cap sync

导入

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

API概述

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();

加入Twilio房间并显示插件的原生在应用内的呼叫浮窗.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.joinRoom({} as { roomName: string; enableAudio?: boolean; enableVideo?: boolean });

如果已连接,则离开当前房间.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.leaveRoom();

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

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.setMicrophoneEnabled({} as { enabled: boolean });

开启/关闭本地摄像头发布.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.setCameraEnabled({} as { enabled: boolean });

getCallStatus

getCallStatus

获取当前房间名称、媒体状态和参与人数.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.getCallStatus();

checkMicrophonePermission

checkMicrophonePermission

复制到剪贴板

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.checkMicrophonePermission();

requestMicrophonePermission

复制到剪贴板

requestMicrophonePermission

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.requestMicrophonePermission();

checkCameraPermission

checkCameraPermission

检查相机权限状态。

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.checkCameraPermission();

请求相机权限。

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
await CapacitorTwilioVideo.requestCameraPermission();

本页面是由插件生成的 src/definitions.ts当公共 API 在上游发生变化时,重新运行同步。

如果您正在使用 开始使用 为原生媒体和界面行为打算,连接它与 使用 @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 中, @capgo/capacitor-video-player 为 @capgo/capacitor-video-player 的实现细节.