インターフェースリスト
サポートするプラットフォーム
TRTC Web SDKはWebRTCをベースに実現しており、現在デスクトップおよびモバイル端末の主流ブラウザをサポートしています。サポートの程度の詳細については下の表をご参照ください。
サポート対象の表内にユースケースが見当たらない場合は、TRTC Web SDK機能テスト画面を開き、現在の環境がWebRTCのすべての機能をサポートしているかどうかチェックすることができます(例:WebViewなどの環境)。
OS | ブラウザタイプ | ブラウザの最小バージョン要件 | SDKのバージョン要件 | 受信(再生) | 送信(マイク・オン) | 画面共有 |
Windows | デスクトップ版Chromeブラウザ | 56+ | - | サポートしています | サポートしています | Chrome72以降のバージョンをサポート |
| デスクトップ版QQブラウザ(クイックコア) | 10.4+ | - | サポートしています | サポートしています | サポートしていません |
| デスクトップ版Firefoxブラウザ | 56+ | v4.7.0+ | サポートしています | サポートしています | Firefox66以降のバージョンをサポート |
| デスクトップ版Edgeブラウザ | 80+ | v4.7.0+ | サポートしています | サポートしています | サポートしています |
| デスクトップ版Sogouブラウザ(高速モード) | 11+ | v4.7.0+ | サポートしています | サポートしています | サポートしています |
| デスクトップ版Sogouブラウザ(互換モード) | - | - | サポートしていません | サポートしていません | サポートしていません |
| デスクトップ版Operaブラウザ | 46+ | v4.7.0+ | サポートしています | サポートしています | Opera60以降のバージョンをサポート |
| デスクトップ版360SEブラウザ(超高速モード) | 13+ | v4.7.0+ | サポートしています | サポートしています | サポートしています |
| デスクトップ版360SEブラウザ(互換モード) | - | - | サポートしていません | サポートしていません | サポートしていません |
| デスクトップ版WeChat Embeddedブラウザ | - | - | サポートしています | サポートしていません | サポートしていません |
| デスクトップ版WeCom Embeddedブラウザ | - | - | サポートしています | サポートしていません | サポートしていません |
Mac OS | デスクトップ版Safariブラウザ | 11+ | - | サポートしています | サポートしています | Safari13以降のバージョンをサポート |
| デスクトップ版Chromeブラウザ | 56+ | - | サポートしています | サポートしています | Chrome72以降のバージョンをサポート |
| デスクトップ版Firefoxブラウザ | 56+ | v4.7.0+ | サポートしています | サポートしています | Firefox66以降のバージョンをサポート(注意[3]) |
| デスクトップ版Edgeブラウザ | 80+ | v4.7.0+ | サポートしています | サポートしています | サポートしています |
| デスクトップ版Operaブラウザ | 46+ | v4.7.0+ | サポートしています | サポートしています | Opera60以降のバージョンをサポート |
| デスクトップ版WeChat Embeddedブラウザ | - | - | サポートしています | サポートしていません | サポートしていません |
| デスクトップ版WeCom Embeddedブラウザ | - | - | サポートしています | サポートしていません | サポートしていません |
Android | WeChat Embeddedブラウザ(TBSコア) | - | - | サポートしています | サポートしています | サポートしていません |
| WeChat Embeddedブラウザ(XWEBコア) | - | - | サポートしています | サポートしています | サポートしていません |
| WeCom Embeddedブラウザ | - | - | サポートしています | サポートしています | サポートしていません |
| モバイル版Chromeブラウザ | - | - | サポートしています | サポートしています | サポートしていません |
| モバイル版QQブラウザ | - | - | サポートしていません | サポートしていません | サポートしていません |
| モバイル版UCブラウザ | - | - | サポートしていません | サポートしていません | サポートしていません |
iOS 12.1.4+ | WeChat Embeddedブラウザ | - | - | サポートしています | サポートしていません | サポートしていません |
iOS 14.3+ | WeChat Embeddedブラウザ | 6.5+(WeChatバージョン) | - | サポートしています | サポートしています | サポートしていません |
iOS | WeCom Embeddedブラウザ | - | - | サポートしています | サポートしていません | サポートしていません |
iOS 11.1.2+ | モバイル版Safariブラウザ | 11+ | - | サポートしています | サポートしています | サポートしていません |
iOS 12.1.4+ | モバイル版Chromeブラウザ | - | - | サポートしています | サポートしていません | サポートしていません |
iOS 14.3+ | モバイル版Chromeブラウザ | - | - | サポートしています | サポートしています | サポートしていません |
ご注意:
H.264の著作権上の制限により、Huawei Chrome 88以前のバージョンではH264コーデックを使用できません(プッシュできません)。HuaweiデバイスのChromeブラウザでTRTC Web SDKプッシュをご利用になりたい場合は、チケットを提出し、VP8コーデックの有効化を申請してください。
Mac OSでのFirefoxの画面共有機能はあまり効果的ではなく、現時点では対処方法もありません。そのため、画面共有にはChromeまたはSafariの使用をお勧めします。
Web端末でのプッシュ時のダブルサウンドチャンネルコーデックのサポートを希望される場合は、チケットを提出し、WebRTCダブルサウンドチャンネルコーデックを申請してください。
より良い製品安定性とオンラインサポートを得るために、TRTC Web SDKは適時に最新バージョンに更新することをお勧めします。バージョンアップに関する注意事項については、アップグレードガイドラインをご参照ください。
URLドメイン名プロトコルの制限
ブラウザのセキュリティポリシー上の制限により、WebRTC機能を使用したページへのアクセスプロトコルには厳格な要件があります。 以下の表を参照し、アプリケーションの開発とデプロイを行ってください。
ユースケース | プロトコル | 受信(再生) | 送信(マイク・オン) | 画面共有 | 備考 |
本番環境 | HTTPSプロトコル | サポートあり | サポートあり | サポートあり | 推奨 |
本番環境 | HTTPプロトコル | サポートあり | サポートなし | サポートなし | |
ローカル開発環境 | サポートあり | サポートあり | サポートあり | 推奨 | |
ローカル開発環境 | サポートあり | サポートあり | サポートあり | | |
ローカル開発環境 | http://[ローカルマシンIP] | サポートあり | サポートなし | サポートなし | |
ローカル開発環境 | file:/// | サポートあり | サポートあり | サポートあり | |
API使用ガイド
初期化フローおよびAPIの使用法の詳細については、以下のガイドをご参照ください。
機能 | Sample Codeガイド |
基本的なオーディオビデオ通話 | |
インタラクティブライブストリーミングマイク接続の実装 | |
カメラおよびマイクの切り替え | |
ローカルビデオのプロパティの設定 | |
ローカルオーディオまたはビデオの動的な停止と開始 | |
画面共有 | |
音量計測 | |
ユーザー定義キャプチャとカスタマイズ再生レンダリング | |
ルーム内アップリンクユーザー数の制限 | |
バックグラウンドミュージックと効果音の実装ソリューション | |
通話前の環境およびデバイステスト | |
通話前のネットワーク品質テスト | |
デバイス挿抜動作チェック | |
CDNへのプッシュの実現 | - |
デュアルストリームの伝送を有効にする | |
美顔を有効にする | |
ウォーターマークを有効にする | |
ルーム間マイク接続の実現 | |
クラウドミクスストリーミングの実装 | |
クラウドレコーディングの実装 |
APIの説明
TRTC
ご注意:
このドキュメントは4.x.xバージョンのTRTC Web SDKに適用されます。
TRTCはTRTC Web SDKのメインエントリで、TRTCメソッドによってTRTCのクライアントオブジェクト(Client)とローカルオーディオビデオストリーミングオブジェクト(Stream)を作成することができます。また、TRTCメソッドはブラウザの互換性や、画面共有をサポートするかをチェックしたり、ログレベルやログのアップロードを設定したりすることもできます。
API | 説明 |
TRTC Web SDKバージョン番号。 | |
ブラウザがTRTC Web SDKと互換性があるかチェックします。現在のブラウザとTRTC Web SDKとの互換性がない場合は、Chromeブラウザの最新バージョンをダウンロードするようユーザーに促すことをお勧めします。 | |
ブラウザが画面共有をサポートしているかをチェックします。画面共有ストリームを作成する前に、このメソッドを呼び出して、現在のブラウザが画面共有をサポートしているか確認してください。 | |
ブラウザがデュアルストリームモードの有効化をサポートしているかをチェックします。デュアルストリームモードを有効化する前に、このメソッドを呼び出して、現在のブラウザがデュアルストリームの有効化をサポートしているか確認してください。 | |
メディアの入出力デバイスリストを返します。 | |
カメラのデバイスリストを返します。 | |
マイクのデバイスリストを返します。 | |
スピーカーのデバイスリストを返します。 | |
TRTC通話のクライアントオブジェクトを作成します。入退室、オーディオビデオストリーミングの公開、サブスクリプションなどの機能の実装に使用します。 | |
TRTC.Logger
ログ出力レベルの設定を含め、ログの設定方法を提供します。ログのアップロードを起動または停止します。
API | 説明 |
ログ出力レベルを設定します。 | |
ログのアップロードを起動します。 | |
ログのアップロードを停止します。 |
Client
API | 説明 |
プロキシサーバーを設定します。このメソッドは、nginx+coturn方式など、企業が自らプロキシサーバーをデプロイする場合に適用されます。 | |
オーディオビデオ通話ルームに参加し、入室によってオーディオビデオ通話セッションが始まります。ルームが存在しない場合、システムが自動的に新しいルームを作成します。 | |
現在のオーディオビデオ通話ルームを退出し、オーディオビデオ通話セッションを終了します。 | |
ローカルのオーディオビデオストリーミングを公開します。このメソッドはjoin()で入室後に呼び出す必要があり、1回のオーディオビデオセッションで1度だけローカルストリーミングを公開することができます。 | |
ローカルストリーミングの公開を取り消します。 | |
リモートストリーミングを閲覧します。 | |
リモートストリーミングの閲覧を取り消します。 | |
ユーザーロールを切り替えます。‘live’でインタラクティブライブストリーミングモードの時のみ有効になります。 | |
SEIメッセージを送信します。 | |
クライアントオブジェクトイベントを監視します。 | |
クライアントオブジェクトイベントの監視を取り消します。 | |
現在のルーム内にいるリモートユーザーのオーディオビデオのmute状態リストを取得します。 | |
現在のネットワーク伝送状況の統計データテーブルを取得します。 | |
現在のすべてのリモートストリーミングのオーディオ統計データを取得します。 | |
現在のすべてのリモートストリーミングのビデオ統計データを取得します。 | |
現在のクライアントのオーディオビデオストリームのCDNへの公開を開始します。 | |
現在のクライアントのオーディオビデオストリームのCDNへの公開を停止します。 | |
ミクスストリーミングトランスコードを開始します。このインターフェースは入室し、プッシュしてから呼び出してください。 | |
ミクスストリーミングトランスコードを停止します。このインターフェースはローカルストリームの公開(publish)成功後およびミクスストリーミングトランスコードの開始startMixTranscode成功後に呼び出してください。 | |
音量コールバックを有効化または無効化します。 | |
プッシュ側のデュアルストリームモードを有効化します。 | |
プッシュ側のデュアルストリームモードを無効化します。 | |
スモールストリームのパラメータを設定します。 | |
視聴側でデュアルストリームの属性を切り替えます。リモートでスモールストリームを有効化していなければ切り替えは成功しません。 |
LocalStream
API | 説明 |
ローカルのオーディオビデオストリーミングオブジェクトを初期化します。 | |
メディアの入力デバイスを切り替えます。 | |
オーディオまたはビデオのトラックを追加します。 | |
ビデオトラックを削除します。 | |
オーディオまたはビデオのトラックを変更します。 | |
このオーディオビデオストリーミングを再生します。 | |
オーディオビデオストリーミングの再生を停止します。 | |
オーディオビデオの再生を再開します。 | |
オーディオビデオストリーミングを終了します。 | |
オーディオトラックを無効にします。 | |
ビデオトラックを無効にします。 | |
オーディオトラックを有効にします。 | |
ビデオトラックを有効にします。 | |
Streamの固有識別IDを取得します。 | |
このストリームが属するユーザーIDを取得します。 | |
音声出力デバイスを設定します。 | |
現在の音量を取得します。ローカルストリーミングまたはリモートストリーミングにオーディオデータがある場合のみ有効となります。 | |
マイクキャプチャ音量を設定します。 | |
オーディオトラックが含まれているかどうか。 | |
ビデオトラックが含まれているかどうか。 | |
オーディオトラックを取得します。 | |
ビデオトラックを取得します。 | |
現在のビデオフレームを取得します。 | |
Streamイベントを監視します。 | |
Streamイベントの監視を取り消します。 |
RemoteStream
API | 説明 |
リモートストリーミングのタイプを取得します。主に1つのリモートストリーミングがメインオーディオビデオストリーミングかサブビデオストリームかを判断することに用いられます。サブビデオストリームは通常、画面共有ストリームです。 | |
このオーディオビデオストリーミングを再生します。 | |
オーディオビデオストリーミングの再生を停止します。 | |
オーディオビデオの再生を再開します。 | |
オーディオビデオストリーミングを終了します。 | |
オーディオトラックを無効にします。 | |
ビデオトラックを無効にします。 | |
オーディオトラックを有効にします。 | |
ビデオトラックを有効にします。 | |
Streamの固有識別IDを取得します。 | |
このストリームが属するユーザーIDを取得します。 | |
音声出力デバイスを設定します。 | |
再生音量を設定します。 | |
現在の音量を取得します。ローカルストリーミングまたはリモートストリーミングにオーディオデータがある場合のみ有効となります。 | |
オーディオトラックが含まれているかどうか。 | |
ビデオトラックが含まれているかどうか。 | |
オーディオトラックを取得します。 | |
ビデオトラックを取得します。 | |
現在のビデオフレームを取得します。 | |
Streamイベントを監視します。 | |
Streamイベントの監視を取り消します。 |
RtcError
RtcErrorエラーオブジェクト。
API | 説明 |
エラーコードを取得します。 |
ClientEvent
Clientがトリガーするイベントのリスト、すなわち
client.on('eventName')
イベント監視中のイベント名eventName
です。API | 説明 |
リモートストリーム追加イベントです。リモートユーザーがストリームを公開した場合にこの通知を受信します。 | |
リモートストリーム削除イベントです。リモートユーザーがストリームの公開を取り消した場合にこの通知を受信します。 | |
リモートストリーム更新イベントです。リモートユーザーがオーディオビデオトラックを追加、削除または変更した場合にこの通知を受信します。 | |
リモートストリームサブスクリプション成功イベントです。subscribe()を呼び出して成功した場合にこのイベントがトリガーされます。 | |
ローカルclientとTencent Cloudの接続ステータス変更イベントです。 | |
リモートユーザー入室イベントです。 | |
リモートユーザー退室イベントです。 | |
リモートストリームのオーディオ無効化イベントです。リモートユーザーがオーディオを無効にした場合にこのイベントがトリガーされます。 | |
リモートストリームのビデオ無効化イベントです。リモートユーザーがビデオを無効にした場合にこのイベントがトリガーされます。 | |
リモートストリームのオーディオ有効化イベントです。リモートユーザーがオーディオを有効にした場合にこのイベントがトリガーされます。 | |
リモートストリームのビデオ有効化イベントです。リモートユーザーがビデオを有効にした場合にこのイベントがトリガーされます。 | |
ユーザーの強制退室イベントです。強制退室の原因には次のものがあります。 同名のユーザーが同一のルームに入室した。注意:同名のユーザーが同時に同一のルームに入室することは、双方のオーディオビデオ通話に異常が生じることがあるため禁止されています。業務側はこのような状況を避けなければなりません。 アカウント管理者がサーバーAPIを使用して強制退室させた。 | |
ネットワーク品質統計データイベントです。入室後に統計を開始し、2秒に1回トリガーします。アップおよびダウンストリームネットワーク品質データが含まれます。 | |
音量イベントです。 | |
seiメッセージを受信します。 | |
StreamEvent
Streamによってトリガーされるイベントのリストです。
API | 説明 |
Audio/Video Playerのステータス変更イベントです。 | |
ローカル画面共有停止イベントです。ローカル画面共有ストリームに対してのみ有効です。 | |
Stream接続ステータス変更イベントです。 stream-added イベントコールバックでこのイベントを監視し、stream-removed イベントコールバックでこのイベントの監視を取り消してください。 | |
お問い合わせ
ご不明な点がございましたら、colleenyu@tencent.comにご連絡ください。