RTC ルームと Web SDK
- プロジェクトとスコープ付きキーを RTC コンソール.
- バックエンドでは、以下の方法を使用してルームを作成します。 サーバー API.
- アプリケーションはユーザーを認証し、そのユーザーのルームメンバーシップを確認します。
- バックエンドは、その認証済みルームの参加者認証情報を要求します。
- クライアントはそれらの認証情報を使用して参加し、許可されればメディアを配信します。
- セッションが終了すると、バックエンドがルームを終了します。
エンドユーザーにはプロジェクトAPIキーは提供されません。アプリケーションの 識別情報、メンバーシップ、同意、およびユーザーインターフェースについては、引き続き貴社が責任を負うことになります。
バックエンドからルームを作成する
Section titled “バックエンドからルームを作成する”# Replace the sample UUID with the project ID copied from your console.curl --fail-with-body \ --request POST https://api.rtc.champrep.com/v1/rooms \ --header "Authorization: Bearer $RTC_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"projectId":"00000000-0000-4000-8000-000000000001","name":"Product support","maxParticipants":4}'返されたデータを保存する id をミュートまたはミュート解除します。 maxParticipants
は、現在の制約APIとアクティブなプランの許容量の両方に適合している必要があります。 曖昧なタイムアウトが発生した後、自動的にルームの作成を繰り返さないでください。 最初のリクエストが成功していた可能性があるためです。 まずリストを確認する.
参加者の認証情報を取得する
Section titled “参加者の認証情報を取得する”ユーザーのアクセス権限を確認した後、バックエンドは以下を送信します:
curl --fail-with-body \ --request POST "https://api.rtc.champrep.com/v1/rooms/$RTC_ROOM_ID/tokens" \ --header "Authorization: Bearer $RTC_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"canPublish":true}'応答には以下が含まれます token, participantId, expiresIn, url、および
iceServers。その認証情報セットを、キャッシュを無効にした 独自の認証済みエンドポイントを通じて、承認されたクライアントに渡してください。これらすべてを 機密情報として扱ってください。認証情報は参加のために5分後に失効し、 参加に成功した後は再利用できません。これは、最大通話時間が5分であることを意味するものではありません。
ブラウザ SDK
Section titled “ブラウザ SDK”サポートされている JavaScript/TypeScript Web SDK配信をご利用ください。
お問い合わせ CHAMPREP パッケージへのアクセスおよび インストール手順については、こちらをご覧ください。同様の名前を持つサードパーティ製パッケージはインストールしないでください。 以下の例では、提供された RtcSession
アプリケーション内のクラスです。そのインポートパスは、そのディストリビューションによって異なります。
const session = new RtcSession();
session.addEventListener('state', (event) => { updateConnectionLabel((event as CustomEvent).detail);});session.addEventListener('track', (event) => { const { id, stream, kind } = (event as CustomEvent).detail; attachRemoteMedia(id, stream, kind);});session.addEventListener('trackremoved', (event) => { removeRemoteMedia((event as CustomEvent).detail);});session.addEventListener('localtrack', (event) => { showLocalPreview((event as CustomEvent).detail);});session.addEventListener('error', (event) => { showCallError((event as CustomEvent).detail);});
await session.connect(async () => { // Your server authenticates this session and authorizes its room membership. // Implement CSRF protection appropriate to your application's session model. const response = await fetch('/your-app/rtc/join', { method: 'POST', credentials: 'same-origin', cache: 'no-store', }); if (!response.ok) throw new Error('Unable to join this room'); return response.json();});
// Call from your application's explicit microphone/camera consent flow.await session.publish(true);
// Call when leaving or unmounting the call screen.// session.close();メディアのレンダリングおよびエラー処理に関する関数は、アプリケーション固有の プレースホルダーです。返された各ストリームを適切なオーディオまたはビデオ 要素に紐付け、ローカルプレビューをミュートし、設定を playsInline 、および ユーザーが操作する再生コントロールによる自動再生の拒否への対応を行います。リモートオーディオトラックには、 動画がない場合でも、オーディオ対応の要素が必要です。
SDK コントロール
Section titled “SDK コントロール”| 方法 | 動作 |
|---|---|
connect(tokenProvider) | 新しい認証情報を返す関数を使用して参加する |
publish(true) | マイクとカメラをリクエストし、それぞれのトラックを配信する |
publish(false) | カメラの映像なしでマイクの音声を配信する |
setMuted(true) / setMuted(false) | マイクプロデューサーのミュートまたはミュート解除 |
setCamera(false) / setCamera(true) | カメラプロデューサーの有効化または無効化 |
shareScreen() | ブラウザのファイル選択ダイアログを開き、動画のみのスクリーントラックを公開してください |
setReceiveQuality('low') | 受信した動画の画質を下げる |
setReceiveQuality('auto') | 受信動画の設定を通常状態に戻す |
close() | ワークスペースからの退出、トランスポートの終了、およびキャプチャされたトラックの解放 |
呼び出さないでください publish 受信専用の参加者の場合。UI での重複した配信 操作を防止してください。画面音声はこの機能ではキャプチャされませんAPI。共有を 停止するには、ブラウザの「共有を停止」コントロールを使用してください。ミュートは 退室とは異なります。通話 close() セッションおよびキャプチャされたデバイスを解放します。
ネットワークの変更とライフサイクル
Section titled “ネットワークの変更とライフサイクル”は、シグナリングの中断後に再接続を試みSDK、 トークンプロバイダ関数を再度使用します。常に new アクセス確認後に トークンを発行してください。使用済みのトークンをキャッシュしてはいけません。再接続には制限があり、失敗する可能性があります。 接続状態およびエラー状態を表示し、ユーザーが制御できる再接続フローを提供してください。
低帯域幅モードでは、受信される動画の画質が低下します。また、使用不可能な接続環境では通話を 保証することはできません。必要に応じて、音声のみの配信をご検討ください。 またSDK、 new RtcSession({ iceTransportPolicy: 'relay' }) 「 中継専用接続」にも対応しており、これには到達可能な中継サービスが必要です。
リリース前に、実機、ブラウザの権限、制限付きネットワーク、バックグラウンド実行、 画面共有、および再接続時の挙動をテストしてください。Python、Node.js、SDKs およびMEAN/MERN/MENのガイドは引き続き利用可能です。 ロードマップ項目.