含 UI 集成方案

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

ITRTCCloud @ TXLiteAVSDK

创建与销毁 ITRTCCloud 单例

API
描述
获取 ITRTCCloud 单例对象。
释放 ITRTCCloud 单例对象。

设置 TRTCCloudCallback 回调

API
描述
设置回调接口 ITRTCCloudCallback
移除事件回调。

房间相关接口函数

API
描述
enterRoom
进入房间。
exitRoom
离开房间。
切换角色,仅适用于直播场景(TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom)。
请求跨房通话(主播 PK)。
关闭跨房连麦。
设置音视频数据接收模式(需要在进房前设置才能生效)。
切换房间。

CDN 相关接口函数

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

视频相关接口函数

API
描述
开启本地视频的预览画面。
更新本地视频预览画面的窗口。
停止本地视频采集及预览。
暂停/恢复推送本地的视频数据。
开始拉取并显示指定用户的远端画面。
更新远端视频渲染的窗口。
停止显示远端视频画面,同时不再拉取远端用户的视频数据流。
停止显示所有远端视频画面,同时不再拉取远端用户的视频数据流。
暂停/恢复接收指定的远端视频流。
暂停/恢复接收所有远端视频流。
设置视频编码器相关参数。
设置网络流控相关参数。
设置本地图像(主流)的渲染参数。
设置视频编码输出的画面方向,即设置远端用户观看到的和服务器录制的画面方向。
设置编码器输出的画面镜像模式。
设置远端图像的渲染模式。
开启大小画面双路编码模式。
选定观看指定 userId 的大画面还是小画面。

音频相关接口函数

API
描述
开启本地音频的采集和上行。
关闭本地音频的采集和上行。
静音/取消静音本地的音频。
静音/取消静音指定的远端用户的声音。
静音/取消静音所有用户的声音。
设置 SDK 采集音量。
获取 SDK 采集音量。
设置 SDK 播放音量。
获取 SDK 播放音量。
启用或关闭音量大小提示。
开始录音。
停止录音。

设备相关接口函数

API
描述
获取设备管理模块。

美颜特效和图像水印

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

音乐特效和人声特效

API
描述
获取音效管理类 ITXAudioEffectManager。
打开系统声音采集。
关闭系统声音采集。
设置系统声音采集的音量。

屏幕分享相关接口函数

API
描述
启动屏幕分享。
停止屏幕采集。
暂停屏幕分享。
恢复屏幕分享。
枚举可分享的屏幕窗口,建议在 startScreenCapture 之前调用。
设置屏幕共享参数,该方法在屏幕共享过程中也可以调用。
设置屏幕分享的编码器参数。
设置屏幕分享的混音音量大小。
将指定窗口加入屏幕分享的排除列表中,加入排除列表中的窗口不会被分享出去。
将指定窗口从屏幕分享的排除列表中移除。
将所有窗口从屏幕分享的排除列表中移除。

自定义采集和渲染

API
描述
启用视频自定义采集模式。
向 SDK 投送自己采集的视频数据。
启用音频自定义采集模式。
向 SDK 投送自己采集的音频数据。
设置本地视频自定义渲染。
设置远端视频自定义渲染。
设置音频数据回调。

自定义消息发送

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

网络测试

API
描述
开始进行网络测速(视频通话期间请勿测试,以免影响通话质量)。
停止网络测速。

LOG 相关接口函数

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

弃用接口函数

API
描述
设置麦克风的音量大小。
启动屏幕分享。
playBGM
启动播放背景音乐。
stopBGM
停止播放背景音乐。
pauseBGM
暂停播放背景音乐。
resumeBGM
继续播放背景音乐。
获取音乐文件总时长,单位毫秒。
设置 BGM 播放进度。
设置背景音乐播放音量的大小。
设置背景音乐本地播放音量的大小。
设置背景音乐远端播放音量的大小。
播放音效。
设置音效音量。
停止音效。
停止所有音效。
设置所有音效的音量。
暂停音效。
恢复音效。
设置屏幕共享参数。
开始显示远端视频画面。
停止显示远端视频画面,同时不再拉取远端用户的视频数据流。
设置本地图像的渲染模式。
设置远端图像的渲染模式。
设置本地图像的顺时针旋转角度。
设置远端图像的顺时针旋转角度。
设置本地摄像头预览画面的镜像模式。
开始显示远端用户的辅路画面(TRTCVideoStreamTypeSub,一般用于屏幕分享)。
停止显示远端用户的辅路画面(TRTCVideoStreamTypeSub,一般用于屏幕分享)。
设置辅路画面(TRTCVideoStreamTypeSub,一般用于屏幕分享)的显示模式。
设置辅路画面(TRTCVideoStreamTypeSub,一般用于屏幕分享)的顺时针旋转角度。
设定观看方优先选择的视频质量。
设置音频质量。
开启本地音频的采集和上行。
获取摄像头设备列表。
设置要使用的摄像头。
获取当前使用的摄像头。
获取麦克风设备列表。
获取当前选择的麦克风。
设置要使用的麦克风。
获取系统当前麦克风设备音量。
设置系统当前麦克风设备的音量。
获取扬声器设备列表。
获取当前的扬声器设备。
设置要使用的扬声器。
获取系统当前扬声器设备音量。
设置系统当前扬声器设备音量。
开始进行摄像头测试。
停止摄像头测试。
开启麦克风测试。
停止麦克风测试。
开启扬声器测试。
停止扬声器测试。

TRTCCloudCallback @ TXLiteAVSDK

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

错误事件和警告事件

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

房间事件回调

API
描述
已加入房间的回调。
离开房间的事件回调。
切换角色结果回调。
请求跨房通话(主播 PK)的结果回调。
结束跨房通话(主播 PK)的结果回调。
切换房间 (switchRoom) 的结果回调。

成员事件回调

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

统计和质量回调

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

服务器事件回调

API
描述
SDK 跟服务器的连接断开。
SDK 尝试重新连接到服务器。
SDK 跟服务器的连接恢复。
服务器测速的回调,SDK 对多个服务器 IP 做测速,每个 IP 的测速结果通过这个回调通知。

硬件设备事件回调

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

自定义消息的接收回调

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

CDN 旁路转推回调

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

屏幕分享回调

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

弃用接口回调

API
描述
废弃接口:有主播加入当前房间。
废弃接口:有用户(主播)离开当前房间。
废弃接口:播放音效结束回调。
废弃接口:开始播放背景音乐。
废弃接口:播放背景音乐的进度。
废弃接口:播放背景音乐结束。

视频数据帧的自定义处理回调

API
描述
自定义视频渲染回调。

声音数据帧的自定义处理回调(只读)

回调函数是在 SDK 内部线程同步抛出来的,请不要做耗时操作。
说明
请按需定义相关函数实现,减少不必要的性能损耗。
API
描述
本地麦克风采集到的音频数据回调。
混音前的每一路远程用户的音频数据(例如您要对某一路的语音进行文字转换,必须要使用这里的原始数据,而不是混音之后的数据)。
各路音频数据混合后送入喇叭播放的音频数据。

日志相关回调

API
描述
onLog
有日志打印时的回调。

关键类型定义

类名
描述
图缓存。
屏幕采集信息。
SIZE
记录 buffer 的长宽。
屏幕窗口列表。
设备列表。
设备 Item 信息。
进房相关参数。
视频编码参数。
网络流控相关参数。
视频质量。
音量大小。
视频帧数据。
音频帧数据。
网络测速结果。
RECT
记录矩形的四个点坐标。
云端混流中每一路子画面的位置信息。
云端混流(转码)配置。
CDN 旁路推流参数。
录音参数。
音效播放。
自己本地的音视频统计信息。
远端成员的音视频统计信息。
统计数据。

目录