Tencent Cloudビデオ通話機能の主なインターフェース。
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);
API | 説明 |
---|---|
getTRTCShareInstance | dllを動的にロードするために使用する場合は、TRTCCloudオブジェクトシングルトンを作成します。 |
destroyTRTCShareInstance | TRTCCloudシングルトンオブジェクトをリリースし、リソースをクリーンアップします。 |
API | 説明 |
---|---|
enterRoom | ルームに入室します。ルームが存在しない場合は、システムが新しいルームを自動的に作成します。 |
exitRoom | ルームを退室します。 |
switchRoom | ルームを切り替えます。 |
switchRole | ロールを切り替えます。ライブストリーミングシナリオ(TRTCAppSceneLIVEおよびTRTCAppSceneVoiceChatRoom)のみに適しています。 |
connectOtherRoom | ルーム間のマイク接続をリクエストします(キャスタールーム間PK)。 |
disconnectOtherRoom | ルーム間のマイク接続を終了します(キャスタールーム間PK)。 |
setDefaultStreamRecvMode | オーディオビデオの受信モードを設定します(有効にするには、入室する前に設定する必要があります)。 |
API | 説明 |
---|---|
startPublishing | Tencent CloudのライブCDNへのプッシュを開始します。 |
stopPublishing | Tencent CloudのライブCDNへのプッシュを停止します。 |
startPublishCDNStream | Tencent Cloud以外のライブCDNへのリレーを開始します。 |
stopPublishCDNStream | Tencent Cloud以外のライブCDNへのプッシュを停止します。 |
setMixTranscodingConfig | クラウドのミクスストリーミングトランスコードパラメータを設定します。 |
API | 説明 |
---|---|
startLocalPreview | ローカルカメラのキャプチャとプレビューを起動します。 |
stopLocalPreview | ローカルカメラのキャプチャとプレビューを停止します。 |
muteLocalVideo | 自身のビデオ画面をブロックするかどうか。 |
startRemoteView | リモートビデオ画面の表示を開始します。 |
stopRemoteView | リモートビデオ画面の表示を停止すると同時に、このリモートユーザーのビデオデータトラフィックのプルを停止します。 |
stopAllRemoteView | すべてのリモートビデオ画面の表示を停止すると同時に、リモートユーザーのビデオデータトラフィックのプルを停止します。 |
muteRemoteVideoStream | 指定のリモートビデオストリームの受信を一時停止します。 |
muteAllRemoteVideoStreams | すべてのリモートビデオストリームの受信を停止します。 |
setVideoEncoderParam | ビデオエンコーダの関連パラメータを設定します。 |
setNetworkQosParam | ネットワークトラフィックコントロールの関連パラメータを設定します。 |
setLocalRenderParams | ローカル画像(メインストリーム)のレンダリングパラメータを設定します。 |
setLocalViewFillMode | 破棄されたインターフェース:ローカル画像のレンダリングモードを設定します。 |
setRemoteRenderParams | リモート画像のレンダリングパラメータを設定します。 |
setRemoteViewFillMode | 破棄されたインターフェース:リモート画像のレンダリングモードを設定します。 |
setLocalViewRotation | 破棄されたインターフェース:ローカル画像の時計回りの回転角度を設定します。 |
setRemoteViewRotation | 破棄されたインターフェース:リモート画像の時計回りの回転角度を設定します。 |
setVideoEncoderRotation | ビデオコーデックが出力する画面(リモートユーザーが視聴する画面およびサーバーが録画する画面)方向を設定します。 |
setLocalViewMirror | 破棄されたインターフェース:ローカルカメラプレビュー画面のイメージモードを設定します。 |
setVideoEncoderMirror | エンコーダが出力する画面のイメージモードを設定します。 |
enableSmallVideoStream | 大小画面のデュアルチャンネルコーディングモードを有効にします。 |
setRemoteVideoStreamType | 指定userIdの大画面または小画面での視聴を選択します。 |
setPriorRemoteVideoStreamType | 破棄されたインターフェース: 視聴者が優先的に選択するビデオ品質を設定します。 |
snapshotVideo | ビデオ画面のスクリーンキャプチャです。 |
API | 説明 |
---|---|
startLocalAudio | ローカルオーディオのキャプチャとアップストリームを開始します。 |
stopLocalAudio | ローカルオーディオのキャプチャとアップストリームを終了します。 |
muteLocalAudio | ローカルのオーディオをミュートにします。 |
muteRemoteAudio | 特定ユーザーの音声をミュートにすると同時に、このリモートユーザーのオーディオデータトラフィックのプルを停止します。 |
muteAllRemoteAudio | すべてのユーザーの音声をミュートにすると同時に、リモートユーザーのオーディオデータトラフィックのプルを停止します。 |
setAudioCaptureVolume | SDKキャプチャ音量を設定します 。 |
getAudioCaptureVolume | SDKキャプチャ音量を取得します。 |
setAudioPlayoutVolume | SDK再生音量を設定します。 |
getAudioPlayoutVolume | SDK再生音量を取得します。 |
enableAudioVolumeEvaluation | 音量レベルプロンプトを起動または終了します。 |
startAudioRecording | 録音を開始します。 |
stopAudioRecording | 録音を停止します。 |
setAudioQuality | 破棄されたインターフェース:オーディオ品質を設定します。 |
setRemoteAudioVolume | リモートユーザーの再生音量を設定します。 |
API | 説明 |
---|---|
getCameraDevicesList | カメラデバイスリストを取得します。 |
setCurrentCameraDevice | 使用したいカメラを設定します。 |
getCurrentCameraDevice | 現在使用するカメラ を取得します。 |
API | 説明 |
---|---|
getMicDevicesList | マイクデバイスリストを取得します。 |
getCurrentMicDevice | 現在選択しているマイクを取得します。 |
setCurrentMicDevice | 使用したいマイクを設定します。 |
getCurrentMicDeviceVolume | システムの現在のマイクデバイス音量を取得します。 |
setCurrentMicDeviceVolume | システムの現在のマイクデバイスの音量を設定します。 |
setCurrentMicDeviceMute | システムの現在のマイクデバイスのミュートステータスを設定します。 |
getCurrentMicDeviceMute | システムの現在のマイクデバイスがミュートであるかどうかを取得します。 |
getSpeakerDevicesList | スピーカーデバイスリストを取得します。 |
getCurrentSpeakerDevice | 現在のスピーカーデバイスを取得します。 |
setCurrentSpeakerDevice | 使用したいスピーカーを設定します。 |
getCurrentSpeakerVolume | システムの現在のスピーカーデバイス音量を取得します。 |
setCurrentSpeakerVolume | システムの現在のスピーカーデバイス音量を設定します。 |
setCurrentSpeakerDeviceMute | システムの現在のスピーカーデバイスのミュートステータスを設定します。 |
getCurrentSpeakerDeviceMute | システムの現在のスピーカーデバイスがミュートかどうかを取得します。 |
API | 説明 |
---|---|
setBeautyStyle | 美顔、美白および肌の色調補正エフェクトレベルを設定します。 |
setWaterMark | ウォーターマークを設定します。 |
API | 説明 |
---|---|
startRemoteSubStreamView | 破棄されたインターフェース:リモートユーザーのサブストリーム(画面共有)画面のレンダリングを開始します。 |
stopRemoteSubStreamView | 破棄されたインターフェース:リモートユーザーのサブストリーム(画面共有)画面のレンダリングを停止します。 |
setRemoteSubStreamViewFillMode | 破棄されたインターフェース:サブストリーム(画面共有)画面のレンダリングモードを設定します。 |
setRemoteSubStreamViewRotation | 破棄されたインターフェース:サブストリーム(画面共有)画面の時計回りの回転角度を設定します。 |
getScreenCaptureSources | 共有可能なウィンドウリストを列挙します。 |
selectScreenCaptureTarget | 画面共有パラメータを設定します。画面共有中にもこのメソッドを呼び出すことができます。 |
startScreenCapture | 画面共有を起動します。 |
pauseScreenCapture | 画面共有を一時停止します。 |
resumeScreenCapture | 画面共有を再開します。 |
stopScreenCapture | 画面共有を停止します。 |
setSubStreamEncoderParam | サブストリーム(画面共有)のエンコーダパラメータを設定します。 |
setSubStreamMixVolume | サブストリーム(画面共有)の音声ミキシングの音量レベルを設定します。 |
addExcludedShareWindow | 指定ウィンドウを画面共有のexcludeリストに追加します。excludeリストに追加したウィンドウは共有できなくなります。 |
removeExcludedShareWindow | 指定ウィンドウを画面共有のexcludeリストから削除します。 |
removeAllExcludedShareWindow | すべてのウィンドウを画面共有のexcludeリストから削除します。 |
API | 説明 |
---|---|
sendCustomCmdMsg | カスタムメッセージをルーム内のすべてのユーザーに送信します。 |
sendSEIMsg | データ量の小さなカスタムデータをビデオフレームに埋め込みます。 |
API | 説明 |
---|---|
playBGM | 破棄されたインターフェース:BGMの再生を起動します。 |
stopBGM | 破棄されたインターフェース:BGMの再生を停止します。 |
pauseBGM | 破棄されたインターフェース:BGMの再生を一時停止します。 |
resumeBGM | 破棄されたインターフェース:BGMの再生を継続します。 |
getBGMDuration | 破棄されたインターフェース:BGMファイルの総時間を取得します。単位はミリ秒です。 |
setBGMPosition | 破棄されたインターフェース:BGM再生の進捗を設定します。 |
setBGMVolume | 破棄されたインターフェース:BGM再生音量レベルを設定します。 |
setBGMPlayoutVolume | 破棄されたインターフェース:BGMローカル再生音量レベルを設定します。 |
setBGMPublishVolume | 破棄されたインターフェース:BGMリモート再生音量レベルを設定します。 |
startSystemAudioLoopback | システム音声キャプチャを起動します。 |
stopSystemAudioLoopback | システム音声キャプチャを終了します。 |
setSystemAudioLoopbackVolume | システム音声キャプチャの音量を設定します。 |
startPlayMusic | BGMの再生を起動します。 |
stopPlayMusic | BGMの再生を停止します。 |
pausePlayMusic | BGMの再生を一時停止します。 |
resumePlayMusic | BGMの再生を再開します。 |
getMusicDurationInMS | BGMファイルの総時間を取得します。単位はミリ秒です。 |
seekMusicToPosInTime | BGM再生の進捗を設定します。 |
setAllMusicVolume | BGMの音量レベルを設定します。BGMの音量レベルを制御するために、BGMの再生や音声ミキシング時に使用します。 |
setMusicPlayoutVolume | BGMのローカル再生音量レベルを設定します。 |
setMusicPublishVolume | BGMのリモート再生音量レベルを設定します。 |
API | 説明 |
---|---|
playAudioEffect | 破棄されたインターフェース:オーディオエフェクトを再生します。 |
setAudioEffectVolume | 破棄されたインターフェース:オーディオエフェクト音量を設定します。 |
stopAudioEffect | 破棄されたインターフェース:オーディオエフェクトを停止します。 |
stopAllAudioEffects | 破棄されたインターフェース:すべてのオーディオエフェクトを停止します。 |
setAllAudioEffectsVolume | 破棄されたインターフェース:すべてのオーディオエフェクトの音量を設定します。 |
pauseAudioEffect | 破棄されたインターフェース:オーディオエフェクトを一時停止します。 |
resumeAudioEffect | 破棄されたインターフェース:オーディオエフェクトを再開します。 |
API | 説明 |
---|---|
startSpeedTest | ネットワークスピードテストを開始します(通話品質への影響を避けるため、ビデオ通話中はテストしないでください)。 |
stopSpeedTest | ネットワークスピードテストを停止します。 |
startCameraDeviceTest | カメラテストを開始します。 |
stopCameraDeviceTest | カメラテストを停止します。 |
startMicDeviceTest | マイクテストを開始します。 |
stopMicDeviceTest | マイクテストを停止します。 |
startSpeakerDeviceTest | スピーカーテストを開始します。 |
stopSpeakerDeviceTest | スピーカーテストを停止します。 |
API | 説明 |
---|---|
getSDKVersion | SDKバージョン情報を取得します。 |
setLogLevel | Log出力レベルを設定します。 |
setConsoleEnabled | コンソールのログプリントを有効または無効にします。 |
setLogCompressEnabled | Logのローカル圧縮を有効または無効にします。 |
setLogDirPath | ログ保存パスを設定します。 |
setLogCallback | ログコールバックを設定します。 |
callExperimentalAPI | 試験的APIインターフェースを呼び出します。 |
API | 説明 |
---|---|
setMicVolumeOnMixing | v6.9バージョンから破棄します。 |
Tencent Cloudビデオ通話機能のコールバックインターフェース。
API | 説明 |
---|---|
onError | エラーコールバック:SDKがリカバリー不能なエラーは、監視する必要があり、状況に応じてユーザーに適切なインターフェースプロンプトを表示します。 |
onWarning | アラートコールバック:ラグやリカバリー不能なデコードの失敗など、非常に重大な問題を通知するために使用されます。 |
API | 説明 |
---|---|
onEnterRoom | 入室済みのコールバックです。 |
onExitRoom | 退室のイベントコールバックです。 |
onSwitchRole | ロール切り替えのイベントコールバックです。 |
onConnectOtherRoom | ルーム間マイク接続(キャスタールーム間PK)リクエスト結果のコールバックです。 |
onDisconnectOtherRoom | ルーム間マイク接続(キャスタールーム間PK)終了結果のコールバックです。 |
onSwitchRoom | ルームを切り替えます。 |
API | 説明 |
---|---|
onRemoteUserEnterRoom | ユーザーが現在のルームに入室します。 |
onRemoteUserLeaveRoom | ユーザーが現在のルームを退室します。 |
onUserVideoAvailable | ユーザーがカメラからのビデオを有効にしているかどうか。 |
onUserSubStreamAvailable | ユーザーが画面共有を有効にしているかどうか。 |
onUserAudioAvailable | ユーザーがオーディオのアップストリームを有効にしているかどうか。 |
onFirstVideoFrame | ローカルまたはリモートユーザーの最初のフレーム画面のレンダリングを開始します。 |
onFirstAudioFrame | リモートユーザーの最初のフレームのオーディオ再生を開始します(現在、ローカル音声は通知しません)。 |
onSendFirstLocalVideoFrame | 最初のフレームのローカルビデオデータが送信されました。 |
onSendFirstLocalAudioFrame | 最初のフレームのローカルオーディオデータが送信されました。 |
onUserEnter | 破棄されたインターフェース:キャスターが現在のルームに入室します。 |
onUserExit | 破棄されたインターフェース: キャスターが現在のルームを退室します。 |
API | 説明 |
---|---|
onNetworkQuality | ネットワーク品質:このコールバックは2秒ごとに1度トリガーされ、現在のネットワークのアップストリームとダウンストリーム品質を統計します。 |
onStatistics | 技術指標統計のコールバックです。 |
API | 説明 |
---|---|
onConnectionLost | SDKがサーバーとの接続を切断します。 |
onTryToReconnect | SDKがサーバーとの再接続を試行中です。 |
onConnectionRecovery | SDKがサーバーとの接続を再開します。 |
onSpeedTest | 破棄されたインターフェース:サーバースピードテストのコールバックです。SDKは複数のサーバーIPに対するスピードテストを実行し、IPごとのスピードテスト結果をこのコールバックを介して通知します。 |
onSpeedTestResult | ネットワークスピードテストの結果のコールバックです。 |
API | 説明 |
---|---|
onCameraDidReady | カメラの準備が完了しました。 |
onMicDidReady | マイクの準備が完了しました。 |
onUserVoiceVolume | 音量レベルをリマインドするためのコールバックです。userIdごとの音量とリモートの総音量が含まれます。ローカルユーザーのuseridは''です。 |
onDeviceChange | ローカルデバイスオン/オフのコールバックです。 |
onTestMicVolume | マイクテスト音量のコールバックです。 |
onTestSpeakerVolume | スピーカーテスト音量のコールバックです。 |
onAudioDeviceCaptureVolumeChanged | 現在のオーディオキャプチャデバイス音量変更のコールバックです。 |
onAudioDevicePlayoutVolumeChanged | 現在のオーディオ再生デバイス音量変更のコールバックです。 |
API | 説明 |
---|---|
onRecvCustomCmdMsg | カスタムメッセージ受信のコールバックです。 |
onMissCustomCmdMsg | カスタムメッセージ消失のコールバックです。 |
onRecvSEIMsg | SEIメッセージ受信のコールバックです。 |
API | 説明 |
---|---|
onStartPublishing | Tencent CloudのライブCDNへのプッシュ開始のコールバックです。TRTCCloudのstartPublishing()インターフェースに対応します。 |
onStopPublishing | Tencent CloudのライブCDNへのプッシュ停止のコールバックです。TRTCCloudのstopPublishing()インターフェースに対応します。 |
onStartPublishCDNStream | CDNへのRelayed Push起動完了のコールバックです。 |
onStopPublishCDNStream | CDNへのRelayed Push停止完了のコールバックです。 |
onSetMixTranscodingConfig | クラウドのミクスストリーミングトランスコードパラメータ設定のコールバックです。TRTCCloudのsetMixTranscodingConfig()インターフェースに対応します。 |
API | 説明 |
---|---|
onSystemAudioLoopbackError | システム音量キャプチャステータスのコールバックです(Macのみで有効)。 |
API | 説明 |
---|---|
onAudioEffectFinished | 破棄されたインターフェース:オーディオエフェクト再生終了のコールバックです。 |
API | 説明 |
---|---|
onScreenCaptureCovered | SDKは画面共有ウィンドウがブロックされ、正常にキャプチャできないことをこのコールバックを介して通知します。このコールバックでユーザーにウィンドウのブロックを解除するよう通知できます。 |
onScreenCaptureStarted | SDKは画面共有の開始をこのコールバックを介して通知します。 |
onScreenCapturePaused | SDKは画面共有の一時停止をこのコールバックを介して通知します。 |
onScreenCaptureResumed | SDKは画面共有の再開をこのコールバックを介して通知します。 |
onScreenCaptureStopped | SDKは画面共有の停止をこのコールバックを介して通知します。 |
API | 説明 |
---|---|
onSnapshotComplete | SDKはスクリーンキャプチャの完了をこのコールバックを介して通知します。 |
API | 説明 |
---|---|
onPlayBGMBegin | 破棄されたインターフェース:BGMの再生を開始します。 |
onPlayBGMProgress | 破棄されたインターフェース:BGM再生の進捗です。 |
onPlayBGMComplete | 破棄されたインターフェース:BGMの再生を終了します。 |
タイプ名 | 説明 |
---|---|
TRTCParams | 入室関連パラメータです。 |
TRTCVideoEncParam | ビデオコーデックパラメータです。 |
TRTCNetworkQosParam | ネットワークトラフィックコントロール関連パラメータです。 |
TRTCQualityInfo | ビデオ品質です。 |
TRTCVolumeInfo | 音量レベルです。 |
TRTCSpeedTestResult | ネットワークスピードテスト結果です。 |
TRTCMixUser | クラウドミクスストリーミングにおける各サブ画面の位置情報です。 |
TRTCTranscodingConfig | クラウドミクスストリーミング(トランスコード)の設定です。 |
TRTCPublishCDNParam | CDN Relayed Pushパラメータです。 |
TRTCAudioRecordingParams | 録音パラメータです。 |
TRTCLocalStatistics | 自身のローカルオーディオビデオ統計情報です。 |
TRTCRemoteStatistics | リモートメンバーのオーディオビデオ統計情報です。 |
TRTCStatistics | 統計データです。 |
列挙 | 説明 |
---|---|
TRTCVideoResolution | ビデオ解像度です。 |
TRTCVideoResolutionMode | ビデオ解像度モードです。 |
TRTCVideoStreamType | ビデオストリームタイプです。 |
TRTCQuality | 画質レベルです。 |
TRTCVideoFillMode | ビデオ画面塗りつぶしモードです。 |
TRTCBeautyStyle | 美顔(美肌)アルゴリズムです。 |
TRTCAppScene | ユースケースです。 |
TRTCRoleType | ロールです。ライブストリーミングシナリオ(TRTCAppSceneLIVE)のみに適しています。 |
TRTCQosControlMode | トラフィックコントロールモードです。 |
TRTCVideoQosPreference | 画質の好みです。 |
TRTCDeviceState | デバイスの操作です。 |
TRTCDeviceType | デバイスのタイプです。 |
TRTCWaterMarkSrcType | ウォーターマーク画像のオリジナルタイプです。 |
TRTCTranscodingConfigMode | ミクスストリーミングパラメータ設定モードです。 |
この記事はお役に立ちましたか?