文档平台 实时音视频 API文档(V2) iOS&Mac 概览

概览

最近更新时间：2019-03-11 17:25:58

查看pdf

在这篇文章中：

TRTCCloud @ TXLiteAVSDK

腾讯云视频通话功能的主要接口类。

创建与销毁

API 描述
sharedInstance 创建 TRTCCloud 单例
destroySharedIntance 销毁 TRTCCloud 单例

房间相关接口函数

API 描述
enterRoom 进入房间
exitRoom 离开房间
connectOtherRoom 请求跨房连麦
disconnectOtherRoom 取消跨房连麦

视频相关接口函数

API 描述
startLocalPreview 开启本地视频的预览画面（iOS 版本）
startLocalPreview 开启本地视频的预览画面（Mac 版本）
stopLocalPreview 停止本地视频采集及预览
startRemoteView 启动渲染远端视频画面
stopRemoteView 停止渲染远端视频画面
stopAllRemoteView 停止渲染远端视频画面，如果有屏幕分享，则屏幕分享的画面也会一并被关闭
muteLocalVideo 是否屏蔽本地视频
setVideoEncoderParam 设置视频编码器相关参数，该设置决定了远端用户看到的画面质量（同时也是云端录制出的视频文件的画面质量）
setNetworkQosParam 设置网络流控相关参数，该设置决定了 SDK 在各种网络环境下的调控策略（比如弱网下是“保清晰”还是“保流畅”）
setLocalViewFillMode 设置本地图像的渲染模式
setRemoteViewFillMode 设置远端图像的渲染模式
setLocalViewRotation 设置本地图像的顺时针旋转角度
setRemoteViewRotation 设置远端图像的顺时针旋转角度
setVideoEncoderRotation 设置视频编码输出的（也就是远端用户观看到的，以及服务器录制下来的）画面方向
setGSensorMode 设置重力感应的适应模式
enableEncSmallVideoStream 开启大小画面双路编码模式
setRemoteVideoStreamType 选定观看指定 uid 的大画面还是小画面
setPriorRemoteVideoStreamType 设定观看方优先选择的视频质量
setLocalVideoMirror 设置摄像头本地预览是否开镜像

音频相关接口函数

API 描述
startLocalAudio 开启本地音频流，该函数会启动麦克风采集，并将音频数据广播给房间里的其他用户
stopLocalAudio 关闭本地音频流
muteLocalAudio 是否屏蔽本地音频
setAudioRoute 设置音频路由
muteRemoteAudio 设置指定用户是否静音
muteAllRemoteAudio 设置所有远端用户是否静音
enableAudioVolumeEvaluation 启用音量大小提示

摄像头相关接口函数

API 描述
switchCamera 切换摄像头
isCameraZoomSupported 查询当前摄像头是否支持缩放
setZoom 设置摄像头缩放因子（焦距）
isCameraTorchSupported 查询是否支持手电筒模式
enbaleTorch 开关闪光灯
isCameraFocusPositionInPreviewSupported 查询是否支持设置焦点
setFocusPosition 设置摄像头焦点
isCameraAutoFocusFaceModeSupported 查询是否支持自动识别人脸位置
enableAutoFaceFoucs 自动识别人脸位置
getCameraDevicesList 获取摄像头设备列表
getCurrentCameraDevice 获取当前要使用的摄像头
setCurrentCameraDevice 设置要使用的摄像头

音频设备相关接口函数

API 描述
getMicDevicesList 获取麦克风设备列表
getCurrentMicDevice 获取当前的麦克风设备
setCurrentMicDevice 设置要使用的麦克风
getCurrentMicDeviceVolume 获取当前麦克风设备音量
setCurrentMicDeviceVolume 设置麦克风设备的音量
getSpeakerDevicesList 获取扬声器设备列表
getCurrentSpeakerDevice 获取当前的扬声器设备
setCurrentSpeakerDevice 设置要使用的扬声器
getCurrentSpeakerDeviceVolume 当前扬声器设备音量
setCurrentSpeakerDeviceVolume 设置当前扬声器音量

美颜滤镜相关接口函数

API 描述
setBeautyStyle 设置美颜、美白、红润效果级别
setFilter 设置指定素材滤镜特效
setFilterConcentration 设置滤镜浓度
setWatermark 添加水印

辅流相关接口函数(MAC)

API 描述
startRemoteSubStreamView 开始渲染远端用户辅流画面，对应于 startRemoteView() 用于观看远端的主路画面，该接口只能用于观看辅路（屏幕分享、远程播片）画面
stopRemoteSubStreamView 停止渲染远端用户屏幕分享画面
setRemoteSubStreamViewFillMode 设置辅流画面的渲染模式，对应于 setRemoteViewFillMode() 于设置远端的主路画面，该接口用于设置远端的辅路（屏幕分享、远程播片）画面
getScreenCaptureSourcesWithThumbnailSize 【屏幕共享】枚举可用的屏幕分享窗口
selectScreenCaptureTarget 【屏幕共享】设置屏幕共享参数，该方法在屏幕共享过程中也可以调用
startScreenCapture 【屏幕共享】启动屏幕分享
stopScreenCapture 【屏幕共享】停止屏幕采集
pauseScreenCapture 【屏幕共享】暂停屏幕分享
resumeScreenCapture 【屏幕共享】恢复屏幕分享
setSubStreamEncoderParam 设置辅路视频编码器参数，对应于 setVideoEncoderParam() 设置主路画面的编码质量，该设置决定了远端用户看到的画面质量（同时也是云端录制出的视频文件的画面质量）
setSubStreamMixVolume 设置辅流的混音音量大小，这个数值越高，辅流音量占比就越高，麦克风音量占比就越小

自定义采集和渲染

API 描述
enableCustomVideoCapture 启用视频自定义采集模式，即放弃 SDK 原来的视频采集流程，改用 sendCustomVideoData 向 SDK 塞入自己采集的视频画面
sendCustomVideoData 发送自定义的 SampleBuffer
setLocalVideoRenderDelegate 设置本地视频的自定义渲染回调
setRemoteVideoRenderDelegate 设置远端视频的自定义渲染回调
callExperimentalAPI 调用实验性 API 接口

自定义消息发送

API 描述
sendCustomCmdMsg 发送自定义消息给房间内所有用户
sendSEIMsg 发送自定义消息给房间内所有用户

背景混音相关接口函数

API 描述
playBGM 播放背景音乐
stopBGM 停止播放背景音乐
pauseBGM 暂停播放背景音乐
resumeBGM 继续播放背景音乐
getBGMDuration 获取音乐文件总时长，单位毫秒
setBGMPosition 设置 BGM 播放进度
setMicVolumeOnMixing 设置麦克风的音量大小，播放背景音乐混音时使用，用来控制麦克风音量大小
setBGMVolume 设置背景音乐的音量大小，播放背景音乐混音时使用，用来控制背景音音量大小
setReverbType 设置混响效果（目前仅 iOS）
setVoiceChangerType 设置变声类型（目前仅 iOS）

设备和网络测试

API 描述
startSpeedTest 开始进行网络测速（视频通话期间请勿测试，以免影响通话质量）
stopSpeedTest 停止服务器测速
startCameraDeviceTestInView 开始进行摄像头测试
stopCameraDeviceTest 结束视频测试预览
startMicDeviceTest 开始进行麦克风测试 该方法测试麦克风是否能正常工作，volume 的取值范围为0 - 100
stopMicDeviceTest 停止麦克风测试
startSpeakerDeviceTest 开始扬声器测试 该方法播放指定的音频文件测试播放设备是否能正常工作。如果能听到声音，说明播放设备能正常工作。
stopSpeakerDeviceTest 停止扬声器测试

混流转码并发布到 CDN

API 描述
startPublishCDNStream 启动 CDN 发布：通过腾讯云将当前房间的音视频流发布到直播 CDN 上
stopPublishCDNStream 停止 CDN 发布
setMixTranscodingConfig 启动（更新）云端的混流转码：通过腾讯云的转码服务，将房间里的多路画面叠加到一路画面上

LOG相关接口函数

API 描述
getSDKVersion 获取 SDK 版本信息
setLogLevel 设置 log 输出级别
setConsoleEnabled 启用或禁用控制台日志打印
setLogCompressEnabled 启用或禁用 Log 的本地压缩
setLogDirPath 修改日志保存路径
setLogDelegate 设置日志回调
showDebugView 显示仪表盘
setDebugViewMargin 设置仪表盘的边距
属性 类型 描述
delegate id< TRTCCloudDelegate > 设置回调接口 TRTCCloudDelegate，用户获得来自 TRTCCloud 的各种状态通知
delegateQueue dispatch_queue_t 设置驱动回调的队列，默认会采用 Main Queue。 也就是说，如果您不指定 delegateQueue，那么直接在 TRTCCloudDelegate 的回调函数中操作 UI 界面将是安全的

TRTCCloudDelegate @ TXLiteAVSDK

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

TRTCCloudDelegate 是 TRTCCloud 的主要回调接口。

通用事件回调

API 描述
onError 错误回调：SDK 不可恢复的错误，一定要监听，并分情况给用户适当的界面提示
onWarning 警告回调

房间事件回调

API 描述
onEnterRoom 加入房间
onExitRoom 离开房间，离开房间成功的回调
onConnectOtherRoom 跨房连麦成功回调
onDisconnectOtherRoom 断开跨房连麦回调

成员事件回调

API 描述
onUserEnter userid 对应的成员的进房通知，您可以在这个回调中调用 startRemoteView 显示该 userid 的视频画面
onUserExit userid 对应的成员的退房通知，您可以在这个回调中调用 stopRemoteView 关闭该 userid 的视频画面
onUserVideoAvailable userid 对应的远端主路（即摄像头）画面的状态通知
onUserSubStreamAvailable userid 对应的远端辅路（屏幕分享等）画面的状态通知
onUserAudioAvailable userid 对应的远端声音的状态通知
onUserVoiceVolume userid 对应的成员语音音量，通过调用 TRTCCloud enableAudioVolumeEvaluation:smooth: 来开关这个回调

统计和质量回调

API 描述
onNetworkQuality 网络质量：该回调每2秒触发一次，统计当前网络的上行和下行质量。注：userid == nil 代表自己当前的视频质量
onStatistics 技术指标统计回调：如果您是熟悉音视频领域相关术语，可以通过这个回调获取 SDK 的所有技术指标， 如果您是首次开发音视频相关项目，可以只关注 onNetworkQuality 回调

音视频事件回调

API 描述
onFirstVideoFrame 首帧视频画面到达，界面此时可以结束 loading，并开始显示视频画面
onFirstAudioFrame 首帧音频数据到达

服务器事件回调

API 描述
onConnectionLost SDK 跟服务器的连接断开
onTryToReconnect SDK 尝试重新连接到服务器
onConnectionRecovery SDK 跟服务器的连接恢复

硬件设备事件回调

API 描述
onCameraDidReady 摄像头准备就绪
onMicDidReady 麦克风准备就绪
onAudioRouteChanged 音频路由发生变化（仅 iOS），音频路由即声音由哪里输出（扬声器、听筒）
onDevice 本地设备通断回调

自定义消息的接收回调

API 描述
onRecvCustomCmdMsgUserId 当房间中的某个用户使用 sendCustomCmdMsg 发送自定义消息时，房间中的其它用户可以通过 onRecvCustomCmdMsg 接口接收消息
onMissCustomCmdMsgUserId TRTC所使用的传输通道为 UDP 通道，所以即使设置了 reliable，也做不到100不丢失，只是丢消息概率极低，能满足常规可靠性要求。 在过去的一段时间内（通常为5s），自定义消息在传输途中丢失的消息数量的统计，SDK 都会通过此回调通知出来
onRecvSEIMsg 当房间中的某个用户使用 sendSEIMsg 发送数据时，房间中的其它用户可以通过 onRecvSEIMsg 接口接收数据
onScreenCaptureStarted 当屏幕分享开始时，SDK 会通过此回调通知
onScreenCapturePaused 当屏幕分享暂停时，SDK 会通过此回调通知
onScreenCaptureResumed 当屏幕分享开始时，SDK 会通过此回调通知
onScreenCaptureStoped 当屏幕分享开始时，SDK 会通过此回调通知

CDN旁路转推回调

API 描述
onStartPublishCDNStream 旁路推流到 CDN 的回调，对应于 TRTCCloud 的 startPublishCDNStream() 接口
onStopPublishCDNStream

TRTCVideoRenderDelegate

自定义视频渲染回调对象。

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

TRTCLogDelegate

日志事件回调对象。
建议在一个比较早初始化的类中设置回调委托对象，如 AppDelegate。

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

其他 API 对象

TRTCParams

编码参数。
作为 TRTC SDK 的进房参数，只有该参数填写正确，才能顺利进入 roomId 制定的视频房间。

属性 类型 描述
sdkAppId UInt32 应用标识 [必填] 腾讯视频云基于 sdkAppId 完成计费统计
userId NSString * 用户标识 [必填] 当前用户的 userid，相当于用户名
userSig NSString * 用户签名 [必填] 当前 userId 对应的验证签名，相当于登录密码
roomId UInt32 房间号码 [必填] 指定房间号，在同一个房间里的用户（userId）可以彼此看到对方并进行视频通话
privateMapKey NSString * 房间签名 [非必选] 如果您希望某个房间（roomId）只让特定的某些用户（userId）才能进入，就需要使用 privateMapKey 进行权限保护
bussInfo NSString * 业务数据 [非必选] 某些非常用的高级特性才需要用到此字段

TRTCVideoEncParam

属性 类型 描述
videoResolution TRTCVideoResolution 视频分辨率
resMode TRTCVideoResolutionMode 分辨率模式（横屏分辨率 - 竖屏分辨率）
videoFps int 视频采集帧率，推荐设置为15fps或20fps，10fps以下会有明显的卡顿感，20fps以上则没有必要
videoBitrate int 视频上行码率

TRTCNetworkQosParam

属性 类型 描述
preference TRTCVideoQosPreference 弱网下是“保清晰”还是“保流畅”
controlMode TRTCQosControlMode 视频分辨率（云端控制 - 客户端控制）

TRTCVolumeInfo

音量大小。

表示语音音量的评估大小，通过这个数值，您可以在 UI 界面上用图标表征 userId 是否有在说话。

属性 类型 描述
userId NSString * 说话者的 userId，nil 为自己
volume NSUInteger 说话者的音量，取值范围0 - 100

TRTCQualityInfo

音量大小。

表示视频质量的好坏，通过这个数值，您可以在 UI 界面上用图标表征 userId 的通话线路质量。

属性 类型 描述
userId NSString * 用户 ID
quality TRTCQuality 视频质量

TRTCMediaDeviceInfo

属性 类型 描述
type TRTCMediaDeviceType 设备类型
deviceId NSString * 设备 ID
deviceName NSString * 设备名称

TRTCScreenCaptureSourceInfo

属性 类型 描述
type TRTCScreenCaptureSourceType 采集源类型
sourceId NSString * 采集源 ID
sourceName NSString * 采集源名称
extInfo NSDictionary * 采集源属性
thumbnail NSImage * 窗体的缩略图
icon NSImage * 窗体的图标

TRTCSpeedTestResult

网络测速结果。

您可以在用户进入房间前通过 TRTCCloud 的 startSpeedTest 接口进行测速 （注意：请不要在通话中调用）。
测速结果会每2秒 - 3秒返回一次，每次返回一个 ip 地址的测试结果。

属性 类型 描述
ip NSString * 服务器 ip 地址
quality TRTCQuality 网络质量
upLostRate float 上行丢包率，范围是[0,1.0]
downLostRate float 下行丢包率，范围是[0,1.0]
rtt uint32_t 延迟（毫秒）：代表 SDK 跟服务器一来一回之间所消耗的时间，这个值越小越好

TRTCVideoFrame

属性 类型 描述
pixelFormat TRTCVideoPixelFormat 视频像素格式
bufferType TRTCVideoBufferType 视频数据结构类型
textureId int 视频纹理 ID
pixelBuffer CVPixelBufferRef bufferType 为 TRTCVideoBufferType_PixelBuffer 时的视频数据
data NSData * bufferType 为 TRTCVideoBufferType_NSData 时的视频数据
timestamp uint64_t 视频帧的时间戳，单位毫秒
width uint32_t 视频宽度
height uint32_t 视频高度
rotation TRTCVideoRotation 视频像素的顺时针旋转角度

TRTCAudioFrame

属性 类型 描述
data NSData * 音频数据
sampleRate TRTCAudioSampleRate 采样率
channels int 声道数
timestamp uint64_t 时间戳，单位 ms

TRTCPublishCDNParam

旁路推流参数。

属性 类型 描述
appId int 腾讯云 AppID，在【直播控制台-直播码接入】可查询到
bizId int 腾讯云直播 bizid，在【直播控制台-直播码接入】可查询到
url NSString * 旁路转推的 URL

TRTCMixUser

TRTCMixUser 用于指定每一路(即每一个userId)视频画面的具体摆放位置。

属性 类型 描述
userId NSString * 参与混流的 userId
rect CGRect 图层位置坐标以及大小，左上角为坐标原点（0，0） （绝对像素值）
zOrder int 图层层次 （1 - 15） 不可重复
streamType TRTCVideoStreamType 参与混合的是主路画面(TRTCVideoStreamTypeBig)还是屏幕分享(TRTCVideoStreamTypeSub)画面

TRTCTranscodingConfig

TRTCTranscodingConfig 云端转码配置，包括最终编码质量和各路画面的摆放位置。

属性 类型 描述
mode TRTCTranscodingConfigMode 转码 config 模式
appId int 腾讯云 AppID，在直播控制台-直播码接入可查询到
bizId int 腾讯云直播bizid，在直播控制台-直播码接入可查询到
videoWidth int 视频分辨率：宽
videoHeight int 视频分辨率：高
videoBitrate int 视频码率
videoFramerate int 视频帧率
videoGOP int 视频GOP，单位秒
audioSampleRate int 音频采样率 48000
audioBitrate int 音频码率 64K
audioChannels int 声道数 2
mixUsers NSArray< TRTCMixUser * > * 混流配置

TRTCLocalStatistics

自己本地的音视频统计信息。

属性 类型 描述
width uint32_t 视频宽度
height uint32_t 视频高度
frameRate uint32_t 帧率（fps）
videoBitrate uint32_t 视频发送码率（Kbps）
audioSampleRate uint32_t 音频采样率（Hz）
audioBitrate uint32_t 音频发送码率（Kbps）
streamType TRTCVideoStreamType 流类型（大画面 | 小画面 | 辅路画面）

TRTCRemoteStatistics

远端成员的音视频统计信息。

属性 类型 描述
userId NSString * 用户 ID，指定是哪个用户的视频流
finalLoss uint32_t 该线路的总丢包率（%）
width uint32_t 视频宽度
height uint32_t 视频高度
frameRate uint32_t 接收帧率（fps）
videoBitrate uint32_t 视频码率（Kbps）
audioSampleRate uint32_t 音频采样率（Hz）
audioBitrate uint32_t 音频码率（Kbps）
streamType TRTCVideoStreamType 流类型（大画面 | 小画面 | 辅路画面）

TRTCStatistics

统计数据。

属性 类型 描述
upLoss uint32_t C -> S 上行丢包率（%）
downLoss uint32_t S -> C 下行丢包率（%）
appCpu uint32_t 当前 App 的 CPU 使用率 （%）
systemCpu uint32_t 当前系统的 CPU 使用率（%）
rtt uint32_t 延迟（毫秒）：代表 SDK 跟服务器一来一回之间所消耗的时间，这个值越小越好，一般低于50ms的 rtt 是比较理想的情况，而高于100ms的 rtt 会引入较大的通话延时，由于数据上下行共享一条网络连接，所以 local 和 remote 的 rtt 相同
receivedBytes uint64_t 总接收字节数（包含信令及音视频）
sentBytes uint64_t 总发送字节数（包含信令及音视频）
localStatistics NSArray< TRTCLocalStatistics * > * 自己本地的音视频统计信息，由于可能有大画面、小画面以及辅路画面等多路的情况，所以是一个数组
remoteStatistics NSArray< TRTCRemoteStatistics * > * 远端成员的音视频统计信息，由于可能有大画面、小画面以及辅路画面等多路的情况，所以是一个数组

实时音视频 相关文档