TRTCCloud @ TXLiteAVSDK
创建与销毁
| API | 描述 |
|---|---|
| delegate | 设置回调接口 TRTCCloudDelegate。 |
| delegateQueue | 设置驱动 TRTCCloudDelegate 回调的队列。 |
| sharedInstance | 创建 TRTCCloud 单例。 |
| destroySharedIntance | 销毁 TRTCCloud 单例。 |
房间相关接口函数
| API | 描述 |
|---|---|
| enterRoom | 进入房间，若房间不存在，系统将自动创建一个新房间。 |
| exitRoom | 离开房间。 |
| switchRole | 切换角色，仅适用于直播场景（TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom）。 |
| connectOtherRoom | 请求跨房通话（主播 PK）。 |
| disconnectOtherRoom | 退出跨房通话。 |
| setDefaultStreamRecvMode | 设置音视频数据接收模式，需要在进房前设置才能生效。 |
CDN 相关接口函数
| API | 描述 |
|---|---|
| startPublishing | 开始向腾讯云的直播 CDN 推流。 |
| stopPublishing | 停止向腾讯云的直播 CDN 推流。 |
| startPublishCDNStream | 开始向友商云的直播 CDN 转推。 |
| stopPublishCDNStream | 停止向非腾讯云地址转推。 |
| setMixTranscodingConfig | 设置云端的混流转码参数。 |
视频相关接口函数
| 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 | 设定观看方优先选择的视频质量。 |
| snapshotVideo | 视频画面截图。 |
音频相关接口函数
| API | 描述 |
|---|---|
| setAudioQuality | 设置音频质量 主播端的音质越高，观众端的听感越好，但传输所依赖的带宽也就越高，在带宽有限的场景下也更容易出现卡顿。 |
| startLocalAudio | 开启本地音频的采集和上行。 |
| stopLocalAudio | 关闭本地音频的采集和上行。 |
| muteLocalAudio | 静音/取消静音本地的音频。 |
| setAudioRoute | 设置音频路由。 |
| muteRemoteAudio | 静音/取消静音指定的远端用户的声音。 |
| muteAllRemoteAudio | 静音/取消静音所有用户的声音。 |
| setAudioCaptureVolume | 设置 SDK 采集音量。 |
| getAudioCaptureVolume | 获取 SDK 采集音量。 |
| setAudioPlayoutVolume | 设置 SDK 播放音量。 |
| getAudioPlayoutVolume | 获取 SDK 播放音量。 |
| enableAudioVolumeEvaluation | 启用音量大小提示。 |
| startAudioRecording | 开始录音。 |
| stopAudioRecording | 停止录音。 |
| setSystemVolumeType | 设置通话时使用的系统音量类型。 |
摄像头相关接口函数
| 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 | 描述 |
|---|---|
| getBeautyManager | 获取美颜管理对象。 |
| setWatermark | 添加水印。 |
音乐特效和人声特效
| API | 描述 |
|---|---|
| getAudioEffectManager | 获取音效管理类 TXAudioEffectManager。 |
屏幕分享相关接口函数
| API | 描述 |
|---|---|
| startScreenCaptureInApp | 开始应用内的屏幕分享（该接口仅支持 iOS 13.0 及以上的 iPhone 和 iPad）。 |
| startScreenCaptureByReplaykit | 开始全系统的屏幕分享（该接口支持 iOS 11.0 及以上的 iPhone 和 iPad）。 |
| startScreenCapture | 启动屏幕分享（Mac）。 |
| stopScreenCapture | 停止屏幕采集。 |
| pauseScreenCapture | 暂停屏幕分享。 |
| resumeScreenCapture | 恢复屏幕分享。 |
| getScreenCaptureSourcesWithThumbnailSize | 枚举可分享的屏幕窗口，仅支持 Mac OS 平台，建议在 startScreenCapture 之前调用。 |
| selectScreenCaptureTarget | 设置屏幕分享参数，仅支持 Mac OS 平台，该方法在屏幕分享过程中也可以调用。 |
| startRemoteSubStreamView | 开始显示远端用户的辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）。 |
| stopRemoteSubStreamView | 停止显示远端用户的辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）。 |
| setRemoteSubStreamViewFillMode | 设置辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的显示模式。 |
| setRemoteSubStreamViewRotation | 设置辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的顺时针旋转角度。 |
| setSubStreamEncoderParam | 设置屏幕分享的编码器参数，仅适用 Mac 平台。 |
| setSubStreamMixVolume | 设置屏幕分享的混音音量大小，仅适用 Mac 平台。 |
自定义采集和渲染
| API | 描述 |
|---|---|
| enableCustomVideoCapture | 启用视频自定义采集模式。 |
| sendCustomVideoData | 向 SDK 投送自己采集的视频数据。 |
| setLocalVideoRenderDelegate | 设置本地视频的自定义渲染回调。 |
| setRemoteVideoRenderDelegate | 设置远端视频的自定义渲染回调。 |
| enableCustomAudioCapture | 启用音频自定义采集模式。 |
| sendCustomAudioData | 向 SDK 投送自己采集的音频数据。 |
| setAudioFrameDelegate | 设置音频数据回调。 |
自定义消息发送
| API | 描述 |
|---|---|
| sendCustomCmdMsg | 发送自定义消息给房间内所有用户。 |
| sendSEIMsg | 将小数据量的自定义数据嵌入视频帧中。 |
设备和网络测试
| API | 描述 |
|---|---|
| startSpeedTest | 开始进行网络测速（视频通话期间请勿测试，以免影响通话质量）。 |
| stopSpeedTest | 停止服务器测速。 |
| startCameraDeviceTestInView | 开始进行摄像头测试。 |
| stopCameraDeviceTest | 结束视频测试预览。 |
| startMicDeviceTest | 开始进行麦克风测试。 |
| stopMicDeviceTest | 停止麦克风测试。 |
| startSpeakerDeviceTest | 开始扬声器测试。 |
| stopSpeakerDeviceTest | 停止扬声器测试。 |
Log 相关接口函数
| API | 描述 |
|---|---|
| getSDKVersion | 获取 SDK 版本信息。 |
| setLogLevel | 设置 Log 输出级别。 |
| setConsoleEnabled | 启用或禁用控制台日志打印。 |
| setLogCompressEnabled | 启用或禁用 Log 的本地压缩。 |
| setLogDirPath | 修改日志保存路径。 |
| setLogDelegate | 设置日志回调。 |
| showDebugView | 显示仪表盘。 |
| setDebugViewMargin | 设置仪表盘的边距。 |
| callExperimentalAPI | 调用实验性 API 接口。 |
弃用接口函数
| API | 描述 |
|---|---|
| setMicVolumeOnMixing | 设置麦克风的音量大小。 |
| setBeautyStyle | 设置美颜、美白以及红润效果级别。 |
| setEyeScaleLevel | 设置大眼级别，该接口仅在 企业版 SDK 中生效。 |
| setFaceScaleLevel | 设置瘦脸级别，该接口仅在 企业版 SDK 中生效。 |
| setFaceVLevel | 设置 V 脸级别，该接口仅在 企业版 SDK 中生效。 |
| setChinLevel | 设置下巴拉伸或收缩，该接口仅在 企业版 SDK 中生效。 |
| setFaceShortLevel | 设置短脸级别，该接口仅在 企业版 SDK 中生效。 |
| setNoseSlimLevel | 设置瘦鼻级别，该接口仅在 企业版 SDK 中生效。 |
| selectMotionTmpl | 选择使用哪一款 AI 动效挂件，该接口仅在 企业版 SDK 中生效。 |
| setMotionMute | 设置动效静音，该接口仅在 企业版 SDK 中生效。 |
| startScreenCapture | 启动屏幕分享。 |
| setFilter | 设置指定素材滤镜特效。 |
| setFilterConcentration | 设置滤镜浓度。 |
| setGreenScreenFile | 设置绿幕背景视频，该接口仅在 企业版 SDK 中生效。 |
| playBGM | 启动播放背景音乐。 |
| getBGMDuration | 获取音乐文件总时长，单位毫秒。 |
| setBGMPosition | 设置 BGM 播放进度。 |
| setBGMVolume | 设置背景音乐播放音量的大小。 |
| setBGMPlayoutVolume | 设置背景音乐本地播放音量的大小。 |
| setBGMPublishVolume | 设置背景音乐远端播放音量的大小。 |
| setReverbType | 设置混响效果，目前仅支持 iOS。 |
| setVoiceChangerType | 设置变声类型，目前仅支持 iOS。 |
| playAudioEffect | 播放音效。 |
| setAudioEffectVolume | 设置音效音量。 |
| stopAudioEffect | 停止音效。 |
| setAllAudioEffectsVolume | 设置所有音效音量。 |
| pauseAudioEffect | 暂停音效。 |
| resumeAudioEffect | 恢复音效。 |
| enableAudioEarMonitoring | 开启耳返。 |
TRTCCloudDelegate @ TXLiteAVSDK
错误事件和警告事件
| API | 描述 |
|---|---|
| onError | 错误回调，表示 SDK 不可恢复的错误，一定要监听并分情况给用户适当的界面提示。 |
| onWarning | 警告回调，用于告知您一些非严重性问题，例如出现了卡顿或者可恢复的解码失败。 |
房间事件回调
| API | 描述 |
|---|---|
| onEnterRoom | 已加入房间的回调。 |
| onExitRoom | 离开房间的事件回调。 |
| onSwitchRole | 切换角色的事件回调。 |
| onConnectOtherRoom | 请求跨房通话（主播 PK）的结果回调。 |
| onDisconnectOtherRoom | 结束跨房通话（主播 PK）的结果回调。 |
成员事件回调
| API | 描述 |
|---|---|
| onRemoteUserEnterRoom | 有用户加入当前房间。 |
| onRemoteUserLeaveRoom | 有用户离开当前房间。 |
| onUserVideoAvailable | 远端用户是否存在可播放的主路画面（一般用于摄像头）。 |
| onUserSubStreamAvailable | 远端用户是否存在可播放的辅路画面（一般用于屏幕分享）。 |
| onUserAudioAvailable | 远端用户是否存在可播放的音频数据。 |
| onFirstVideoFrame | 开始渲染本地或远程用户的首帧画面。 |
| onFirstAudioFrame | 开始播放远程用户的首帧音频（本地声音暂不通知）。 |
| onSendFirstLocalVideoFrame | 首帧本地视频数据已经被送出。 |
| onSendFirstLocalAudioFrame | 首帧本地音频数据已经被送出。 |
| onUserEnter | 废弃接口：有主播加入当前房间。 |
| onUserExit | 废弃接口：有主播离开当前房间。 |
统计和质量回调
| API | 描述 |
|---|---|
| onNetworkQuality | 网络质量，该回调每2秒触发一次，统计当前网络的上行和下行质量。 |
| onStatistics | 技术指标统计回调。 |
服务器事件回调
| API | 描述 |
|---|---|
| onConnectionLost | SDK 跟服务器的连接断开。 |
| onTryToReconnect | SDK 尝试重新连接到服务器。 |
| onConnectionRecovery | SDK 跟服务器的连接恢复。 |
硬件设备事件回调
| API | 描述 |
|---|---|
| onCameraDidReady | 摄像头准备就绪。 |
| onMicDidReady | 麦克风准备就绪。 |
| onAudioRouteChanged | 音频路由发生变化（仅 iOS），音频路由即声音由哪里输出（扬声器或听筒）。 |
| onUserVoiceVolume | 用于提示音量大小的回调，包括每个 userId 的音量和远端总音量。 |
| onDevice | 本地设备通断回调。 |
自定义消息的接收回调
| API | 描述 |
|---|---|
| onRecvCustomCmdMsgUserId | 收到自定义消息回调。 |
| onMissCustomCmdMsgUserId | 自定义消息丢失回调。 |
| onRecvSEIMsg | 收到 SEI 消息的回调。 |
CDN 旁路转推回调
| API | 描述 |
|---|---|
| onStartPublishing | 开始向腾讯云的直播 CDN 推流的回调，对应于 TRTCCloud 中的 startPublishing() 接口。 |
| onStopPublishing | 停止向腾讯云的直播 CDN 推流的回调，对应于 TRTCCloud 中的 stopPublishing() 接口。 |
| onStartPublishCDNStream | 启动旁路推流到 CDN 完成的回调。 |
| onStopPublishCDNStream | 停止旁路推流到 CDN 完成的回调。 |
| onSetMixTranscodingConfig | 设置云端的混流转码参数的回调，对应于 TRTCCloud 中的 setMixTranscodingConfig() 接口。 |
音效回调
| API | 描述 |
|---|---|
| onAudioEffectFinished | 播放音效结束回调。 |
屏幕分享回调
| API | 描述 |
|---|---|
| onScreenCaptureStarted | 当屏幕分享开始时，SDK 会通过此回调通知。 |
| onScreenCapturePaused | 当屏幕分享暂停时，SDK 会通过此回调通知。 |
| onScreenCaptureResumed | 当屏幕分享恢复时，SDK 会通过此回调通知。 |
| onScreenCaptureStoped | 当屏幕分享停止时，SDK 会通过此回调通知。 |
视频数据帧的自定义处理回调
| API | 描述 |
|---|---|
| onRenderVideoFrame | 自定义视频渲染回调。 |
声音数据帧的自定义处理回调
| API | 描述 |
|---|---|
| onCapturedAudioFrame | 本地麦克风采集到的音频数据回调。 |
| onPlayAudioFrame | 混音前的每一路远程用户的音频数据，即混音前的各路原始数据。例如，对某一路音频进行文字转换时，您必须使用该路音频的原始数据。 |
| onMixedPlayAudioFrame | 各路音频数据混合后的音频数据。 |
日志相关回调
说明：建议在比较早初始化的类中设置回调委托对象，例如 AppDelegate。
| API | 描述 |
|---|---|
| onLog | 有日志打印时的回调。 |
关键类型定义
| 类名 | 描述 |
|---|---|
| TRTCParams | 进房相关参数。 |
| TRTCVideoEncParam | 视频编码参数。 |
| TRTCNetworkQosParam | 网络流控相关参数。 |
| TRTCQualityInfo | 视频质量。 |
| TRTCVolumeInfo | 音量大小。 |
| TRTCMediaDeviceInfo | 媒体设备描述。 |
| TRTCScreenCaptureSourceInfo | 屏幕分享目标信息（仅 Mac）。 |
| TRTCSpeedTestResult | 网络测速结果。 |
| TRTCVideoFrame | 视频帧信息。 |
| TRTCAudioFrame | 音频帧数据。 |
| TRTCMixUser | 云端混流中每一路子画面的位置信息。 |
| TRTCTranscodingConfig | 云端混流（转码）配置。 |
| TRTCPublishCDNParam | CDN 旁路推流参数。 |
| TRTCAudioRecordingParams | 录音参数。 |
| TRTCAudioEffectParam | 音效。 |
| TRTCLocalStatistics | 自己本地的音视频统计信息。 |
| TRTCRemoteStatistics | 远端成员的音视频统计信息。 |
| TRTCStatistics | 统计数据。 |
枚举值
| 枚举 | 描述 |
|---|---|
| TRTCVideoResolution | 视频分辨率。 |
| TRTCVideoResolutionMode | 视频宽高比模式。 |
| TRTCVideoStreamType | 视频流类型。 |
| TRTCQuality | 画质级别。 |
| TRTCVideoFillMode | 视频画面填充模式。 |
| TRTCVideoRotation | 视频画面旋转方向。 |
| TRTCBeautyStyle | 美颜（磨皮）算法。 |
| TRTCVideoPixelFormat | 视频像素格式。 |
| TRTCVideoBufferType | 视频数据包装格式。 |
| TRTCLocalVideoMirrorType | 本地视频预览镜像类型。 |
| TRTCAppScene | 应用场景。 |
| TRTCRoleType | 角色，仅适用于直播场景（TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom）。 |
| TRTCQosControlMode | 流控模式。 |
| TRTCVideoQosPreference | 画质偏好。 |
| TRTCAudioSampleRate | 音频采样率。 |
| TRTCAudioQuality | 声音音质。 |
| TRTCAudioRoute | 声音播放模式（音频路由）。 |
| TRTCReverbType | 声音混响模式。 |
| TRTCVoiceChangerType | 变声模式。 |
| TRTCSystemVolumeType | 系统音量类型。 |
| TRTCLogLevel | Log 级别。 |
| TRTCGSensorMode | 重力感应开关。 |
| TRTCMediaDeviceType | 设备类型（仅 Mac）。 |
| TRTCScreenCaptureSourceType | 屏幕分享目标类型（仅 Mac）。 |
| TRTCTranscodingConfigMode | 混流参数配置模式。 |