TRTC SDK Uni-APP API 概览

TRTCCloud

基础方法

API	描述
createInstance	创建 TrtcCloud 单例。
destroyInstance	销毁 TrtcCloud 单例。
on	设置 TrtcCloud 事件监听。
off	移除 TrtcCloud 事件监听。

房间相关接口函数

API	描述
enterRoom	进入房间。
exitRoom	离开房间。
switchRole	切换角色，仅适用于直播场景（TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom）。

视频相关接口函数

API	描述
startLocalPreview	开启本地视频的预览画面。
stopLocalPreview	停止本地视频采集及预览。
muteLocalVideo	暂停/恢复推送本地的视频数据。
startRemoteView	开始显示远端视频画面。
stopRemoteView	停止显示远端视频画面，同时不再拉取该远端用户的视频数据流。
setLocalRenderParams	设置本地图像的渲染模式。
setRemoteRenderParams	设置远端图像相关参数。
snapshotVideo	视频画面截图。

音频相关接口函数

API	描述
startLocalAudio	开启本地音频的采集和上行。
stopLocalAudio	关闭本地音频的采集和上行。
muteLocalAudio	静音/取消静音本地的音频。
setAudioRoute	设置音频路由。
muteRemoteAudio	静音/取消静音指定的远端用户的声音。
muteAllRemoteAudio	静音/取消静音所有用户的声音。
enableAudioVolumeEvaluation	启用音量大小提示。

美颜滤镜相关接口函数

API	描述
setBeautyLevel	设置美颜级别。
setBeautyStyle	设置美颜（磨皮）算法 TRTC 内置多种不同的磨皮算法，您可以选择最适合您产品定位的方案。

背景音效相关接口函数

API	描述
startPlayMusic	开始播放背景音乐 每个音乐都需要您指定具体的 ID，您可以通过该 ID 对音乐的开始、停止、音量等进行设置。
stopPlayMusic	停止播放背景音乐。
pausePlayMusic	暂停播放背景音乐。
resumePlayMusic	恢复播放背景音乐。

辅流相关接口函数

API	描述
startScreenCapture	启动屏幕分享。
stopScreenCapture	停止屏幕采集。
pauseScreenCapture	暂停屏幕分享。
resumeScreenCapture	恢复屏幕分享。

TRTCCloudListener

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

错误事件和警告事件

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

房间事件回调

API	描述
onEnterRoom	已加入房间的回调。
onExitRoom	离开房间的事件回调。
onSwitchRole	切换角色的事件回调。

成员事件回调

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

硬件设备事件回调

API	描述
onUserVoiceVolume	用于提示音量大小的回调，包括每个 userId 的音量和远端总音量。

屏幕分享回调

API	描述
onScreenCaptureStarted	当屏幕分享开始时，SDK 会通过此回调通知
onScreenCapturePaused	当屏幕分享调用 pauseScreenCapture() 暂停时，SDK 会通过此回调通知。
onScreenCaptureResumed	当屏幕分享调用 resumeScreenCapture() 恢复时，SDK 会通过此回调通知。
onScreenCaptureStopped	当屏幕分享停止时，SDK 会通过此回调通知。

截图回调

API	描述
onSnapshotComplete	截图完成时回调。

背景音效回调

API	描述
onStart	背景音乐开始播放。
onPlayProgress	背景音乐的播放进度。
onComplete	背景音乐已经播放完毕。

关键类型定义

类名	描述
TRTCParams	进房参数。
TRTCVideoEncParam	视频编码参数。
TRTCRenderParams	远端图像参数。