ITRTCCloud @ TXLiteAVSDK
创建与销毁 ITRTCCloud 单例
| getTRTCShareInstance |
获取 ITRTCCloud 单例对象。 |
| destroyTRTCShareInstance |
释放 ITRTCCloud 单例对象。 |
设置 TRTCCloudCallback 回调
| addCallback |
设置回调接口 ITRTCCloudCallback。 |
| removeCallback |
移除事件回调。 |
房间相关接口函数
| enterRoom |
进入房间。 |
| exitRoom |
离开房间。 |
| switchRole |
切换角色，仅适用于直播场景（TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom）。 |
| connectOtherRoom |
请求跨房通话（主播 PK）。 |
| disconnectOtherRoom |
关闭跨房连麦。 |
| setDefaultStreamRecvMode |
设置音视频数据接收模式（需要在进房前设置才能生效）。 |
| switchRoom |
切换房间。 |
CDN 相关接口函数
| startPublishing |
开始向腾讯云的直播 CDN 推流。 |
| stopPublishing |
停止向腾讯云的直播 CDN 推流。 |
| startPublishCDNStream |
开始向友商云的直播 CDN 转推。 |
| stopPublishCDNStream |
停止向非腾讯云地址转推。 |
| setMixTranscodingConfig |
设置云端的混流转码参数。 |
视频相关接口函数
| startLocalPreview |
开启本地视频的预览画面。 |
| updateLocalView |
更新本地视频预览画面的窗口。 |
| stopLocalPreview |
停止本地视频采集及预览。 |
| muteLocalVideo |
暂停/恢复推送本地的视频数据。 |
| startRemoteView |
开始拉取并显示指定用户的远端画面。 |
| updateRemoteView |
更新远端视频渲染的窗口。 |
| stopRemoteView |
停止显示远端视频画面，同时不再拉取远端用户的视频数据流。 |
| stopAllRemoteView |
停止显示所有远端视频画面，同时不再拉取远端用户的视频数据流。 |
| muteRemoteVideoStream |
暂停/恢复接收指定的远端视频流。 |
| muteAllRemoteVideoStreams |
暂停/恢复接收所有远端视频流。 |
| setVideoEncoderParam |
设置视频编码器相关参数。 |
| setNetworkQosParam |
设置网络流控相关参数。 |
| setLocalRenderParams |
设置本地图像（主流）的渲染参数。 |
| setVideoEncoderRotation |
设置视频编码输出的画面方向，即设置远端用户观看到的和服务器录制的画面方向。 |
| setVideoEncoderMirror |
设置编码器输出的画面镜像模式。 |
| setRemoteRenderParams |
设置远端图像的渲染模式。 |
| enableSmallVideoStream |
开启大小画面双路编码模式。 |
| setRemoteVideoStreamType |
选定观看指定 userId 的大画面还是小画面。 |
音频相关接口函数
| startLocalAudio |
开启本地音频的采集和上行。 |
| stopLocalAudio |
关闭本地音频的采集和上行。 |
| muteLocalAudio |
静音/取消静音本地的音频。 |
| muteRemoteAudio |
静音/取消静音指定的远端用户的声音。 |
| muteAllRemoteAudio |
静音/取消静音所有用户的声音。 |
| setAudioCaptureVolume |
设置 SDK 采集音量。 |
| getAudioCaptureVolume |
获取 SDK 采集音量。 |
| setAudioPlayoutVolume |
设置 SDK 播放音量。 |
| getAudioPlayoutVolume |
获取 SDK 播放音量。 |
| enableAudioVolumeEvaluation |
启用或关闭音量大小提示。 |
| startAudioRecording |
开始录音。 |
| stopAudioRecording |
停止录音。 |
设备相关接口函数
| getDeviceManager |
获取设备管理模块。 |
美颜特效和图像水印
| setBeautyStyle |
设置美颜、美白、红润效果级别。 |
| setWaterMark |
设置水印。 |
音乐特效和人声特效
| getAudioEffectManager |
获取音效管理类 ITXAudioEffectManager。 |
| startSystemAudioLoopback |
打开系统声音采集。 |
| stopSystemAudioLoopback |
关闭系统声音采集。 |
| setSystemAudioLoopbackVolume |
设置系统声音采集的音量。 |
屏幕分享相关接口函数
| startScreenCapture |
启动屏幕分享。 |
| stopScreenCapture |
停止屏幕采集。 |
| pauseScreenCapture |
暂停屏幕分享。 |
| resumeScreenCapture |
恢复屏幕分享。 |
| getScreenCaptureSources |
枚举可分享的屏幕窗口，建议在 startScreenCapture 之前调用。 |
| selectScreenCaptureTarget |
设置屏幕共享参数，该方法在屏幕共享过程中也可以调用。 |
| setSubStreamEncoderParam |
设置屏幕分享的编码器参数。 |
| setSubStreamMixVolume |
设置屏幕分享的混音音量大小。 |
| addExcludedShareWindow |
将指定窗口加入屏幕分享的排除列表中，加入排除列表中的窗口不会被分享出去。 |
| removeExcludedShareWindow |
将指定窗口从屏幕分享的排除列表中移除。 |
| removeAllExcludedShareWindow |
将所有窗口从屏幕分享的排除列表中移除。 |
自定义采集和渲染
| enableCustomVideoCapture |
启用视频自定义采集模式。 |
| sendCustomVideoData |
向 SDK 投送自己采集的视频数据。 |
| enableCustomAudioCapture |
启用音频自定义采集模式。 |
| sendCustomAudioData |
向 SDK 投送自己采集的音频数据。 |
| setLocalVideoRenderCallback |
设置本地视频自定义渲染。 |
| setRemoteVideoRenderCallback |
设置远端视频自定义渲染。 |
| setAudioFrameCallback |
设置音频数据回调。 |
自定义消息发送
| sendCustomCmdMsg |
发送自定义消息给房间内所有用户。 |
| sendSEIMsg |
将小数据量的自定义数据嵌入视频帧中。 |
网络测试
| startSpeedTest |
开始进行网络测速（视频通话期间请勿测试，以免影响通话质量）。 |
| stopSpeedTest |
停止网络测速。 |
LOG 相关接口函数
| getSDKVersion |
获取 SDK 版本信息。 |
| setLogLevel |
设置 Log 输出级别。 |
| setConsoleEnabled |
启用或禁用控制台日志打印。 |
| setLogCompressEnabled |
启用或禁用 Log 的本地压缩。 |
| setLogDirPath |
设置日志保存路径。 |
| setLogCallback |
设置日志回调。 |
| showDebugView |
显示仪表盘。 |
| callExperimentalAPI |
调用实验性 API 接口。 |
弃用接口函数
| setMicVolumeOnMixing |
设置麦克风的音量大小。 |
| startScreenCapture |
启动屏幕分享。 |
| playBGM |
启动播放背景音乐。 |
| stopBGM |
停止播放背景音乐。 |
| pauseBGM |
暂停播放背景音乐。 |
| resumeBGM |
继续播放背景音乐。 |
| getBGMDuration |
获取音乐文件总时长，单位毫秒。 |
| setBGMPosition |
设置 BGM 播放进度。 |
| setBGMVolume |
设置背景音乐播放音量的大小。 |
| setBGMPlayoutVolume |
设置背景音乐本地播放音量的大小。 |
| setBGMPublishVolume |
设置背景音乐远端播放音量的大小。 |
| playAudioEffect |
播放音效。 |
| setAudioEffectVolume |
设置音效音量。 |
| stopAudioEffect |
停止音效。 |
| stopAllAudioEffects |
停止所有音效。 |
| setAllAudioEffectsVolume |
设置所有音效的音量。 |
| pauseAudioEffect |
暂停音效。 |
| resumeAudioEffect |
恢复音效。 |
| selectScreenCaptureTarget |
设置屏幕共享参数。 |
| startRemoteView |
开始显示远端视频画面。 |
| stopRemoteView |
停止显示远端视频画面，同时不再拉取远端用户的视频数据流。 |
| setLocalViewFillMode |
设置本地图像的渲染模式。 |
| setRemoteViewFillMode |
设置远端图像的渲染模式。 |
| setLocalViewRotation |
设置本地图像的顺时针旋转角度。 |
| setRemoteViewRotation |
设置远端图像的顺时针旋转角度。 |
| setLocalViewMirror |
设置本地摄像头预览画面的镜像模式。 |
| startRemoteSubStreamView |
开始显示远端用户的辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）。 |
| stopRemoteSubStreamView |
停止显示远端用户的辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）。 |
| setRemoteSubStreamViewFillMode |
设置辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的显示模式。 |
| setRemoteSubStreamViewRotation |
设置辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的顺时针旋转角度。 |
| setPriorRemoteVideoStreamType |
设定观看方优先选择的视频质量。 |
| setAudioQuality |
设置音频质量。 |
| startLocalAudio |
开启本地音频的采集和上行。 |
| getCameraDevicesList |
获取摄像头设备列表。 |
| setCurrentCameraDevice |
设置要使用的摄像头。 |
| getCurrentCameraDevice |
获取当前使用的摄像头。 |
| getMicDevicesList |
获取麦克风设备列表。 |
| getCurrentMicDevice |
获取当前选择的麦克风。 |
| setCurrentMicDevice |
设置要使用的麦克风。 |
| getCurrentMicDeviceVolume |
获取系统当前麦克风设备音量。 |
| setCurrentMicDeviceVolume |
设置系统当前麦克风设备的音量。 |
| getSpeakerDevicesList |
获取扬声器设备列表。 |
| getCurrentSpeakerDevice |
获取当前的扬声器设备。 |
| setCurrentSpeakerDevice |
设置要使用的扬声器。 |
| getCurrentSpeakerVolume |
获取系统当前扬声器设备音量。 |
| setCurrentSpeakerVolume |
设置系统当前扬声器设备音量。 |
| startCameraDeviceTest |
开始进行摄像头测试。 |
| stopCameraDeviceTest |
停止摄像头测试。 |
| startMicDeviceTest |
开启麦克风测试。 |
| stopMicDeviceTest |
停止麦克风测试。 |
| startSpeakerDeviceTest |
开启扬声器测试。 |
| stopSpeakerDeviceTest |
停止扬声器测试。 |
TRTCCloudCallback @ TXLiteAVSDK
腾讯云视频通话功能的回调接口类。
错误事件和警告事件
| onError |
错误回调，SDK 不可恢复的错误，一定要监听，并分情况给用户适当的界面提示。 |
| onWarning |
警告回调：用于告知您一些非严重性问题，例如出现了卡顿或者可恢复的解码失败。 |
房间事件回调
| onEnterRoom |
已加入房间的回调。 |
| onExitRoom |
离开房间的事件回调。 |
| onSwitchRole |
切换角色结果回调。 |
| onConnectOtherRoom |
请求跨房通话（主播 PK）的结果回调。 |
| onDisconnectOtherRoom |
结束跨房通话（主播 PK）的结果回调。 |
| onSwitchRoom |
切换房间 (switchRoom) 的结果回调。 |
成员事件回调
| onRemoteUserEnterRoom |
有用户加入当前房间。 |
| onRemoteUserLeaveRoom |
有用户离开当前房间。 |
| onUserVideoAvailable |
用户是否开启摄像头视频。 |
| onUserSubStreamAvailable |
用户是否开启屏幕分享。 |
| onUserAudioAvailable |
用户是否开启音频上行。 |
| onFirstVideoFrame |
开始渲染本地或远程用户的首帧画面。 |
| onFirstAudioFrame |
开始播放远程用户的首帧音频（本地声音暂不通知）。 |
| onSendFirstLocalVideoFrame |
首帧本地视频数据已经被送出。 |
| onSendFirstLocalAudioFrame |
首帧本地音频数据已经被送出。 |
统计和质量回调
| onNetworkQuality |
网络质量：该回调每2秒触发一次，统计当前网络的上行和下行质量。 |
| onStatistics |
技术指标统计回调。 |
服务器事件回调
| onConnectionLost |
SDK 跟服务器的连接断开。 |
| onTryToReconnect |
SDK 尝试重新连接到服务器。 |
| onConnectionRecovery |
SDK 跟服务器的连接恢复。 |
| onSpeedTest |
服务器测速的回调，SDK 对多个服务器 IP 做测速，每个 IP 的测速结果通过这个回调通知。 |
硬件设备事件回调
| onCameraDidReady |
摄像头准备就绪。 |
| onMicDidReady |
麦克风准备就绪。 |
| onUserVoiceVolume |
用于提示音量大小的回调,包括每个 userId 的音量和远端总音量。 |
| onDeviceChange |
本地设备通断回调。 |
| onTestMicVolume |
麦克风测试音量回调。 |
| onTestSpeakerVolume |
扬声器测试音量回调。 |
| onAudioDeviceCaptureVolumeChanged |
当前音频采集设备音量变化通知。 |
| onAudioDevicePlayoutVolumeChanged |
当前音频播放设备音量变化通知。 |
自定义消息的接收回调
| onRecvCustomCmdMsg |
收到自定义消息回调。 |
| onMissCustomCmdMsg |
自定义消息丢失回调。 |
| onRecvSEIMsg |
收到 SEI 消息的回调。 |
CDN 旁路转推回调
| onStartPublishing |
开始向腾讯云的直播 CDN 推流的回调，对应于 TRTCCloud 中的 startPublishing() 接口。 |
| onStopPublishing |
停止向腾讯云的直播 CDN 推流的回调，对应于 TRTCCloud 中的 stopPublishing() 接口。 |
| onStartPublishCDNStream |
启动旁路推流到 CDN 完成的回调。 |
| onStopPublishCDNStream |
停止旁路推流到 CDN 完成的回调。 |
| onSetMixTranscodingConfig |
设置云端的混流转码参数的回调，对应于 TRTCCloud 中的 setMixTranscodingConfig() 接口。 |
屏幕分享回调
| onScreenCaptureCovered |
当屏幕分享窗口被遮挡无法正常捕获时，SDK 会通过此回调通知，可在此回调里通知用户移开遮挡窗口。 |
| onScreenCaptureStarted |
当屏幕分享开始时，SDK 会通过此回调通知。 |
| onScreenCapturePaused |
当屏幕分享暂停时，SDK 会通过此回调通知。 |
| onScreenCaptureResumed |
当屏幕分享恢复时，SDK 会通过此回调通知。 |
| onScreenCaptureStoped |
当屏幕分享停止时，SDK 会通过此回调通知。 |
弃用接口回调
| onUserEnter |
废弃接口：有主播加入当前房间。 |
| onUserExit |
废弃接口：有用户（主播）离开当前房间。 |
| onAudioEffectFinished |
废弃接口：播放音效结束回调。 |
| onPlayBGMBegin |
废弃接口：开始播放背景音乐。 |
| onPlayBGMProgress |
废弃接口：播放背景音乐的进度。 |
| onPlayBGMComplete |
废弃接口：播放背景音乐结束。 |
视频数据帧的自定义处理回调
| onRenderVideoFrame |
自定义视频渲染回调。 |
声音数据帧的自定义处理回调（只读）
回调函数是在 SDK 内部线程同步抛出来的，请不要做耗时操作。 说明请按需定义相关函数实现，减少不必要的性能损耗。
| onCapturedAudioFrame |
本地麦克风采集到的音频数据回调。 |
| onPlayAudioFrame |
混音前的每一路远程用户的音频数据（例如您要对某一路的语音进行文字转换，必须要使用这里的原始数据，而不是混音之后的数据）。 |
| onMixedPlayAudioFrame |
各路音频数据混合后送入喇叭播放的音频数据。 |
日志相关回调
关键类型定义
| TRTCImageBuffer |
图缓存。 |
| TRTCScreenCaptureSourceInfo |
屏幕采集信息。 |
| SIZE |
记录 buffer 的长宽。 |
| ITRTCScreenCaptureSourceList |
屏幕窗口列表。 |
| ITRTCDeviceCollection |
设备列表。 |
| ITRTCDeviceInfo |
设备 Item 信息。 |
| TRTCParams |
进房相关参数。 |
| TRTCVideoEncParam |
视频编码参数。 |
| TRTCNetworkQosParam |
网络流控相关参数。 |
| TRTCQualityInfo |
视频质量。 |
| TRTCVolumeInfo |
音量大小。 |
| TRTCVideoFrame |
视频帧数据。 |
| TRTCAudioFrame |
音频帧数据。 |
| TRTCSpeedTestResult |
网络测速结果。 |
| RECT |
记录矩形的四个点坐标。 |
| TRTCMixUser |
云端混流中每一路子画面的位置信息。 |
| TRTCTranscodingConfig |
云端混流（转码）配置。 |
| TRTCPublishCDNParam |
CDN 旁路推流参数。 |
| TRTCAudioRecordingParams |
录音参数。 |
| TRTCAudioEffectParam |
音效播放。 |
| TRTCLocalStatistics |
自己本地的音视频统计信息。 |
| TRTCRemoteStatistics |
远端成员的音视频统计信息。 |
| TRTCStatistics |
统计数据。 |
对音视频的解决方案有疑惑？想了解解决方案收费？ 联系解决方案专家
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心，购买腾讯云享受折上折，更有现金返利:同意关联，立享优惠
阿里云解决方案也看看？： 点击对比阿里云的解决方案
暂无评论，你要说点什么吗？