API OVERVIEW
创建实例和事件回调
函数列表 | 描述 |
创建 TRTCCloud 实例（单例模式）。 | |
销毁 TRTCCloud 实例（单例模式）。 | |
添加 TRTC 事件回调。 | |
移除 TRTC 事件回调。 |
房间相关接口函数
函数列表 | 描述 |
进入房间。 | |
离开房间。 | |
切换角色。 | |
切换房间。 | |
请求跨房通话。 | |
退出跨房通话。 | |
设置订阅模式（需要在进入房前设置才能生效）。 | |
创建子房间实例（用于多房间并发观看）。 | |
销毁子房间实例。 | |
更改跨房主播在本房间的上行能力。 |
CDN 相关接口函数
函数列表 | 描述 |
开始发布媒体流。 | |
更新发布媒体流。 | |
停止发布媒体流。 |
视频相关接口函数
函数列表 | 描述 |
开启本地摄像头的预览画面（移动端）。 | |
更新本地摄像头的预览画面。 | |
停止摄像头预览。 | |
暂停/恢复发布本地的视频流。 | |
设置本地画面被暂停期间的替代图片。 | |
订阅远端用户的视频流，并绑定视频渲染控件。 | |
更新远端用户的视频渲染控件。 | |
停止订阅远端用户的视频流，并释放渲染控件。 | |
停止订阅所有远端用户的视频流，并释放全部渲染资源。 | |
暂停/恢复订阅远端用户的视频流。 | |
暂停/恢复订阅所有远端用户的视频流。 | |
设置视频编码器的编码参数。 | |
设置本地画面的渲染参数。 | |
设置远端画面的渲染模式。 | |
开启大小画面双路编码模式。 | |
切换指定远端用户的大小画面。 | |
视频画面截图。 | |
设置重力感应的适配模式（11.7 及以上版本）。 |
音频相关接口函数
函数列表 | 描述 |
开启本地音频的采集和发布。 | |
停止本地音频的采集和发布。 | |
暂停/恢复发布本地的音频流。 | |
暂停/恢复播放远端的音频流。 | |
暂停/恢复播放所有远端用户的音频流。 | |
设定某一个远端用户的声音播放音量。 | |
设定本地音频的采集音量。 | |
获取本地音频的采集音量。 | |
设定远端音频的播放音量。 | |
获取远端音频的播放音量。 | |
启用音量大小提示。 | |
开始录音。 | |
停止录音。 | |
开启本地媒体录制。 | |
停止本地媒体录制。 | |
设置远端音频流智能并发播放策略。 | |
启用 3D 音效。 | |
设置 3D 音效中自身坐标及朝向信息。 | |
设置 3D 音效中远端用户坐标信息。 | |
设置指定用户所发出声音的可被接收范围。 |
设备管理相关接口
函数列表 | 描述 |
获取设备管理类（TXDeviceManager）。 |
美颜特效和图像水印
函数列表 | 描述 |
获取美颜管理类（TXBeautyManager）。 | |
添加水印。 |
背景音乐和声音特效
函数列表 | 描述 |
获取音效管理类（TXAudioEffectManager）。 | |
开启系统声音采集（iOS 端暂未支持）。 | |
停止系统声音采集（iOS 端暂未支持）。 | |
设置系统声音的采集音量。 |
屏幕分享相关接口
函数列表 | 描述 |
启动屏幕分享。 | |
停止屏幕分享。 | |
暂停屏幕分享。 | |
恢复屏幕分享。 | |
设置屏幕分享（即辅路）的视频编码参数（桌面系统和移动系统均已支持）。 |
自定义采集和自定义渲染
函数列表 | 描述 |
启用/关闭视频自定义采集模式。 | |
向 SDK 投送自己采集的视频帧。 | |
启用音频自定义采集模式。 | |
向 SDK 投送自己采集的音频数据。 | |
启用/关闭自定义音轨。 | |
向 SDK 混入自定义音轨。 | |
设置推流时混入外部音频的推流音量和播放音量。 | |
生成自定义采集时的时间戳。 | |
.1 开启视频第三方美颜。 | |
.2 设置第三方美颜的视频数据回调。 | |
设置本地视频自定义渲染回调。 | |
设置远端视频自定义渲染回调。 | |
设置音频数据自定义回调。 | |
设置本地麦克风采集出的音频帧回调格式。 | |
设置经过前处理后的本地音频帧回调格式。 | |
设置最终要由系统播放出的音频帧回调格式。 | |
开启音频自定义播放。 | |
获取可播放的音频数据。 |
自定义消息发送接口
函数列表 | 描述 |
使用 UDP 通道发送自定义消息给房间内所有用户。 | |
使用 SEI 通道发送自定义消息给房间内所有用户。 |
网络测试接口
函数列表 | 描述 |
开始进行网速测试（进入房间前使用）。 | |
停止网络测速。 |
调试相关接口
函数列表 | 描述 |
获取 SDK 版本信息。 | |
设置 Log 输出级别。 | |
启用/禁用控制台日志打印。 | |
启用/禁用日志的本地压缩。 | |
设置本地日志的保存路径。 | |
设置日志回调。 | |
显示仪表盘。 | |
调用实验性接口。 |
错误和警告事件
房间相关事件回调
函数列表 | 描述 |
进入房间成功与否的事件回调。 | |
离开房间的事件回调。 | |
切换角色的事件回调。 | |
切换房间的结果回调。 | |
请求跨房通话的结果回调。 | |
结束跨房通话的结果回调。 | |
更改跨房主播上行能力的结果回调。 |
用户相关事件回调
函数列表 | 描述 |
有用户加入当前房间。 | |
有用户离开当前房间。 | |
某远端用户发布/取消了主路视频画面。 | |
某远端用户发布/取消了辅路视频画面。 | |
某远端用户发布/取消了自己的音频。 | |
SDK 开始渲染自己本地或远端用户的首帧画面。 | |
SDK 开始播放远端用户的首帧音频。 | |
自己本地的首个视频帧已被发布出去。 | |
自己本地的首个音频帧已被发布出去。 | |
远端视频状态变化的事件回调。 | |
远端音频状态变化的事件回调。 | |
用户视频大小发生改变回调。 |
网络和技术指标统计回调
函数列表 | 描述 |
网络质量的实时统计回调。 | |
音视频技术指标的实时统计回调。 | |
网速测试的结果回调。 |
与云端连接情况的事件回调
函数列表 | 描述 |
SDK 与云端的连接已经断开。 | |
SDK 正在尝试重新连接到云端。 | |
SDK 与云端的连接已经恢复。 |
硬件设备相关事件回调
函数列表 | 描述 |
摄像头准备就绪。 | |
麦克风准备就绪。 | |
当前音频路由发生变化（仅适用于移动设备）。 | |
音量大小的反馈回调。 |
自定义消息的接收事件回调
函数列表 | 描述 |
收到自定义消息的事件回调。 | |
自定义消息丢失的事件回调。 | |
收到 SEI 消息的回调。 |
CDN 相关事件回调
函数列表 | 描述 |
开始发布媒体流的事件回调。 | |
更新媒体流的事件回调。 | |
停止媒体流的事件回调。 | |
RTMP/RTMPS 推流状态发生改变回调。 |
屏幕分享相关事件回调
函数列表 | 描述 |
屏幕分享开启的事件回调。 | |
屏幕分享暂停的事件回调。 | |
屏幕分享恢复的事件回调。 | |
屏幕分享停止的事件回调。 |
本地录制和本地截图的事件回调
函数列表 | 描述 |
本地录制任务已经开始的事件回调。 | |
本地录制任务正在进行中的进展事件回调。 | |
本地录制分片的事件回调。 | |
本地录制任务已经结束的事件回调。 | |
本地截图完成的事件回调。 |
视频数据自定义回调
函数列表 | 描述 |
自定义视频渲染回调。 | |
SDK 内部 OpenGL 环境已经创建的通知。 | |
用于对接第三方美颜组件的视频处理回调。 | |
SDK 内部 OpenGL 环境被销毁的通知。 |
音频数据自定义回调
函数列表 | 描述 |
本地采集并经过音频模块前处理后的音频数据回调。 | |
本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调。 | |
混音前的每一路远程用户的音频数据。 | |
将各路待播放音频混合之后并在最终提交系统播放之前的数据回调。 | |
SDK 所有音频混合后的音频数据（包括采集到的和待播放的）。 |
更多事件回调接口
函数列表 | 描述 |
本地 LOG 的打印回调。 |
背景音乐预加载事件回调
函数列表 | 描述 |
背景音乐预加载进度 | |
背景音乐预加载出错 |
背景音乐的播放事件回调
函数列表 | 描述 |
背景音乐开始播放 | |
背景音乐的播放进度 | |
背景音乐已经播放完毕 |
人声相关的特效接口
函数列表 | 描述 |
开启耳返。 | |
设置耳返音量。 | |
设置人声的混响效果。 | |
设置人声的变声特效。 | |
设置语音音量。 | |
设置语音音调。 |
背景音乐的相关接口
函数列表 | 描述 |
设置背景音乐的事件回调接口。 | |
开始播放背景音乐。 | |
停止播放背景音乐。 | |
暂停播放背景音乐。 | |
恢复播放背景音乐。 | |
设置所有背景音乐的本地音量和远端音量的大小。 | |
设置某一首背景音乐的远端音量的大小。 | |
设置某一首背景音乐的本地音量的大小。 | |
调整背景音乐的音调高低。 | |
调整背景音乐的变速效果。 | |
获取背景音乐的播放进度（单位：毫秒）。 | |
获取背景音乐的总时长（单位：毫秒）。 | |
设置背景音乐的播放进度（单位：毫秒）。 | |
调整搓碟的变速效果。 | |
设置预加载事件回调。 | |
预加载背景音乐。 | |
获取背景音乐的音轨数量。 | |
指定背景音乐的播放音轨。 |
美颜相关接口
函数列表 | 描述 |
设置美颜（磨皮）算法。 | |
设置美颜级别。 | |
设置美白级别。 | |
设置红润级别。 | |
设置色彩滤镜效果。 | |
设置色彩滤镜的强度。 |
设备操作接口
函数列表 | 描述 |
判断当前是否为前置摄像头（仅适用于移动端）。 | |
切换前置或后置摄像头（仅适用于移动端）。 | |
设置音频路由（仅适用于移动端）。 |
废弃接口
函数列表 | 描述 |
设置编码器输出的画面镜像模式。 |
