メインコンテンツへスキップ
@capgo/capacitor-twilio-video コミュニケーション オープンソース

Twilio Video Capacitor プラグイン

Capacitorからネイティブの音声、カメラ、ルームライフサイクルイベント付きでTwilio Videoルームに参加

インストール

bun add @capgo/capacitor-twilio-video bunx cap sync
npm、pnpm、または yarn
  • npm install @capgo/capacitor-twilio-video
  • pnpm add @capgo/capacitor-twilio-video
  • yarn add @capgo/capacitor-twilio-video

ガイド

Capacitor で Twilio Video を使う方法

@capgo/capacitor-twilio-video の使い方

Twilio Video ルームにネイティブのアプリ内通話 UI で参加するための Capacitor API。

インストール

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

bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。

ネイティブの SDK フロアと権限

プラットフォーム SDK フロア 最低OS
iOSと Swift Package Manager from: "5.11.3". CocoaPods TwilioVideo ~> 5.11 5.11.x すべてを許可し、それ自体では 5.11.3 を要求しません。 iOS 15 以降
Androidでは com.twilio:video-android:7.10.5 API 24+
Web 未実装。すべてのメソッドが throw します unimplemented. なし

これらのキーを追加します ios/App/App/Info.plist:

<key>NSMicrophoneUsageDescription</key>
<string>This app uses the microphone for video calls</string>
<key>NSCameraUsageDescription</key>
<string>This app uses the camera for video calls</string>

このプラグインは、Capacitor のパーミッションエイリアスを登録します RECORD_AUDIO と CAMERA。オーディオまたはビデオで参加する前に、それらをリクエストしてください。ホストアプリがプラグインのマニフェストマージャーエントリを継承しない場合は、パーミッションを以下に宣言してください android/app/src/main/AndroidManifest.xml:

<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.CAMERA" />

Twilio Video のアクセストークンは、バックエンドで短期有効期限付きで発行してください。モバイルアプリ内でトークンを発行しないでください。

インポート

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

API の概要

メソッド 説明
login バックエンドで発行された Twilio Video アクセストークンを保存して検証します。
logout キャッシュされたアクセストークンをクリアし、アクティブなルームから退出します。
isLoggedIn 有効な Twilio トークンがデバイスにキャッシュされているか確認します。
joinRoom Twilioのルームに参加し、プラグインのネイティブなアプリ内通話オーバーレイを表示します。
leaveRoom 接続中の場合は、現在のルームから退出します。
setMicrophoneEnabled ローカルマイクのパブリッシュを有効/無効にします。
setCameraEnabled ローカルカメラのパブリッシュを有効/無効にします。
getCallStatus 現在のルーム名、メディア状態、参加者数を返します。
checkMicrophonePermission マイクの権限状態を確認します。
requestMicrophonePermission マイクの権限をリクエストします。
checkCameraPermission カメラの権限状態を確認します。
requestCameraPermission カメラの権限をリクエストします。
addListener ルームおよび参加者のライフサイクルイベントを監視します。
removeAllListeners このプラグインインスタンスで登録されたすべてのリスナーを削除します。

使い方

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

const token = await fetchVideoTokenFromYourBackend();

await CapacitorTwilioVideo.requestMicrophonePermission();
await CapacitorTwilioVideo.requestCameraPermission();

await CapacitorTwilioVideo.login({ accessToken: token });

await CapacitorTwilioVideo.addListener('roomConnected', ({ roomName, participantCount }) => {
  console.log('Connected', roomName, participantCount);
});

await CapacitorTwilioVideo.addListener('participantConnected', ({ identity, participantCount }) => {
  console.log('Participant joined', identity, participantCount);
});

await CapacitorTwilioVideo.joinRoom({
  roomName: 'daily-standup',
  enableAudio: true,
  enableVideo: true,
});

const status = await CapacitorTwilioVideo.getCallStatus();
console.log(status.callState, status.isMicrophoneEnabled, status.isCameraEnabled);

await CapacitorTwilioVideo.setMicrophoneEnabled({ enabled: false });
await CapacitorTwilioVideo.setCameraEnabled({ enabled: true });

await CapacitorTwilioVideo.leaveRoom();
await CapacitorTwilioVideo.logout();

joinRoom デフォルトは enableAudio: true と enableVideo: false.

例

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: 'daily-standup',
  enableAudio: true,
  enableVideo: true,
});
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 の実装の詳細については、 スタートガイド スタートガイドの実装詳細については、 @capgo/capacitor-live-activities の使用 @capgo/capacitor-live-activities の使用におけるネイティブ機能については、 @capgo/capacitor-live-activities @capgo/capacitor-live-activities の実装の詳細については、 @capgo/capacitor-video-playerの使用方法 「@capgo/capacitor-video-player. の使い方」のネイティブ機能については

よくある質問

Twilio Video プラグイン FAQ

Capacitor アプリに Twilio Video プラグインをインストールするには?

「bun add @capgo/capacitor-twilio-video」(または「npm install @capgo/capacitor-twilio-video」)を実行し、次に「bunx cap sync」を実行して、iOS と Android プロジェクトがネイティブ code を認識するようにします。アプリの code から「@capgo/capacitor-twilio-video」をインポートします。

@capgo/capacitor-twilio-video は React、Vue、Angular で動作しますか?

はい。Twilio Video は Capacitor パッケージであるため、Ionic、React、Vue、Angular、Svelte、プレーン JavaScript を含む、Capacitor 内で動作するすべての Web フレームワークで動作します。

@capgo/capacitor-twilio-video はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-twilio-video は無料でオープンソースですか?

はい。ソース code は https://github.com/Cap-go/capacitor-twilio-video/ の GitHub で公開されており、npm から無料でインストールできます。バグ報告やプルリクエストをお待ちしています。

Twilio Video を使用している code を、App Store のレビューなしで更新できますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリレビューを待たずにTwilio Videoの変更を配信

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める