APIの概要

TRTCCloud @ TXLiteAVSDK

Tencent Cloudビデオ通話機能の主なインターフェース。
主なドキュメントアドレスTRTC Electron SDK
サンプルコードアドレスTRTC Electron Demo

TRTCオブジェクトの作成

const TRTCCloud = require('trtc-electron-sdk').default;
// import TRTCCloud from 'trtc-electron-sdk';
this.rtcCloud = new TRTCCloud();
v7.9.348から、TRTC Electron SDKはtrtc.d.tsファイルを追加しており、 typescriptを使用する開発者の操作性が向上しました。
import TRTCCloud from 'trtc-electron-sdk';

const rtcCloud: TRTCCloud = new TRTCCloud();
// SDKバージョン番号の取得
rtcCloud.getSDKVersion();
// コールバックの設定
subscribeEvents = (rtcCloud) => {
rtcCloud.on('onError', (errcode, errmsg) => {
console.info('trtc_demo: onError :' + errcode + " msg" + errmsg);
});
rtcCloud.on('onEnterRoom', (elapsed) => {
console.info('trtc_demo: onEnterRoom elapsed:' + elapsed);
});
rtcCloud.on('onExitRoom', (reason) => {
console.info('onExitRoom: userenter reason:' + reason);
});
};


subscribeEvents(this.rtcCloud);

TRTCCloudシングルトンの作成と破棄

API
説明
dllを動的にロードするために使用する場合は、TRTCCloudオブジェクトシングルトンを作成します。
TRTCCloudシングルトンオブジェクトをリリースし、リソースをクリーンアップします。

ルーム関連インターフェース関数

API
説明
ルームに入室します。ルームが存在しない場合は、システムが新しいルームを自動的に作成します。
ルームを退室します。
ルームを切り替えます。
ロールを切り替えます。ライブストリーミングシナリオ(TRTCAppSceneLIVEおよびTRTCAppSceneVoiceChatRoom)のみに適しています。
ルーム間のマイク接続をリクエストします(キャスタールーム間PK)。
ルーム間のマイク接続を終了します(キャスタールーム間PK)。
オーディオビデオの受信モードを設定します(有効にするには、入室する前に設定する必要があります)。

CDN関連インターフェース関数

API
説明
Tencent CloudのライブCDNへのプッシュを開始します。
Tencent CloudのライブCDNへのプッシュを停止します。
Tencent Cloud以外のライブCDNへのリレーを開始します。
Tencent Cloud以外のライブCDNへのプッシュを停止します。
クラウドのミクスストリーミングトランスコードパラメータを設定します。

ビデオ関連インターフェース関数

API
説明
ローカルカメラのキャプチャとプレビューを起動します。
ローカルカメラのキャプチャとプレビューを停止します。
自身のビデオ画面をブロックするかどうか。
リモートビデオ画面の表示を開始します。
リモートビデオ画面の表示を停止すると同時に、このリモートユーザーのビデオデータトラフィックのプルを停止します。
すべてのリモートビデオ画面の表示を停止すると同時に、リモートユーザーのビデオデータトラフィックのプルを停止します。
指定のリモートビデオストリームの受信を一時停止します。
すべてのリモートビデオストリームの受信を停止します。
ビデオエンコーダの関連パラメータを設定します。
ネットワークトラフィックコントロールの関連パラメータを設定します。
ローカル画像(メインストリーム)のレンダリングパラメータを設定します。
破棄されたインターフェース:ローカル画像のレンダリングモードを設定します。
リモート画像のレンダリングパラメータを設定します。
破棄されたインターフェース:リモート画像のレンダリングモードを設定します。
破棄されたインターフェース:ローカル画像の時計回りの回転角度を設定します。
破棄されたインターフェース:リモート画像の時計回りの回転角度を設定します。
ビデオコーデックが出力する画面(リモートユーザーが視聴する画面およびサーバーが録画する画面)方向を設定します。
破棄されたインターフェース:ローカルカメラプレビュー画面のイメージモードを設定します。
エンコーダが出力する画面のイメージモードを設定します。
大小画面のデュアルチャンネルコーディングモードを有効にします。
指定userIdの大画面または小画面での視聴を選択します。
破棄されたインターフェース: 視聴者が優先的に選択するビデオ品質を設定します。
ビデオ画面のスクリーンキャプチャです。

オーディオ関連インターフェース関数

API
説明
ローカルオーディオのキャプチャとアップストリームを開始します。
ローカルオーディオのキャプチャとアップストリームを終了します。
ローカルのオーディオをミュートにします。
特定ユーザーの音声をミュートにすると同時に、このリモートユーザーのオーディオデータトラフィックのプルを停止します。
すべてのユーザーの音声をミュートにすると同時に、リモートユーザーのオーディオデータトラフィックのプルを停止します。
SDKキャプチャ音量を設定します 。
SDKキャプチャ音量を取得します。
SDK再生音量を設定します。
SDK再生音量を取得します。
音量レベルプロンプトを起動または終了します。
録音を開始します。
録音を停止します。
破棄されたインターフェース:オーディオ品質を設定します。
リモートユーザーの再生音量を設定します。

カメラ関連インターフェース関数

API
説明
カメラデバイスリストを取得します。
使用したいカメラを設定します。
現在使用するカメラ を取得します。

オーディオデバイス関連インターフェース関数

API
説明
マイクデバイスリストを取得します。
現在選択しているマイクを取得します。
使用したいマイクを設定します。
システムの現在のマイクデバイス音量を取得します。
システムの現在のマイクデバイスの音量を設定します。
システムの現在のマイクデバイスのミュートステータスを設定します。
システムの現在のマイクデバイスがミュートであるかどうかを取得します。
スピーカーデバイスリストを取得します。
現在のスピーカーデバイスを取得します。
使用したいスピーカーを設定します。
システムの現在のスピーカーデバイス音量を取得します。
システムの現在のスピーカーデバイス音量を設定します。
システムの現在のスピーカーデバイスのミュートステータスを設定します。
システムの現在のスピーカーデバイスがミュートかどうかを取得します。

美顔関連インターフェース関数

API
説明
美顔、美白および肌の色調補正エフェクトレベルを設定します。
ウォーターマークを設定します。

サブストリーム関連インターフェース関数

API
説明
破棄されたインターフェース:リモートユーザーのサブストリーム(画面共有)画面のレンダリングを開始します。
破棄されたインターフェース:リモートユーザーのサブストリーム(画面共有)画面のレンダリングを停止します。
破棄されたインターフェース:サブストリーム(画面共有)画面のレンダリングモードを設定します。
破棄されたインターフェース:サブストリーム(画面共有)画面の時計回りの回転角度を設定します。
共有可能なウィンドウリストを列挙します。
画面共有パラメータを設定します。画面共有中にもこのメソッドを呼び出すことができます。
画面共有を起動します。
画面共有を一時停止します。
画面共有を再開します。
画面共有を停止します。
サブストリーム(画面共有)のエンコーダパラメータを設定します。
サブストリーム(画面共有)の音声ミキシングの音量レベルを設定します。
指定ウィンドウを画面共有のexcludeリストに追加します。excludeリストに追加したウィンドウは共有できなくなります。
指定ウィンドウを画面共有のexcludeリストから削除します。
すべてのウィンドウを画面共有のexcludeリストから削除します。

カスタムメッセージの送信

API
説明
カスタムメッセージをルーム内のすべてのユーザーに送信します。
データ量の小さなカスタムデータをビデオフレームに埋め込みます。

BGMミキシング関連インターフェース関数

API
説明
破棄されたインターフェース:BGMの再生を起動します。
破棄されたインターフェース:BGMの再生を停止します。
破棄されたインターフェース:BGMの再生を一時停止します。
破棄されたインターフェース:BGMの再生を継続します。
破棄されたインターフェース:BGMファイルの総時間を取得します。単位はミリ秒です。
破棄されたインターフェース:BGM再生の進捗を設定します。
破棄されたインターフェース:BGM再生音量レベルを設定します。
破棄されたインターフェース:BGMローカル再生音量レベルを設定します。
破棄されたインターフェース:BGMリモート再生音量レベルを設定します。
システム音声キャプチャを起動します。
システム音声キャプチャを終了します。
システム音声キャプチャの音量を設定します。
BGMの再生を起動します。
BGMの再生を停止します。
BGMの再生を一時停止します。
BGMの再生を再開します。
BGMファイルの総時間を取得します。単位はミリ秒です。
BGM再生の進捗を設定します。
BGMの音量レベルを設定します。BGMの音量レベルを制御するために、BGMの再生や音声ミキシング時に使用します。
BGMのローカル再生音量レベルを設定します。
BGMのリモート再生音量レベルを設定します。

オーディオエフェクト関連インターフェース関数

API
説明
破棄されたインターフェース:オーディオエフェクトを再生します。
破棄されたインターフェース:オーディオエフェクト音量を設定します。
破棄されたインターフェース:オーディオエフェクトを停止します。
破棄されたインターフェース:すべてのオーディオエフェクトを停止します。
破棄されたインターフェース:すべてのオーディオエフェクトの音量を設定します。
破棄されたインターフェース:オーディオエフェクトを一時停止します。
破棄されたインターフェース:オーディオエフェクトを再開します。

デバイスおよびネットワークテスト

API
説明
ネットワークスピードテストを開始します(通話品質への影響を避けるため、ビデオ通話中はテストしないでください)。
ネットワークスピードテストを停止します。
カメラテストを開始します。
カメラテストを停止します。
マイクテストを開始します。
マイクテストを停止します。
スピーカーテストを開始します。
スピーカーテストを停止します。

LOG関連インターフェース関数

API
説明
SDKバージョン情報を取得します。
Log出力レベルを設定します。
コンソールのログプリントを有効または無効にします。
Logのローカル圧縮を有効または無効にします。
ログ保存パスを設定します。
ログコールバックを設定します。
試験的APIインターフェースを呼び出します。

使用停止インターフェース関数

API
説明
v6.9バージョンから破棄します。

TRTCCallback @ TXLiteAVSDK

Tencent Cloudビデオ通話機能のコールバックインターフェース。

エラーイベントおよび警告イベント

API
説明
エラーコールバック:SDKがリカバリー不能なエラーは、監視する必要があり、状況に応じてユーザーに適切なインターフェースプロンプトを表示します。
アラートコールバック:ラグやリカバリー不能なデコードの失敗など、非常に重大な問題を通知するために使用されます。

ルームイベントコールバック

API
説明
入室済みのコールバックです。
退室のイベントコールバックです。
ロール切り替えのイベントコールバックです。
ルーム間マイク接続(キャスタールーム間PK)リクエスト結果のコールバックです。
ルーム間マイク接続(キャスタールーム間PK)終了結果のコールバックです。
ルームを切り替えます。

メンバーイベントコールバック

API
説明
ユーザーが現在のルームに入室します。
ユーザーが現在のルームを退室します。
ユーザーがカメラからのビデオを有効にしているかどうか。
ユーザーが画面共有を有効にしているかどうか。
ユーザーがオーディオのアップストリームを有効にしているかどうか。
ローカルまたはリモートユーザーの最初のフレーム画面のレンダリングを開始します。
リモートユーザーの最初のフレームのオーディオ再生を開始します(現在、ローカル音声は通知しません)。
最初のフレームのローカルビデオデータが送信されました。
最初のフレームのローカルオーディオデータが送信されました。
破棄されたインターフェース:キャスターが現在のルームに入室します。
破棄されたインターフェース: キャスターが現在のルームを退室します。

統計および品質コールバック

API
説明
ネットワーク品質:このコールバックは2秒ごとに1度トリガーされ、現在のネットワークのアップストリームとダウンストリーム品質を統計します。
技術指標統計のコールバックです。

サーバーイベントコールバック

API
説明
SDKがサーバーとの接続を切断します。
SDKがサーバーとの再接続を試行中です。
SDKがサーバーとの接続を再開します。
破棄されたインターフェース:サーバースピードテストのコールバックです。SDKは複数のサーバーIPに対するスピードテストを実行し、IPごとのスピードテスト結果をこのコールバックを介して通知します。
ネットワークスピードテストの結果のコールバックです。

ハードウェアデバイスイベントコールバック

API
説明
カメラの準備が完了しました。
マイクの準備が完了しました。
音量レベルをリマインドするためのコールバックです。userIdごとの音量とリモートの総音量が含まれます。ローカルユーザーのuseridは''です。
ローカルデバイスオン/オフのコールバックです。
マイクテスト音量のコールバックです。
スピーカーテスト音量のコールバックです。
現在のオーディオキャプチャデバイス音量変更のコールバックです。
現在のオーディオ再生デバイス音量変更のコールバックです。

カスタムメッセージ受信のコールバック

API
説明
カスタムメッセージ受信のコールバックです。
カスタムメッセージ消失のコールバックです。
SEIメッセージ受信のコールバックです。

CDNバイパスリレーコールバック

API
説明
Tencent CloudのライブCDNへのプッシュ開始のコールバックです。TRTCCloudのstartPublishing()インターフェースに対応します。
Tencent CloudのライブCDNへのプッシュ停止のコールバックです。TRTCCloudのstopPublishing()インターフェースに対応します。
CDNへのRelayed Push起動完了のコールバックです。
CDNへのRelayed Push停止完了のコールバックです。
クラウドのミクスストリーミングトランスコードパラメータ設定のコールバックです。TRTCCloudのsetMixTranscodingConfig()インターフェースに対応します。

システム音量キャプチャコールバック

API
説明
システム音量キャプチャステータスのコールバックです(Macのみで有効)。

オーディオエフェクトコールバック

API
説明
破棄されたインターフェース:オーディオエフェクト再生終了のコールバックです。

画面共有コールバック

API
説明
SDKは画面共有ウィンドウがブロックされ、正常にキャプチャできないことをこのコールバックを介して通知します。このコールバックでユーザーにウィンドウのブロックを解除するよう通知できます。
SDKは画面共有の開始をこのコールバックを介して通知します。
SDKは画面共有の一時停止をこのコールバックを介して通知します。
SDKは画面共有の再開をこのコールバックを介して通知します。
SDKは画面共有の停止をこのコールバックを介して通知します。

スクリーンキャプチャコールバック

API
説明
SDKはスクリーンキャプチャの完了をこのコールバックを介して通知します。

BGMミキシングイベントコールバック

API
説明
破棄されたインターフェース:BGMの再生を開始します。
破棄されたインターフェース:BGM再生の進捗です。
破棄されたインターフェース:BGMの再生を終了します。

主要なタイプの定義

主要なタイプ

タイプ名
説明
入室関連パラメータです。
ビデオコーデックパラメータです。
ネットワークトラフィックコントロール関連パラメータです。
ビデオ品質です。
音量レベルです。
ネットワークスピードテスト結果です。
クラウドミクスストリーミングにおける各サブ画面の位置情報です。
クラウドミクスストリーミング(トランスコード)の設定です。
CDN Relayed Pushパラメータです。
録音パラメータです。
自身のローカルオーディオビデオ統計情報です。
リモートメンバーのオーディオビデオ統計情報です。
統計データです。

列挙値

列挙
説明
ビデオ解像度です。
ビデオ解像度モードです。
ビデオストリームタイプです。
画質レベルです。
ビデオ画面塗りつぶしモードです。
美顔(美肌)アルゴリズムです。
ユースケースです。
ロールです。ライブストリーミングシナリオ(TRTCAppSceneLIVE)のみに適しています。
トラフィックコントロールモードです。
画質の好みです。
デバイスの操作です。
デバイスのタイプです。
ウォーターマーク画像のオリジナルタイプです。
ミクスストリーミングパラメータ設定モードです。