ガイド
Capacitor で Twilio Video を使用する方法
@capgo/capacitor-twilio-video の使用方法
ネイティブなインアプリ通話画面で Twilio Video ルームに参加するための Capacitor API
インストール
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() すべてのリスナーを解除するには
リファレンス全文
@capgo/capacitor-twilio-video の使用方法へ進む
以下を使用している場合： @capgo/capacitor-twilio-video の使用方法 ネイティブのメディアとインターフェースの挙動を計画するには、これを次と連携させてください： @capgo/capacitor-twilio-video @capgo/capacitor-twilio-video の実装詳細については、 はじめに Getting Started の実装の詳細については、 @capgo/capacitor-live-activities の使用 @capgo/capacitor-live-activities を使用したネイティブ機能について、 @capgo/capacitor-live-activities @capgo/capacitor-live-activities の実装詳細、および @capgo/capacitor-video-player の使用 @capgo/capacitor-video-player. を使用したネイティブ機能について