ガイド
CapacitorでTwilio Videoを使用する方法
@capgo/capacitor-twilio-videoを使用する
Capacitor API は、Twilio Video ルームにnative in-appコールサーフェイスで参加するためのものです。
インストール
bun add @capgo/capacitor-twilio-video
bunx cap sync
bunx cap sync プラグインのnative codeをnativeプロジェクトにコピーします。プラグインのアップグレード後は、再度実行してください。
インポート
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()
Twilio Video アクセストークンを生成したバックエンドでストアして検証します。
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.logout();
console.log(result);
isLoggedIn()
キャッシュされたアクセストークンをクリアし、現在のルームを離れます。
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()
Twilioルームに参加し、プラグインのネイティブインアプリコールオーバーレイを表示します。
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);
ローカルマイクの出版を有効/無効にします。 GitHub リポジトリ.
__CAPGO_KEEP_0__ リポジトリ
addListener ハンドルを返します。Call handle.remove() 画面がアンマウントされたとき、または CapacitorTwilioVideo.removeAllListeners() すべてのリスナーをクリアするときに呼び出してください。
フルリファレンス
続けて @capgo/capacitor-twilio-video を使用してください
@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-twilio-video を使用している場合 Using @capgo/capacitor-twilio-video @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-twilio-video を使用してください @capgo/capacitor-twilio-video を使用している場合 @capgo/capacitor-Twilioビデオの実装詳細 Capacitor-Twilio-Videoの始め方 Capacitor-Twilio-Video用途の実装詳細について @capgo/capacitorライブ活動を使用 native機能のために@capgo/capacitor-live-activitiesを使用します。 @capgo/capacitor-ライブ活動 @capgo/capacitor-ライブアクティビティの実装詳細について Using @capgo/capacitor-video-player Capacitor-twilio-videoのネイティブ機能のために@capgo/capacitor-video-playerを使用します。