API概要

最終更新日:2021-10-13 16:26:22

    サポートするプラットフォーム

    WebRTCのテクノロジーはGoogleが初めて提唱し、現在、デスクトップ版Chromeブラウザ、デスクトップ版Edgeブラウザ、デスクトップ版Firefoxブラウザ、デスクトップ版Safariブラウザおよびモバイル版Safariブラウザでは比較的万全なサポートが提供されています。その他のプラットフォーム(Androidプラットフォームブラウザなど)のサポート状況は未だ不十分です。

    お客様のユースケースが主に教育シーンである場合、教師用端末はより安定性の高いElectronソリューションを使用することをお勧めします。このソリューションは、大小のデュアルチャネル画面、より柔軟性の高い画面共有ソリューションおよび脆弱なネットワークに対する高い回復力をサポートしています。

    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+バージョンが必要)
    デスクトップ版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ブラウザ - - サポートしています サポートしています サポートしていません
    注意:

    • ブラウザでWebRTC能力テスト画面を開けば、例えば、公式アカウントなどのブラウザ環境など、WebRTCが完全にサポートされているかどうかチェックすることができます。
    • H.264版の権限の制限によって、HuaweiシステムのChromeブラウザおよびChrome WebViewをコアとするブラウザでは、TRTCデスクトップブラウザSDKの正常動作をサポートしていません。

    API使用ガイド

    APIの使用法の詳細については、以下のガイドをご参照ください。

    機能 Sample Codeガイド
    基本的なオーディオビデオ通話 ガイドリンク
    インタラクティブライブストリーミング ガイドリンク
    カメラおよびマイクの切り替え ガイドリンク
    ローカルビデオのプロパティの設定 ガイドリンク
    ローカルオーディオまたはビデオの動的な停止| ガイドリンク
    画面共有 ガイドリンク
    音量計測 ガイドリンク
    ユーザー定義キャプチャとカスタマイズ再生レンダリング ガイドリンク
    ルーム内アップリンクユーザー数の制限 ガイドリンク
    バックグラウンドミュージックと効果音の実装ソリューション ガイドリンク

    TRTC

    注意:

    このドキュメントは4.x.xバージョンのTRTC Web SDKに適用されます。

    TRTCはTRTC Web SDKのメインエントリで、TRTCメソッドによってTRTCのクライアントオブジェクト(Client)とローカルオーディオビデオストリーミングオブジェクト(Stream)を作成することができます。また、TRTCメソッドはブラウザの互換性や、画面共有をサポートするかをチェックしたり、ログレベルやログのアップロードを設定したりすることもできます。

    API 説明
    VERSION TRTC Web SDKバージョン番号。
    checkSystemRequirements ブラウザがTRTC Web SDKと互換性があるかチェックします。現在のブラウザとTRTC Web SDKとの互換性がない場合は、Chromeブラウザの最新バージョンをダウンロードすることをお勧めします。
    isScreenShareSupported ブラウザが画面共有をサポートするかチェックします。画面共有ストリームを作成する前に、このメソッドを呼び出して、現在のブラウザが画面共有をサポートするか確認してください。
    getDevices メディアの入出力デバイスリストを返します。
    getCameras カメラのデバイスリストを返します。
    getMicrophones マイクのデバイスリストを返します。
    getSpeakers スピーカーのデバイスリストを返します。
    createClient TRTC通話のクライアントオブジェクトを作成します。セッションごとに一度だけ呼び出す必要があります。
    createStream ローカルストリームStreamオブジェクトを作成します。ローカルストリームStreamオブジェクトはpublish()メソッドによってオーディオビデオストリーミングをリリースします。

    TRTC.Logger

    ログ出力レベルの設定を含め、ログの設定方法を提供します。ログのアップロードを起動または停止します。

    API 説明
    setLogLevel ログ出力レベルを設定します。
    enableUploadLog ログのアップロードを起動します。
    disableUploadLog ログのアップロードを停止します。

    Client

    オーディオビデオ通話のクライアントオブジェクトClientはcreateClient()によって作成し、オーディオビデオセッションを代表します。

    API 説明
    setProxyServer プロキシサーバーを設定します。このメソッドは、nginx+coturn方式など、企業が自分でプロキシサーバーをデプロイする場合に適用されます。
    setTurnServer TURNサーバーを設定します。このメソッドはsetProxyServer()と合わせて使用し、企業が自分でプロキシサーバーおよびTURN中継をデプロイする場合に適用されます。
    join オーディオビデオ通話ルームに参加し、入室によってオーディオビデオ通話セッションが始まります。ルームが存在しない場合、システムが自動的に新しいルームを作成します。
    leave 現在のオーディオビデオ通話ルームを退出し、オーディオビデオ通話セッションを終了します。
    publish ローカルのオーディオビデオストリーミングを公開します。このメソッドはjoin() で入室後に呼び出す必要があり、1回のオーディオビデオセッションで1度だけローカルストリーミングを公開することができます。
    unpublish ローカルストリーミングの公開を取り消します。
    subscribe リモートストリーミングを閲覧します。
    unsubscribe リモートストリーミングの閲覧を取り消します。
    switchRole ユーザーロールを切り替えます。‘live’でインタラクティブライブストリーミングモードの時のみ有効になります。
    on クライアントオブジェクトイベントを監視します。
    getRemoteMutedState 現在のルーム内にいるリモートユーザーのオーディオビデオのmute状態リストを取得します。
    getLocalAudioStats 現在公開済みのローカルストリーミングのオーディオ統計データを取得します。このメソッドはpublish()後に呼び出す必要があります。
    getLocalVideoStats 現在公開済みのローカルストリーミングのビデオ統計データを取得します。このメソッドはpublish()後に呼び出す必要があります。
    getRemoteAudioStats 現在のすべてのリモートストリーミングのオーディオ統計データを取得します。
    getRemoteVideoStats 現在のすべてのリモートストリーミングのビデオ統計データを取得します。

    LocalStream

    LocalStreamローカルオーディオビデオストリーミングは、createStreamで作成します。Streamのサブカテゴリーになります。

    API 説明
    initialize ローカルのオーディオビデオストリーミングオブジェクトを初期化します。
    setAudioProfile オーディオProfileを設定します。このメソッドはinitialize()を呼び出す前に呼び出す必要があります。
    setVideoProfile ビデオProfileを設定します。このメソッドはinitialize()を呼び出す前に呼び出す必要があります。
    setScreenProfile 画面共有Profileを設定します。このメソッドはinitialize()を呼び出す前に呼び出す必要があります。
    setVideoContentHint ビデオコンテンツのヒントを設定します。主に、さまざまなシーンにおけるビデオコーデック品質の向上に用いられます。このメソッドはinitialize()の呼び出し完了後に呼び出す必要があります。
    switchDevice メディアの入力デバイスを切り替えます。
    addTrack オーディオまたはビデオのトラックを追加します。
    removeTrack ビデオトラックを削除します。
    replaceTrack オーディオまたはビデオのトラックを変更します。
    play このオーディオビデオストリーミングを再生します。
    stop オーディオビデオストリーミングの再生を停止します。
    resume オーディオビデオの再生を再開します。
    close オーディオビデオストリーミングを終了します。
    muteAudio オーディオトラックを無効にします。
    muteVideo ビデオトラックを無効にします。
    unmuteAudio オーディオトラックを有効にします。
    unmuteVideo ビデオトラックを有効にします。
    getId Streamの固有識別IDを取得します。
    getUserId このストリームが属するユーザーIDを取得します。
    setAudioOutput 音声出力デバイスを設定します。
    getAudioLevel 現在の音量を取得します。ローカルストリーミングまたはリモートストリーミングにオーディオデータがある場合のみ有効となります。
    hasAudio オーディオトラックが含まれているかどうか。
    hasVideo ビデオトラックが含まれているかどうか。
    getAudioTrack オーディオトラックを取得します。
    getVideoTrack ビデオトラックを取得します。
    getVideoFrame 現在のビデオフレームを取得します。
    on Streamイベントを監視します。

    RemoteStream

    リモートオーディオビデオストリーミングは、Client.on('stream-added')イベントの監視によって取得します。これはStreamのサブカテゴリーになります。

    API 説明
    getType リモートストリーミングのタイプを取得します。主に1つのリモートストリーミングがメインオーディオビデオストリーミングかサブビデオストリームかを判断することに用いられます。サブビデオストリームは通常、画面共有ストリームです。
    play このオーディオビデオストリーミングを再生します。
    stop オーディオビデオストリーミングの再生を停止します。
    resume オーディオビデオの再生を再開します。
    close オーディオビデオストリーミングを終了します。
    muteAudio オーディオトラックを無効にします。
    muteVideo ビデオトラックを無効にします。
    unmuteAudio オーディオトラックを有効にします。
    unmuteVideo ビデオトラックを有効にします。
    getId Streamの固有識別IDを取得します。
    getUserId このストリームが属するユーザーIDを取得します。
    setAudioOutput 音声出力デバイスを設定します。
    setAudioVolume 再生音量を設定します。
    getAudioLevel 現在の音量を取得します。ローカルストリーミングまたはリモートストリーミングにオーディオデータがある場合のみ有効となります。
    hasAudio オーディオトラックが含まれているかどうか。
    hasVideo ビデオトラックが含まれているかどうか。
    getAudioTrack オーディオトラックを取得します。
    getVideoTrack ビデオトラックを取得します。
    getVideoFrame 現在のビデオフレームを取得します。
    on Streamイベントを監視します。

    RtcError

    RtcErrorエラーオブジェクト。

    API 説明
    getCode エラーコードを取得します。

    お問い合わせ

    ご不明な点がございましたら、colleenyu@tencent.comにご連絡ください。