含 UI 集成方案

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

TRTCCloud @ TXLiteAVSDK

腾讯云视频通话功能的主要接口类。
主要文档地址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
描述
enterRoom
进入房间,若房间不存在,系统将自动创建一个新房间。
exitRoom
退出房间。
切换房间。
切换角色,仅适用于直播场景(TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom)。
请求跨房连麦(主播跨房 PK)。
关闭跨房连麦(主播跨房 PK)。
设置音视频数据接收模式(需要在进房前设置才能生效)。

CDN 相关接口函数

API
描述
开始向腾讯云的直播 CDN 推流。
停止向腾讯云的直播 CDN 推流。
开始向非腾讯云的直播 CDN 转推。
停止向非腾讯云的直播 CDN 推流。
设置云端的混流转码参数。

视频相关接口函数

API
描述
启动本地摄像头采集和预览。
停止本地摄像头采集和预览。
是否屏蔽自己的视频画面。
开始显示远端视频画面。
停止显示远端视频画面,同时不再拉取该远端用户的视频数据流。
停止显示所有远端视频画面,同时不再拉取远端用户的视频数据流。
暂停接收指定的远端视频流。
停止接收所有远端视频流。
设置视频编码器相关参数。
设置网络流控相关参数。
设置本地图像(主流)的渲染参数。
废弃接口:设置本地图像的渲染模式。
设置远端图像的渲染参数。
废弃接口:设置远端图像的渲染模式。
废弃接口:设置本地图像的顺时针旋转角度。
废弃接口:设置远端图像的顺时针旋转角度。
设置视频编码输出的(即远端用户观看到的以及服务器录制下来的)画面方向。
废弃接口:设置本地摄像头预览画面的镜像模式。
设置编码器输出的画面镜像模式。
开启大小画面双路编码模式。
选定观看指定 userId 的大画面或小画面。
废弃接口:设定观看方优先选择的视频质量。
视频画面截图。

音频相关接口函数

API
描述
开启本地音频的采集和上行。
关闭本地音频的采集和上行。
静音本地的音频。
静音某一个用户的声音,同时不再拉取该远端用户的音频数据流。
静音所有用户的声音,同时不再拉取远端用户的音频数据流。
设置 SDK 采集音量。
获取 SDK 采集音量。
设置 SDK 播放音量。
获取 SDK 播放音量。
启用或关闭音量大小提示。
开始录音。
停止录音。
废弃接口:设置音频质量。
设置远程用户播放音量。

摄像头相关接口函数

API
描述
获取摄像头设备列表。
设置要使用的摄像头。
获取当前使用的摄像头。

音频设备相关接口函数

API
描述
获取麦克风设备列表。
获取当前选择的麦克风。
设置要使用的麦克风。
获取系统当前麦克风设备音量。
设置系统当前麦克风设备的音量。
设置系统当前麦克风设备的静音状态。
获取系统当前麦克风设备是否静音。
获取扬声器设备列表。
获取当前的扬声器设备。
设置要使用的扬声器。
获取系统当前扬声器设备音量。
设置系统当前扬声器设备音量。
设置系统当前扬声器设备的静音状态。
获取系统当前扬声器设备是否静音。

美颜相关接口函数

API
描述
设置美颜、美白以红润效果级别。
设置水印。

辅流相关接口函数

API
描述
废弃接口:开始渲染远端用户的辅流(屏幕分享)画面。
废弃接口:停止渲染远端用户的辅流(屏幕分享)画面。
废弃接口:设置辅流(屏幕分享)画面的渲染模式。
废弃接口:设置辅流(屏幕分享)画面的顺时针旋转角度。
枚举可共享的窗口列表。
设置屏幕共享参数,该方法在屏幕共享过程中也可以调用。
启动屏幕分享。
暂停屏幕分享。
恢复屏幕分享。
停止屏幕分享。
设置辅流(屏幕分享)的编码器参数。
设置辅流(屏幕分享)的混音音量大小。
将指定窗口加入屏幕分享的排除列表中,加入排除列表中的窗口不会被分享出去。
将指定窗口从屏幕分享的排除列表中移除。
将所有窗口从屏幕分享的排除列表中移除。

自定义消息发送

API
描述
发送自定义消息给房间内所有用户。
将小数据量的自定义数据嵌入视频帧中。

背景混音相关接口函数

API
描述
playBGM
废弃接口:启动播放背景音乐。
stopBGM
废弃接口:停止播放背景音乐。
pauseBGM
废弃接口:暂停播放背景音乐。
resumeBGM
废弃接口:继续播放背景音乐。
废弃接口:获取背景音乐文件总时长,单位毫秒。
废弃接口:设置背景音乐播放进度。
废弃接口:设置背景音乐播放音量的大小。
废弃接口:设置背景音乐本地播放音量的大小。
废弃接口:设置背景音乐远端播放音量的大小。
打开系统声音采集。
关闭系统声音采集。
设置系统声音采集的音量。
启动播放背景音乐。
停止播放背景音乐。
暂停播放背景音乐。
恢复播放背景音乐。
获取背景音乐文件总时长,单位毫秒。
设置背景音乐播放进度。
设置背景音乐的音量大小,播放背景音乐混音时使用,用来控制背景音音量大小。
设置背景音乐本地播放音量的大小。
设置背景音乐远端播放音量的大小。

音效相关接口函数

API
描述
废弃接口:播放音效。
废弃接口:设置音效音量。
废弃接口:停止音效。
废弃接口:停止所有音效。
废弃接口:设置所有音效的音量。
废弃接口:暂停音效。
废弃接口:恢复音效。

设备和网络测试

API
描述
开始进行网络测速(视频通话期间请勿测试,以免影响通话质量)。
停止网络测速。
开始进行摄像头测试。
停止摄像头测试。
开始进行麦克风测试。
停止麦克风测试。
开始进行扬声器测试。
停止扬声器测试。

LOG 相关接口函数

API
描述
获取 SDK 版本信息。
设置 Log 输出级别。
启用或禁用控制台日志打印。
启用或禁用 Log 的本地压缩。
设置日志保存路径。
设置日志回调。
调用实验性 API 接口。

弃用接口函数

API
描述
从 v6.9 版本开始废弃。

TRTCCallback @ TXLiteAVSDK

腾讯云视频通话功能的回调接口类。

错误事件和警告事件

API
描述
onError
错误回调:SDK 不可恢复的错误,必须监听,并分情况给用户适当的界面提示。
onWarning
警告回调:用于告知您一些非严重性问题,例如出现了卡顿或可恢复的解码失败。

房间事件回调

API
描述
已加入房间的回调。
退出房间的事件回调。
切换角色的事件回调。
请求跨房连麦(主播跨房 PK)的结果回调。
关闭跨房连麦(主播跨房 PK)的结果回调。
切换房间。

成员事件回调

API
描述
有用户加入当前房间。
有用户离开当前房间。
用户是否开启摄像头视频。
用户是否开启屏幕分享。
用户是否开启音频上行。
开始渲染本地或远程用户的首帧画面。
开始播放远程用户的首帧音频(本地声音暂不通知)。
首帧本地视频数据已经被送出。
首帧本地音频数据已经被送出。
废弃接口:有主播加入当前房间。
废弃接口: 有主播离开当前房间。

统计和质量回调

API
描述
网络质量:该回调每2秒触发一次,统计当前网络的上行和下行质量。
技术指标统计回调。

服务器事件回调

API
描述
SDK 与服务器的连接断开。
SDK 尝试重新连接到服务器。
SDK 与服务器的连接恢复。
废弃接口:服务器测速的回调,SDK 对多个服务器 IP 进行测速,每个 IP 的测速结果通过这个回调通知。
网速测试的结果回调。

硬件设备事件回调

API
描述
摄像头准备就绪。
麦克风准备就绪。
用于提示音量大小的回调,包括每个 userId 的音量和远端总音量;本地用户 userid 为''。
本地设备通断回调。
麦克风测试音量回调。
扬声器测试音量回调。
当前音频采集设备音量变化回调。
当前音频播放设备音量变化回调。

自定义消息的接收回调

API
描述
收到自定义消息回调。
自定义消息丢失回调。
收到 SEI 消息的回调。

CDN 旁路转推回调

API
描述
开始向腾讯云的直播 CDN 推流的回调,对应于 TRTCCloud 中的 startPublishing() 接口。
停止向腾讯云的直播 CDN 推流的回调,对应于 TRTCCloud 中的 stopPublishing() 接口。
启动旁路推流到 CDN 完成的回调。
停止旁路推流到 CDN 完成的回调。
设置云端的混流转码参数的回调,对应于 TRTCCloud 中的 setMixTranscodingConfig() 接口。

系统音量采集回调

API
描述
系统音量采集状态的回调(仅在 Mac 上有效)。

音效回调

API
描述
废弃接口:播放音效结束回调。

屏幕分享回调

API
描述
当屏幕分享窗口被遮挡无法正常捕获时,SDK 会通过此回调通知,可在此回调里通知用户移开遮挡窗口。
当屏幕分享开始时,SDK 会通过此回调通知。
当屏幕分享暂停时,SDK 会通过此回调通知。
当屏幕分享恢复时,SDK 会通过此回调通知。
当屏幕分享停止时,SDK 会通过此回调通知。

截图回调

API
描述
截图完成时,SDK 会通过此回调通知。

背景混音事件回调

API
描述
废弃接口:开始播放背景音乐。
废弃接口:播放背景音乐的进度。
废弃接口:播放背景音乐结束。

关键类型定义

关键类型

类名
描述
进房相关参数。
视频编码参数。
网络流控相关参数。
视频质量。
音量大小。
网络测速结果。
云端混流中每一路子画面的位置信息。
云端混流(转码)配置。
CDN 旁路推流参数。
录音参数。
自己本地的音视频统计信息。
远端成员的音视频统计信息。
统计数据。

枚举值

枚举
描述
视频分辨率。
视频分辨率模式。
视频流类型。
画质级别。
视频画面填充模式。
美颜(磨皮)算法。
应用场景。
角色,仅适用于直播场景(TRTCAppSceneLIVE)。
流控模式。
画质偏好。
设备操作。
设备类型。
水印图片的源类型。
混流参数配置模式。

目录