TRTCCloud
基础方法
| sharedInstance |
创建 TRTCCloud 单例。 |
| destroySharedInstance |
销毁 TRTCCloud单例。 |
| registerListener |
设置事件监听。 |
| unRegisterListener |
移除事件监听。 |
房间相关接口函数
| enterRoom |
进入房间，若房间不存在，系统将自动创建一个新房间。 |
| exitRoom |
离开房间。 |
| switchRole |
切换角色，仅适用于直播场景（TRTC_APP_SCENE_LIVE 和 TRTC_APP_SCENE_VOICE_CHATROOM）。 |
| setDefaultStreamRecvMode |
设置音视频数据接收模式，需要在进房前设置才能生效。 |
| connectOtherRoom |
请求跨房通话（主播 PK）。 |
| disconnectOtherRoom |
退出跨房通话。 |
| switchRoom |
切换房间。 |
CDN 相关接口函数
| startPublishing |
开始向腾讯云的直播 CDN 推流。 |
| stopPublishing |
停止向腾讯云的直播 CDN 推流。 |
| startPublishCDNStream |
开始向友商云的直播 CDN 转推。 |
| stopPublishCDNStream |
停止向非腾讯云地址转推。 |
| setMixTranscodingConfig |
设置云端的混流转码参数。 |
视频相关接口函数
| startLocalPreview |
开启本地视频的预览画面。 |
| stopLocalPreview |
停止本地视频采集及预览。 |
| muteLocalVideo |
暂停/恢复推送本地的视频数据。 |
| startRemoteView |
开始显示远端视频画面。 |
| stopRemoteView |
停止显示远端视频画面，同时不再拉取该远端用户的视频数据流。 |
| stopAllRemoteView |
停止显示所有远端视频画面，同时不再拉取远端用户的视频数据流。 |
| muteRemoteVideoStream |
暂停/恢复接收指定的远端视频流。 |
| muteAllRemoteVideoStreams |
暂停/恢复接收所有远端视频流。 |
| setVideoEncoderParam |
设置视频编码器相关参数。 |
| setNetworkQosParam |
设置网络流控相关参数。 |
| setLocalRenderParams |
设置本地图像的渲染模式。 |
| setRemoteRenderParams |
设置远端图像相关参数。 |
| setVideoEncoderRotation |
设置视频编码输出的画面方向，即设置远端用户观看到的和服务器录制的画面方向。 |
| setVideoEncoderMirror |
设置编码器输出的画面镜像模式。 |
| setGSensorMode |
设置重力感应的适应模式。 |
| enableEncSmallVideoStream |
开启大小画面双路编码模式。 |
| setRemoteVideoStreamType |
选定观看指定 uid 的大画面或小画面。 |
| snapshotVideo |
视频画面截图。 |
音频相关接口函数
| startLocalAudio |
开启本地音频的采集和上行。 |
| stopLocalAudio |
关闭本地音频的采集和上行。 |
| muteLocalAudio |
静音/取消静音本地的音频。 |
| setVideoMuteImage |
设置暂停推送本地视频时要推送的图片。 |
| setAudioRoute |
设置音频路由。 |
| muteRemoteAudio |
静音/取消静音指定的远端用户的声音。 |
| muteAllRemoteAudio |
静音/取消静音所有用户的声音。 |
| setAudioCaptureVolume |
设置 SDK 采集音量。 |
| getAudioCaptureVolume |
获取 SDK 采集音量。 |
| setAudioPlayoutVolume |
设置 SDK 播放音量。 |
| getAudioPlayoutVolume |
获取 SDK 播放音量。 |
| enableAudioVolumeEvaluation |
启用音量大小提示。 |
| startAudioRecording |
开始录音。 |
| stopAudioRecording |
停止录音。 |
| setSystemVolumeType |
设置通话时使用的系统音量类型。 |
设备管理接口
| getDeviceManager |
获取设备管理模块，接口详情见 设备管理接口 文档。 |
美颜滤镜相关接口函数
| getBeautyManager |
获取美颜管理对象，接口详情见 美颜管理 文档。 |
| setWatermark |
添加水印。 |
音乐特效和人声特效
| getAudioEffectManager |
获取音效管理类 TXAudioEffectManager，用于管理 BGM，短音效和人声特效，接口详情见 音效管理 文档。 |
辅流相关接口函数
| startScreenCapture |
启动屏幕分享。 |
| stopScreenCapture |
停止屏幕采集。 |
| pauseScreenCapture |
暂停屏幕分享。 |
| resumeScreenCapture |
恢复屏幕分享。 |
自定义消息发送
| sendCustomCmdMsg |
发送自定义消息给房间内所有用户。 |
| sendSEIMsg |
将小数据量的自定义数据嵌入视频帧中。 |
网络测试
| startSpeedTest |
开始进行网络测速（视频通话期间请勿测试，以免影响通话质量）。 |
| stopSpeedTest |
停止服务器测速。 |
Log 相关接口函数
| getSDKVersion |
获取 SDK 版本信息。 |
| setLogLevel |
设置 Log 输出级别。 |
| setLogDirPath |
修改日志保存路径。 |
| setLogCompressEnabled |
启用或禁用 Log 的本地压缩。 |
| setConsoleEnabled |
启用或禁用控制台日志打印。 |
TRTCCloudListener
腾讯云视频通话功能的事件回调接口。
错误事件和警告事件
| onError |
错误回调，表示 SDK 不可恢复的错误，一定要监听并分情况给用户适当的界面提示。 |
| onWarning |
警告回调，用于告知您一些非严重性问题，例如出现卡顿或者可恢复的解码失败。 |
房间事件回调
| onEnterRoom |
已加入房间的回调。 |
| onExitRoom |
离开房间的事件回调。 |
| onSwitchRole |
切换角色的事件回调。 |
| onConnectOtherRoom |
请求跨房通话（主播 PK）的结果回调。 |
| onDisConnectOtherRoom |
结束跨房通话（主播 PK）的结果回调。 |
| onSwitchRoom |
切换房间 (switchRoom) 的结果回调。 |
成员事件回调
| onRemoteUserEnterRoom |
有用户加入当前房间。 |
| onRemoteUserLeaveRoom |
有用户离开当前房间。 |
| onUserVideoAvailable |
远端用户是否存在可播放的主路画面（一般用于摄像头）。 |
| onUserSubStreamAvailable |
远端用户是否存在可播放的辅路画面（一般用于屏幕分享）。 |
| onUserAudioAvailable |
远端用户是否存在可播放的音频数据。 |
| onFirstVideoFrame |
开始渲染本地或远程用户的首帧画面。 |
| onFirstAudioFrame |
开始播放远程用户的首帧音频（本地声音暂不通知）。 |
| onSendFirstLocalVideoFrame |
首帧本地视频数据已经被送出。 |
| onSendFirstLocalAudioFrame |
首帧本地音频数据已经被送出。 |
播放背景音乐的回调接口
播放背景音乐的回调接口。
| onMusicObserverStart |
音乐播放开始的回调通知。 |
| onMusicObserverPlayProgress |
音乐播放进度的回调通知。 |
| onMusicObserverComplete |
音乐播放结束的回调通知。 |
统计和质量回调
| onNetworkQuality |
网络质量，该回调每2秒触发一次，统计当前网络的上行和下行质量。 |
| onStatistics |
技术指标统计回调。 |
服务器事件回调
| onConnectionLost |
SDK 跟服务器的连接断开。 |
| onTryToReconnect |
SDK 尝试重新连接到服务器。 |
| onConnectionRecovery |
SDK 跟服务器的连接恢复。 |
| onSpeedTest |
服务器测速的回调，SDK 对多个服务器 IP 做测速，每个 IP 的测速结果通过这个回调通知。 |
硬件设备事件回调
| onCameraDidReady |
摄像头准备就绪。 |
| onMicDidReady |
麦克风准备就绪。 |
| onUserVoiceVolume |
用于提示音量大小的回调，包括每个 userId 的音量和远端总音量。 |
自定义消息的接收回调
| onRecvCustomCmdMsg |
收到自定义消息回调。 |
| onMissCustomCmdMsg |
自定义消息丢失回调。 |
| onRecvSEIMsg |
收到 SEI 消息的回调。 |
CDN 旁路转推回调
| onStartPublishing |
开始向腾讯云的直播 CDN 推流的回调，对应于 TRTCCloud 中的 startPublishing() 接口。 |
| onStopPublishing |
停止向腾讯云的直播 CDN 推流的回调，对应于 TRTCCloud 中的 stopPublishing() 接口。 |
| onStartPublishCDNStream |
启动旁路推流到 CDN 完成的回调。 |
| onStopPublishCDNStream |
停止旁路推流到 CDN 完成的回调。 |
| onSetMixTranscodingConfig |
设置云端的混流转码参数的回调，对应于 TRTCCloud 中的 setMixTranscodingConfig() 接口。 |
屏幕分享回调
| onScreenCaptureStarted |
当屏幕分享开始时，SDK 会通过此回调通知 |
| onScreenCapturePaused |
当屏幕分享调用 pauseScreenCapture() 暂停时，SDK 会通过此回调通知。 |
| onScreenCaptureResumed |
当屏幕分享调用 resumeScreenCapture() 恢复时，SDK 会通过此回调通知。 |
| onScreenCaptureStoped |
当屏幕分享停止时，SDK 会通过此回调通知。 |
截图回调
| onSnapshotComplete |
截图完成时回调。 |
关键类型定义
| TRTCCloudDef |
关键类型定义变量。 |
| TRTCParams |
进房参数。 |
| TRTCSwitchRoomConfig |
切换房间参数参数。 |
| TRTCVideoEncParam |
视频编码参数。 |
| TRTCNetworkQosParam |
网络流控相关参数。 |
| TRTCRenderParams |
远端图像参数。 |
| TRTCMixUser |
云端混流中每一路子画面的位置信息。 |
| TRTCTranscodingConfig |
云端混流（转码）配置。 |
| TXVoiceChangerType |
变声类型定义（萝莉、大叔、重金属、外国人等）。 |
| TXVoiceReverbType |
变声类型定义（KTV、小房间、大会堂、低沉、洪亮等）。 |
| AudioMusicParam |
音乐和人声设置接口参数。 |
| TRTCAudioRecordingParams |
录音参数。 |
| TRTCPublishCDNParam |
CDN 转推参数。 |
对音视频的解决方案有疑惑？想了解解决方案收费？ 联系解决方案专家
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心，购买腾讯云享受折上折，更有现金返利:同意关联，立享优惠
阿里云解决方案也看看？： 点击对比阿里云的解决方案
暂无评论，你要说点什么吗？