Docs Overview/
RTC Engine/
SDK/
iOS/
客户端API/
API 概览/

API 概览

API OVERVIEW

创建实例和事件回调

函数列表
描述
创建 TRTCCloud 实例（单例模式）
销毁 TRTCCloud 实例（单例模式）
添加 TRTC 事件回调
移除 TRTC 事件回调
设置驱动 TRTCCloudDelegate 事件回调的队列

房间相关接口函数

函数列表
描述
进入房间
离开房间
切换角色
切换角色（支持设置权限位）
切换房间
请求跨房通话
退出跨房通话
设置订阅模式（需要在进入房前设置才能生效）
创建子房间实例（用于多房间并发观看）
销毁子房间实例
更改跨房主播在本房间的上行能力

CDN 相关接口函数

函数列表
描述
开始发布媒体流
更新发布媒体流
停止发布媒体流

视频相关接口函数

函数列表
描述
开启本地摄像头的预览画面（移动端）
开启本地摄像头的预览画面（桌面端）
更新本地摄像头的预览画面
停止摄像头预览
暂停/恢复发布本地的视频流
设置本地画面被暂停期间的替代图片
订阅远端用户的视频流，并绑定视频渲染控件
更新远端用户的视频渲染控件
停止订阅远端用户的视频流，并释放渲染控件
停止订阅所有远端用户的视频流，并释放全部渲染资源
暂停/恢复订阅远端用户的视频流
暂停/恢复订阅所有远端用户的视频流
设置视频编码器的编码参数
设置网络质量控制的相关参数
设置本地画面的渲染参数
设置远端画面的渲染模式
开启大小画面双路编码模式
切换指定远端用户的大小画面
视频画面截图
视频画面透视校正坐标设置
设置重力感应的适配模式（11.7 及以上版本）

音频相关接口函数

函数列表
描述
开启本地音频的采集和发布
停止本地音频的采集和发布
暂停/恢复发布本地的音频流
暂停/恢复播放远端的音频流
暂停/恢复播放所有远端用户的音频流
设置音频路由
设定某一个远端用户的声音播放音量
设定本地音频的采集音量
获取本地音频的采集音量
设定远端音频的播放音量
获取远端音频的播放音量
启用音量大小提示
开始录音
停止录音
开启本地媒体录制
停止本地媒体录制
设置远端音频流智能并发播放策略
启用 3D 音效
设置 3D 音效中自身坐标及朝向信息
设置 3D 音效中远端用户坐标信息
设置指定用户所发出声音的可被接收范围

设备管理相关接口

函数列表
描述
获取设备管理类（TXDeviceManager）

美颜特效和图像水印

函数列表
描述
获取美颜管理类（TXBeautyManager）
添加水印

背景音乐和声音特效

函数列表
描述
获取音效管理类（TXAudioEffectManager）
开启系统声音采集（iOS 端暂未支持）
停止系统声音采集（iOS 端暂未支持）
设置系统声音的采集音量

屏幕分享相关接口

函数列表
描述
开始应用内的屏幕分享（仅支持 iOS 13.0 及以上系统）
开始全系统的屏幕分享（仅支持 iOS 11.0 及以上系统）
启动屏幕分享
停止屏幕分享
暂停屏幕分享
恢复屏幕分享
枚举可分享的屏幕和窗口（该接口仅支持 Mac OS 系统）
选取要分享的屏幕或窗口（该接口仅支持 Mac OS 系统）
设置屏幕分享（即辅路）的视频编码参数（桌面系统和移动系统均已支持）
设置屏幕分享时的混音音量大小（该接口仅支持桌面系统）
将指定窗口加入屏幕分享的排除列表中（该接口仅支持桌面系统）
将指定窗口从屏幕分享的排除列表中移除（该接口仅支持桌面系统）
将所有窗口从屏幕分享的排除列表中移除（该接口仅支持桌面系统）
将指定窗口加入屏幕分享的包含列表中（该接口仅支持桌面系统）
将指定窗口从屏幕分享的包含列表中移除（该接口仅支持桌面系统）
将全部窗口从屏幕分享的包含列表中移除（该接口仅支持桌面系统）

自定义采集和自定义渲染

函数列表
描述
启用/关闭视频自定义采集模式
向 SDK 投送自己采集的视频帧
启用音频自定义采集模式
向 SDK 投送自己采集的音频数据
启用/关闭自定义音轨
向 SDK 混入自定义音轨
设置推流时混入外部音频的推流音量和播放音量
生成自定义采集时的时间戳
设置第三方美颜的视频数据回调
设置本地视频自定义渲染回调
设置远端视频自定义渲染回调
设置音频数据自定义回调
设置本地麦克风采集出的音频帧回调格式
设置经过前处理后的本地音频帧回调格式
设置最终要由系统播放出的音频帧回调格式
开启音频自定义播放
获取可播放的音频数据

自定义消息发送接口

函数列表
描述
使用 UDP 通道发送自定义消息给房间内所有用户
使用 SEI 通道发送自定义消息给房间内所有用户

网络测试接口

函数列表
描述
开始进行网速测试（进入房间前使用）
停止网络测速

调试相关接口

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

加密接口

函数列表
描述
开启或关闭媒体流私有加密

错误和警告事件

函数列表
描述
错误事件回调
警告事件回调

房间相关事件回调

函数列表
描述
进入房间成功与否的事件回调
离开房间的事件回调
切换角色的事件回调
切换房间的结果回调
请求跨房通话的结果回调
结束跨房通话的结果回调
更改跨房主播上行能力的结果回调

用户相关事件回调

函数列表
描述
有用户加入当前房间
有用户离开当前房间
某远端用户发布/取消了主路视频画面
某远端用户发布/取消了辅路视频画面
某远端用户发布/取消了自己的音频
SDK 开始渲染自己本地或远端用户的首帧画面
SDK 开始播放远端用户的首帧音频
自己本地的首个视频帧已被发布出去
自己本地的首个音频帧已被发布出去
远端视频状态变化的事件回调
远端音频状态变化的事件回调
用户视频大小发生改变回调

网络和技术指标统计回调

函数列表
描述
网络质量的实时统计回调
音视频技术指标的实时统计回调
网速测试的结果回调

与云端连接情况的事件回调

函数列表
描述
SDK 与云端的连接已经断开
SDK 正在尝试重新连接到云端
SDK 与云端的连接已经恢复

硬件设备相关事件回调

函数列表
描述
摄像头准备就绪
麦克风准备就绪
当前音频路由发生变化（仅适用于移动设备）
音量大小的反馈回调
本地设备的通断状态发生变化（仅适用于桌面系统）
当前麦克风的系统采集音量发生变化
当前系统的播放音量发生变化
系统声音采集是否被成功开启的事件回调（仅适用于桌面系统）

自定义消息的接收事件回调

函数列表
描述
收到自定义消息的事件回调
自定义消息丢失的事件回调
收到 SEI 消息的回调

CDN 相关事件回调

函数列表
描述
开始向腾讯云直播 CDN 上发布音视频流的事件回调
停止向腾讯云直播 CDN 上发布音视频流的事件回调
开始向非腾讯云 CDN 上发布音视频流的事件回调
停止向非腾讯云 CDN 上发布音视频流的事件回调
设置云端混流的排版布局和转码参数的事件回调
开始发布媒体流的事件回调
更新媒体流的事件回调
停止媒体流的事件回调
RTMP/RTMPS 推流状态发生改变回调

屏幕分享相关事件回调

函数列表
描述
屏幕分享开启的事件回调
屏幕分享暂停的事件回调
屏幕分享恢复的事件回调
屏幕分享停止的事件回调

本地录制和本地截图的事件回调

函数列表
描述
本地录制任务已经开始的事件回调
本地录制任务正在进行中的进展事件回调
本地录制分片的事件回调
本地录制任务已经结束的事件回调

废弃的事件回调

函数列表
描述
有主播加入当前房间（已废弃）
有主播离开当前房间（已废弃）
音效播放已结束（已废弃）

视频数据自定义回调

函数列表
描述
自定义视频渲染回调
SDK 内部 OpenGL 环境已经创建的通知
用于对接第三方美颜组件的视频处理回调
SDK 内部 OpenGL 环境被销毁的通知

音频数据自定义回调

函数列表
描述
本地采集并经过音频模块前处理后的音频数据回调
本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调
混音前的每一路远程用户的音频数据
将各路待播放音频混合之后并在最终提交系统播放之前的数据回调
SDK 所有音频混合后的音频数据（包括采集到的和待播放的）
耳返的音频数据

更多事件回调接口

函数列表
描述
本地 LOG 的打印回调

人声相关的特效接口

函数列表
描述
开启耳返
设置耳返音量
设置人声的混响效果
设置人声的变声特效
设置语音音量
设置语音音调

背景音乐的相关接口

函数列表
描述
开始播放背景音乐
停止播放背景音乐
暂停播放背景音乐
恢复播放背景音乐
设置所有背景音乐的本地音量和远端音量的大小
设置某一首背景音乐的远端音量的大小
设置某一首背景音乐的本地音量的大小
调整背景音乐的音调高低
调整背景音乐的变速效果
获取背景音乐的播放进度（单位：毫秒）
获取背景音乐的总时长（单位：毫秒）
设置背景音乐的播放进度（单位：毫秒）
调整搓碟的变速效果
预加载背景音乐
获取背景音乐的音轨数量
指定背景音乐的播放音轨

美颜相关接口

函数列表
描述
设置美颜（磨皮）算法
设置美颜级别
设置美白级别
开启清晰度增强
设置红润级别
设置色彩滤镜效果
设置色彩滤镜的强度
设置绿幕背景视频
设置大眼级别
设置瘦脸级别
设置 V 脸级别
设置下巴拉伸或收缩
设置短脸级别
设置窄脸级别
设置瘦鼻级别
设置亮眼级别
设置牙齿美白级别
设置祛皱级别
设置祛眼袋级别
设置法令纹去除级别
设置发际线调整级别
设置眼距
设置眼角调整级别
设置嘴型调整级别
设置鼻翼调整级别
设置鼻子位置
设置嘴唇厚度
设置脸型
选择 AI 动效挂件
是否在动效素材播放时静音

音视频设备相关的类型定义

函数列表
描述
本地设备的通断状态发生变化（仅适用于桌面系统）

设备操作接口

函数列表
描述
判断当前是否为前置摄像头（仅适用于移动端）
切换前置或后置摄像头（仅适用于移动端）
查询当前摄像头是否支持缩放（仅适用于移动端）
获取摄像头的最大缩放倍数（仅适用于移动端）
设置摄像头的缩放倍数（仅适用于移动端）
查询是否支持自动识别人脸位置（仅适用于移动端）
开启自动对焦功能（仅适用于移动端）
设置摄像头的对焦位置（仅适用于移动端）
查询是否支持开启闪光灯（仅适用于移动端）
开启/关闭闪光灯，也就是手电筒模式（仅适用于移动端）
设置音频路由（仅适用于移动端）
设置摄像头的曝光参数，取值范围从-1到1
获取设备列表（仅适用于桌面端）
设置当前要使用的设备（仅适用于桌面端）
获取当前正在使用的设备（仅适用于桌面端）
设置当前设备的音量（仅适用于桌面端）
获取当前设备的音量（仅适用于桌面端）
设置当前设备的静音状态（仅适用于桌面端）
获取当前设备的静音状态（仅适用于桌面端）
设置 SDK 使用的音频设备根据跟随系统默认设备（仅适用于桌面端）
开始摄像头测试（仅适用于桌面端）
结束摄像头测试（仅适用于桌面端）
开始麦克风测试（仅适用于桌面端）
开始麦克风测试（仅适用于桌面端）
结束麦克风测试（仅适用于桌面端）
开始扬声器测试（仅适用于桌面端）
结束扬声器测试（仅适用于桌面端）
设备热插拔回调（仅适用于 Mac 系统）
设置摄像头采集偏好

弃用接口

函数列表
描述
设置系统音量类型（仅适用于移动端）

废弃接口

函数列表
描述
销毁 TRTCCloud 实例（单例模式）
设置 TRTC 事件回调
设置美颜、美白以及红润效果级别
设置大眼级别
设置瘦脸级别
设置 V 脸级别
设置下巴拉伸或收缩幅度
设置短脸级别
设置瘦鼻级别
设置动效贴纸
设置动效静音
设置色彩滤镜效果
设置色彩滤镜浓度
设置绿幕背景视频
设置混响效果
设置变声类型
开启（或关闭）耳返
启用音量大小提示
启用音量大小提示
切换摄像头
查询当前摄像头是否支持缩放
设置摄像头缩放倍数（焦距）
查询是否支持开关闪光灯
开关/关闭闪光灯
查询摄像头是否支持设置焦点
设置摄像头焦点坐标位置
查询是否支持自动识别人脸位置
开启/关闭人脸跟踪对焦
设置系统音量类型
视频截图
开始全系统的屏幕分享（iOS）
设置音频质量
开始显示远端视频画面
停止显示远端视频画面，同时不再拉取该远端用户的视频数据流
设置本地图像的渲染模式
设置本地图像的顺时针旋转角度
设置本地摄像头预览画面的镜像模式
设置远端图像的渲染模式
设置远端图像的顺时针旋转角度
开始显示远端用户的辅路画面
停止显示远端用户的辅路画面
设置辅路画面的填充模式
设置辅路画面的顺时针旋转角度
设置音频质量
设定优先观看大画面还是小画面
设置麦克风音量大小
启动播放背景音乐
停止播放背景音乐
停止播放背景音乐
停止播放背景音乐
获取背景音乐总时长（单位：毫秒）
设置背景音乐的播放进度
设置背景音乐的音量大小
设置背景音乐的本地播放音量
设置背景音乐的远端播放音量
播放音效
设置音效音量
停止播放音效
停止所有音效
设置所有音效音量
暂停音效
暂停音效
启用视频自定义采集模式
投送自己采集的视频数据
暂停/恢复发布本地的视频流
暂停 / 恢复订阅远端用户的视频流
开始进行网络测速（进入房间前使用）
启动屏幕分享
获取摄像头设备列表
选定当前要使用的摄像头
获取当前使用的摄像头
获取麦克风设备列表
获取当前的麦克风设备
选定当前使用的麦克风
获取当前麦克风的设备音量
设置当前麦克风的设备音量
设置系统当前麦克风设备的静音状态
获取系统当前麦克风设备是否静音
获取扬声器设备列表
获取当前的扬声器设备
设置要使用的扬声器
获取当前扬声器的设备音量
设置当前扬声器的设备音量
获取系统当前扬声器设备是否静音
设置系统当前扬声器设备的静音状态
开始进行摄像头测试
停止进行摄像头测试
开始进行麦克风测试
开始进行麦克风测试
开始进行扬声器测试
停止进行扬声器测试
开始应用内的屏幕分享（iOS）
设置视频编码器输出的画面方向
设置编码器输出的画面镜像模式
设置重力感应的适配模式
开始向腾讯云直播 CDN 上发布音视频流
停止向腾讯云直播 CDN 上发布音视频流
开始向非腾讯云 CDN 上发布音视频流
停止向非腾讯云 CDN 上发布音视频流
设置云端混流的排版布局和转码参数