文档中心 实时音视频 客户端 API iOS&Mac 概览

概览

最近更新时间：2019-08-06 20:14:53

编辑 查看pdf

在这篇文章中：

TRTCCloud @ TXLiteAVSDK

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

创建与销毁

API 描述
delegate 设置回调接口 TRTCCloudDelegate。
delegateQueue 设置驱动 TRTCCloudDelegate 回调的队列。
sharedInstance 创建 TRTCCloud 单例。
destroySharedIntance 销毁 TRTCCloud 单例。

房间相关接口函数

API 描述
enterRoom 进入房间。
exitRoom 离开房间。
switchRole 切换角色，仅适用于直播场景（TRTCAppSceneLIVE）。
connectOtherRoom 请求跨房通话（主播 PK）。
disconnectOtherRoom 退出跨房通话。

视频相关接口函数

API 描述
startLocalPreview 开启本地视频的预览画面 (iOS 版本)。
startLocalPreview 开启本地视频的预览画面 (Mac 版本)。
stopLocalPreview 停止本地视频采集及预览。
muteLocalVideo 是否屏蔽自己的视频画面。
startRemoteView 开始显示远端视频画面。
stopRemoteView 停止显示远端视频画面。
stopAllRemoteView 停止显示所有远端视频画面。
muteRemoteVideoStream 暂停接收指定的远端视频流。
muteAllRemoteVideoStreams 停止接收所有远端视频流。
setVideoEncoderParam 设置视频编码器相关参数。
setNetworkQosParam 设置网络流控相关参数。
setLocalViewFillMode 设置本地图像的渲染模式。
setRemoteViewFillMode 设置远端图像的渲染模式。
setLocalViewRotation 设置本地图像的顺时针旋转角度。
setRemoteViewRotation 设置远端图像的顺时针旋转角度。
setVideoEncoderRotation 设置视频编码输出的（也就是远端用户观看到的，以及服务器录制下来的）画面方向。
setLocalViewMirror 设置本地摄像头预览画面的镜像模式（iOS）。
setLocalViewMirror 设置本地摄像头预览画面的镜像模式（Mac）。
setVideoEncoderMirror 设置编码器输出的画面镜像模式。
setGSensorMode 设置重力感应的适应模式。
enableEncSmallVideoStream 开启大小画面双路编码模式。
setRemoteVideoStreamType 选定观看指定 uid 的大画面还是小画面。
setPriorRemoteVideoStreamType 设定观看方优先选择的视频质量。

音频相关接口函数

API 描述
startLocalAudio 开启本地音频的采集和上行。
stopLocalAudio 关闭本地音频的采集和上行。
muteLocalAudio 静音本地的音频。
setAudioRoute 设置音频路由。
muteRemoteAudio 静音掉某一个用户的声音。
muteAllRemoteAudio 静音掉所有用户的声音。
enableAudioVolumeEvaluation 启用音量大小提示。
startAudioRecording 开始录音。
stopAudioRecording 停止录音。

摄像头相关接口函数

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 添加水印。
setEyeScaleLevel 设置大眼级别（商用企业版有效，其它版本设置此参数无效）。
setFaceScaleLevel 设置瘦脸级别（商用企业版有效，其它版本设置此参数无效）。
setFaceVLevel 设置V脸级别（商用企业版有效，其它版本设置此参数无效）。
setChinLevel 设置下巴拉伸或收缩（商用企业版有效，其它版本设置此参数无效）。
setFaceShortLevel 设置短脸级别（商用企业版有效，其它版本设置此参数无效）。
setNoseSlimLevel 设置瘦鼻级别（商用企业版有效，其它版本设置此参数无效）。
setGreenScreenFile 设置绿幕背景视频（商用企业版有效，其它版本设置此参数无效）。
selectMotionTmpl 选择使用哪一款 AI 动效挂件（商用企业版有效，其它版本设置此参数无效）。
setMotionMute 设置动效静音（商用企业版有效，其它版本设置此参数无效）。

辅流相关接口函数(MAC)

API 描述
startRemoteSubStreamView 开始显示远端用户的屏幕分享画面。
stopRemoteSubStreamView 停止显示远端用户的屏幕分享画面。
setRemoteSubStreamViewFillMode 设置屏幕分享画面的显示模式。
getScreenCaptureSourcesWithThumbnailSize 枚举可分享的屏幕窗口。
selectScreenCaptureTarget 设置屏幕共享参数，该方法在屏幕共享过程中也可以调用。
startScreenCapture 启动屏幕分享。
stopScreenCapture 停止屏幕采集。
pauseScreenCapture 暂停屏幕分享。
resumeScreenCapture 恢复屏幕分享。
setSubStreamEncoderParam 设置屏幕分享的编码器参数。
setSubStreamMixVolume 设置屏幕分享的混音音量大小。

自定义采集和渲染

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

自定义消息发送

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

背景混音相关接口函数

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

设备和网络测试

API 描述
startSpeedTest 开始进行网络测速（视频通话期间请勿测试，以免影响通话质量）。
stopSpeedTest 停止服务器测速。
startCameraDeviceTestInView 开始进行摄像头测试。
stopCameraDeviceTest 结束视频测试预览。
startMicDeviceTest 开始进行麦克风测试。
stopMicDeviceTest 停止麦克风测试。
startSpeakerDeviceTest 开始扬声器测试。
stopSpeakerDeviceTest 停止扬声器测试。

混流转码以及 CDN 旁路推流

API 描述
setMixTranscodingConfig 设置云端的混流转码参数。
startPublishCDNStream 旁路转推到指定的推流地址。
stopPublishCDNStream 停止旁路推流。

Log 相关接口函数

API 描述
getSDKVersion 获取 SDK 版本信息。
setLogLevel 设置 Log 输出级别。
setConsoleEnabled 启用或禁用控制台日志打印。
setLogCompressEnabled 启用或禁用 Log 的本地压缩。
setLogDirPath 修改日志保存路径。
setLogDelegate 设置日志回调。
showDebugView 显示仪表盘。
setDebugViewMargin 设置仪表盘的边距。
callExperimentalAPI 调用实验性 API 接口。

TRTCCloudDelegate @ TXLiteAVSDK

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

错误事件和警告事件

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

房间事件回调

API 描述
onEnterRoom 已加入房间的回调。
onExitRoom 离开房间的事件回调。
onSwitchRole 切换角色的事件回调。
onConnectOtherRoom 请求跨房通话（主播 PK）的结果回调。
onDisconnectOtherRoom 结束跨房通话（主播 PK）的结果回调。

成员事件回调

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

统计和质量回调

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

服务器事件回调

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

硬件设备事件回调

API 描述
onCameraDidReady 摄像头准备就绪。
onMicDidReady 麦克风准备就绪。
onAudioRouteChanged 音频路由发生变化（仅 iOS），音频路由即声音由哪里输出（扬声器、听筒）。
onUserVoiceVolume 用于提示音量大小的回调,包括每个 userId 的音量和远端总音量。
onDevice 本地设备通断回调。

自定义消息的接收回调

API 描述
onRecvCustomCmdMsgUserId 收到自定义消息回调。
onMissCustomCmdMsgUserId 自定义消息丢失回调。
onRecvSEIMsg 收到 SEI 消息的回调。
onScreenCaptureStarted 当屏幕分享开始时，SDK 会通过此回调通知。
onScreenCapturePaused 当屏幕分享暂停时，SDK 会通过此回调通知。
onScreenCaptureResumed 当屏幕分享恢复时，SDK 会通过此回调通知。
onScreenCaptureStoped 当屏幕分享停止时，SDK 会通过此回调通知。

CDN 旁路转推回调

API 描述
onStartPublishCDNStream 启动旁路推流到 CDN 完成的回调。
onStopPublishCDNStream 停止旁路推流到 CDN 完成的回调。
onSetMixTranscodingConfig 设置云端的混流转码参数的回调，对应于 TRTCCloud 中的 setMixTranscodingConfig() 接口。

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

跳转到 TRTCVideoRenderDelegate

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

声音数据帧的自定义处理回调（只读）

跳转到 TRTCAudioFrameDelegate

API 描述
onCapturedAudioFrame 本地麦克风采集到的音频数据回调。
onPlayAudioFrame 混音前的每一路远程用户的音频数据（例如您要对某一路的语音进行文字转换，必须要使用这里的原始数据，而不是混音之后的数据）。
onMixedPlayAudioFrame 各路音频数据混合后送入喇叭播放的音频数据。

日志相关回调

跳转到 TRTCLogDelegate

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

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

关键类型定义

枚举 描述
TRTCParams 进房相关参数。
TRTCVideoEncParam 视频编码参数。
TRTCNetworkQosParam 网络流控相关参数。
TRTCQualityInfo 视频质量。
TRTCVolumeInfo 音量大小。
TRTCMediaDeviceInfo 媒体设备描述。
TRTCScreenCaptureSourceInfo 屏幕分享目标信息（仅 Mac）。
TRTCSpeedTestResult 网络测速结果。
TRTCVideoFrame 视频帧信息。
TRTCAudioFrame 音频帧数据。
TRTCMixUser 云端混流中每一路子画面的位置信息。
TRTCTranscodingConfig 云端混流（转码）配置。
TRTCPublishCDNParam CDN 旁路推流参数。
TRTCAudioRecordingParams 录音参数。
TRTCLocalStatistics 自己本地的音视频统计信息。
TRTCRemoteStatistics 远端成员的音视频统计信息。
TRTCStatistics 统计数据。

枚举值

枚举 描述
TRTCVideoResolution 视频分辨率。
TRTCVideoResolutionMode 视频宽高比模式。
TRTCVideoStreamType 视频流类型。
TRTCQuality 画质级别。
TRTCVideoFillMode 视频画面填充模式。
TRTCVideoRotation 视频画面旋转方向。
TRTCBeautyStyle 美颜（磨皮）算法。
TRTCVideoPixelFormat 视频像素格式。
TRTCVideoBufferType 视频数据包装格式。
TRTCLocalVideoMirrorType 本地视频预览镜像类型。
TRTCAppScene 应用场景。
TRTCRoleType 角色，仅适用于直播场景（TRTCAppSceneLIVE）。
TRTCQosControlMode 流控模式。
TRTCVideoQosPreference 画质偏好。
TRTCAudioSampleRate 音频采样率。
TRTCAudioRoute 声音播放模式（音频路由）。
TRTCReverbType 声音混响模式。
TRTCVoiceChangerType 变声模式。
TRTCLogLevel Log 级别。
TRTCGSensorMode 重力感应开关。
TRTCMediaDeviceType 设备类型（仅 Mac）。
TRTCScreenCaptureSourceType 屏幕分享目标类型（仅 Mac）。
TRTCTranscodingConfigMode 混流参数配置模式。

实时音视频 相关文档