API OVERVIEW
创建实例和事件回调
sharedInstance |
创建 TRTCCloud 实例(单例模式) |
destroySharedInstance |
销毁 TRTCCloud 实例(单例模式) |
addListener |
添加 TRTC 事件回调 |
removeListener |
移除 TRTC 事件回调 |
setListenerHandler |
设置驱动 TRTCCloudListener 事件回调的队列 |
房间相关接口函数
enterRoom |
进入房间 |
exitRoom |
离开房间 |
switchRole |
切换角色 |
switchRoom |
切换房间 |
ConnectOtherRoom |
请求跨房通话 |
DisconnectOtherRoom |
退出跨房通话 |
setDefaultStreamRecvMode |
设置订阅模式(需要在进入房前设置才能生效) |
createSubCloud |
创建子房间实例(用于多房间并发观看) |
destroySubCloud |
销毁子房间实例 |
updateOtherRoomForwardMode |
更改跨房主播在本房间的上行能力 |
CDN 相关接口函数
startPublishing |
开始向腾讯云直播 CDN 上发布音视频流 |
stopPublishing |
停止向腾讯云直播 CDN 上发布音视频流 |
startPublishCDNStream |
开始向非腾讯云 CDN 上发布音视频流 |
stopPublishCDNStream |
停止向非腾讯云 CDN 上发布音视频流 |
setMixTranscodingConfig |
设置云端混流的排版布局和转码参数 |
startPublishMediaStream |
开始发布媒体流 |
updatePublishMediaStream |
更新发布媒体流 |
stopPublishMediaStream |
停止发布媒体流 |
视频相关接口函数
startLocalPreview |
开启本地摄像头的预览画面(移动端) |
updateLocalView |
更新本地摄像头的预览画面 |
stopLocalPreview |
停止摄像头预览 |
muteLocalVideo |
暂停/恢复发布本地的视频流 |
setVideoMuteImage |
设置本地画面被暂停期间的替代图片 |
startRemoteView |
订阅远端用户的视频流,并绑定视频渲染控件 |
updateRemoteView |
更新远端用户的视频渲染控件 |
stopRemoteView |
停止订阅远端用户的视频流,并释放渲染控件 |
stopAllRemoteView |
停止订阅所有远端用户的视频流,并释放全部渲染资源 |
muteRemoteVideoStream |
暂停/恢复订阅远端用户的视频流 |
muteAllRemoteVideoStreams |
暂停/恢复订阅所有远端用户的视频流 |
setVideoEncoderParam |
设置视频编码器的编码参数 |
setNetworkQosParam |
设置网络质量控制的相关参数 |
setLocalRenderParams |
设置本地画面的渲染参数 |
setRemoteRenderParams |
设置远端画面的渲染模式 |
setVideoEncoderRotation |
设置视频编码器输出的画面方向 |
setVideoEncoderMirror |
设置编码器输出的画面镜像模式 |
setGSensorMode |
设置重力感应的适配模式 |
enableEncSmallVideoStream |
开启大小画面双路编码模式 |
setRemoteVideoStreamType |
切换指定远端用户的大小画面 |
snapshotVideo |
视频画面截图 |
setPerspectiveCorrectionPoints |
视频画面透视校正坐标设置 |
音频相关接口函数
startLocalAudio |
开启本地音频的采集和发布 |
stopLocalAudio |
停止本地音频的采集和发布 |
muteLocalAudio |
暂停/恢复发布本地的音频流 |
muteRemoteAudio |
暂停/恢复播放远端的音频流 |
muteAllRemoteAudio |
暂停/恢复播放所有远端用户的音频流 |
setAudioRoute |
设置音频路由 |
setRemoteAudioVolume |
设定某一个远端用户的声音播放音量 |
setAudioCaptureVolume |
设定本地音频的采集音量 |
getAudioCaptureVolume |
获取本地音频的采集音量 |
setAudioPlayoutVolume |
设定远端音频的播放音量 |
getAudioPlayoutVolume |
获取远端音频的播放音量 |
enableAudioVolumeEvaluation |
启用音量大小提示 |
startAudioRecording |
开始录音 |
stopAudioRecording |
停止录音 |
startLocalRecording |
开启本地媒体录制 |
stopLocalRecording |
停止本地媒体录制 |
setRemoteAudioParallelParams |
设置远端音频流智能并发播放策略 |
enable3DSpatialAudioEffect |
启用 3D 音效 |
updateSelf3DSpatialPosition |
设置 3D 音效中自身坐标及朝向信息 |
updateRemote3DSpatialPosition |
设置 3D 音效中远端用户坐标信息 |
set3DSpatialReceivingRange |
设置指定用户所发出声音的可被接收范围 |
设备管理相关接口
getDeviceManager |
获取设备管理类(TXDeviceManager) |
美颜特效和图像水印
getBeautyManager |
获取美颜管理类(TXBeautyManager) |
setWatermark |
添加水印 |
背景音乐和声音特效
getAudioEffectManager |
获取音效管理类(TXAudioEffectManager) |
startSystemAudioLoopback |
开启系统声音采集 |
stopSystemAudioLoopback |
停止系统声音采集 |
屏幕分享相关接口
startScreenCapture |
启动屏幕分享 |
stopScreenCapture |
停止屏幕分享 |
pauseScreenCapture |
暂停屏幕分享 |
resumeScreenCapture |
恢复屏幕分享 |
setSubStreamEncoderParam |
设置屏幕分享(即辅路)的视频编码参数(桌面系统和移动系统均已支持) |
自定义采集和自定义渲染
enableCustomVideoCapture |
启用/关闭视频自定义采集模式 |
sendCustomVideoData |
向 SDK 投送自己采集的视频帧 |
enableCustomAudioCapture |
启用音频自定义采集模式 |
sendCustomAudioData |
向 SDK 投送自己采集的音频数据 |
enableMixExternalAudioFrame |
启用/关闭自定义音轨 |
mixExternalAudioFrame |
向 SDK 混入自定义音轨 |
setMixExternalAudioVolume |
设置推流时混入外部音频的推流音量和播放音量 |
generateCustomPTS |
生成自定义采集时的时间戳 |
setLocalVideoProcessListener |
设置第三方美颜的视频数据回调 |
setLocalVideoRenderListener |
设置本地视频自定义渲染回调 |
setRemoteVideoRenderListener |
设置远端视频自定义渲染回调 |
setAudioFrameListener |
设置音频数据自定义回调 |
setCapturedAudioFrameCallbackFormat |
设置本地麦克风采集出的音频帧回调格式 |
setLocalProcessedAudioFrameCallbackFormat |
设置经过前处理后的本地音频帧回调格式 |
setMixedPlayAudioFrameCallbackFormat |
设置最终要由系统播放出的音频帧回调格式 |
enableCustomAudioRendering |
开启音频自定义播放 |
getCustomAudioRenderingFrame |
获取可播放的音频数据 |
自定义消息发送接口
sendCustomCmdMsg |
使用 UDP 通道发送自定义消息给房间内所有用户 |
sendSEIMsg |
使用 SEI 通道发送自定义消息给房间内所有用户 |
网络测试接口
startSpeedTest |
开始进行网速测试(进入房间前使用) |
stopSpeedTest |
停止网络测速 |
调试相关接口
getSDKVersion |
获取 SDK 版本信息 |
setLogLevel |
设置 Log 输出级别 |
setConsoleEnabled |
启用/禁用控制台日志打印 |
setLogCompressEnabled |
启用/禁用日志的本地压缩 |
setLogDirPath |
设置本地日志的保存路径 |
setLogListener |
设置日志回调 |
showDebugView |
显示仪表盘 |
TRTCViewMargin |
设置仪表盘的边距 |
callExperimentalAPI |
调用实验性接口 |
加密接口
enablePayloadPrivateEncryption |
开启或关闭媒体流私有加密 |
错误和警告事件
onError |
错误事件回调 |
onWarning |
警告事件回调 |
房间相关事件回调
onEnterRoom |
进入房间成功与否的事件回调 |
onExitRoom |
离开房间的事件回调 |
onSwitchRole |
切换角色的事件回调 |
onSwitchRoom |
切换房间的结果回调 |
onConnectOtherRoom |
请求跨房通话的结果回调 |
onDisConnectOtherRoom |
结束跨房通话的结果回调 |
onUpdateOtherRoomForwardMode |
更改跨房主播上行能力的结果回调 |
用户相关事件回调
onRemoteUserEnterRoom |
有用户加入当前房间 |
onRemoteUserLeaveRoom |
有用户离开当前房间 |
onUserVideoAvailable |
某远端用户发布/取消了主路视频画面 |
onUserSubStreamAvailable |
某远端用户发布/取消了辅路视频画面 |
onUserAudioAvailable |
某远端用户发布/取消了自己的音频 |
onFirstVideoFrame |
SDK 开始渲染自己本地或远端用户的首帧画面 |
onFirstAudioFrame |
SDK 开始播放远端用户的首帧音频 |
onSendFirstLocalVideoFrame |
自己本地的首个视频帧已被发布出去 |
onSendFirstLocalAudioFrame |
自己本地的首个音频帧已被发布出去 |
onRemoteVideoStatusUpdated |
远端视频状态变化的事件回调 |
onRemoteAudioStatusUpdated |
远端音频状态变化的事件回调 |
onUserVideoSizeChanged |
用户视频大小发生改变回调 |
网络和技术指标统计回调
onNetworkQuality |
网络质量的实时统计回调 |
onStatistics |
音视频技术指标的实时统计回调 |
onSpeedTestResult |
网速测试的结果回调 |
与云端连接情况的事件回调
onConnectionLost |
SDK 与云端的连接已经断开 |
onTryToReconnect |
SDK 正在尝试重新连接到云端 |
onConnectionRecovery |
SDK 与云端的连接已经恢复 |
硬件设备相关事件回调
onCameraDidReady |
摄像头准备就绪 |
onMicDidReady |
麦克风准备就绪 |
onAudioRouteChanged |
当前音频路由发生变化(仅适用于移动设备) |
onUserVoiceVolume |
音量大小的反馈回调 |
自定义消息的接收事件回调
onRecvCustomCmdMsg |
收到自定义消息的事件回调 |
onMissCustomCmdMsg |
自定义消息丢失的事件回调 |
onRecvSEIMsg |
收到 SEI 消息的回调 |
CDN 相关事件回调
onStartPublishing |
开始向腾讯云直播 CDN 上发布音视频流的事件回调 |
onStopPublishing |
停止向腾讯云直播 CDN 上发布音视频流的事件回调 |
onStartPublishCDNStream |
开始向非腾讯云 CDN 上发布音视频流的事件回调 |
onStopPublishCDNStream |
停止向非腾讯云 CDN 上发布音视频流的事件回调 |
onSetMixTranscodingConfig |
设置云端混流的排版布局和转码参数的事件回调 |
onStartPublishMediaStream |
开始发布媒体流的事件回调 |
onUpdatePublishMediaStream |
更新媒体流的事件回调 |
onStopPublishMediaStream |
停止媒体流的事件回调 |
onCdnStreamStateChanged |
RTMP/RTMPS 推流状态发生改变回调 |
屏幕分享相关事件回调
onScreenCaptureStarted |
屏幕分享开启的事件回调 |
onScreenCapturePaused |
屏幕分享暂停的事件回调 |
onScreenCaptureResumed |
屏幕分享恢复的事件回调 |
onScreenCaptureStopped |
屏幕分享停止的事件回调 |
本地录制和本地截图的事件回调
onLocalRecordBegin |
本地录制任务已经开始的事件回调 |
onLocalRecording |
本地录制任务正在进行中的进展事件回调 |
onLocalRecordFragment |
本地录制分片的事件回调 |
onLocalRecordComplete |
本地录制任务已经结束的事件回调 |
onSnapshotComplete |
本地截图完成的事件回调 |
废弃的事件回调
onUserEnter |
有主播加入当前房间(已废弃) |
onUserExit |
有主播离开当前房间(已废弃) |
onAudioEffectFinished |
音效播放已结束(已废弃) |
onSpeedTest |
服务器测速的结果回调(已废弃) |
视频数据自定义回调
onRenderVideoFrame |
自定义视频渲染回调 |
onGLContextCreated |
SDK 内部 OpenGL 环境已经创建的通知 |
onProcessVideoFrame |
用于对接第三方美颜组件的视频处理回调 |
onGLContextDestory |
SDK 内部 OpenGL 环境被销毁的通知 |
音频数据自定义回调
onCapturedAudioFrame |
本地采集并经过音频模块前处理后的音频数据回调 |
onLocalProcessedAudioFrame |
本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调 |
onRemoteUserAudioFrame |
混音前的每一路远程用户的音频数据 |
onMixedPlayAudioFrame |
将各路待播放音频混合之后并在最终提交系统播放之前的数据回调 |
onMixedAllAudioFrame |
SDK 所有音频混合后的音频数据(包括采集到的和待播放的) |
onVoiceEarMonitorAudioFrame |
耳返的音频数据 |
更多事件回调接口
背景音乐预加载事件回调
onLoadProgress |
背景音乐预加载进度 |
onLoadError |
背景音乐预加载出错 |
背景音乐的播放事件回调
onStart |
背景音乐开始播放 |
onPlayProgress |
背景音乐的播放进度 |
onComplete |
背景音乐已经播放完毕 |
人声相关的特效接口
enableVoiceEarMonitor |
开启耳返 |
setVoiceEarMonitorVolume |
设置耳返音量 |
setVoiceReverbType |
设置人声的混响效果 |
setVoiceChangerType |
设置人声的变声特效 |
setVoiceCaptureVolume |
设置语音音量 |
setVoicePitch |
设置语音音调 |
背景音乐的相关接口
setMusicObserver |
设置背景音乐的事件回调接口 |
startPlayMusic |
开始播放背景音乐 |
stopPlayMusic |
停止播放背景音乐 |
pausePlayMusic |
暂停播放背景音乐 |
resumePlayMusic |
恢复播放背景音乐 |
setAllMusicVolume |
设置所有背景音乐的本地音量和远端音量的大小 |
setMusicPublishVolume |
设置某一首背景音乐的远端音量的大小 |
setMusicPlayoutVolume |
设置某一首背景音乐的本地音量的大小 |
setMusicPitch |
调整背景音乐的音调高低 |
setMusicSpeedRate |
调整背景音乐的变速效果 |
getMusicCurrentPosInMS |
获取背景音乐的播放进度(单位:毫秒) |
getMusicDurationInMS |
获取背景音乐的总时长(单位:毫秒) |
seekMusicToPosInMS |
设置背景音乐的播放进度(单位:毫秒) |
setMusicScratchSpeedRate |
调整搓碟的变速效果 |
setPreloadObserver |
设置预加载事件回调 |
preloadMusic |
预加载背景音乐 |
getMusicTrackCount |
获取背景音乐的音轨数量 |
setMusicTrack |
指定背景音乐的播放音轨 |
美颜相关接口
setBeautyStyle |
设置美颜(磨皮)算法 |
setBeautyLevel |
设置美颜级别 |
setWhitenessLevel |
设置美白级别 |
enableSharpnessEnhancement |
开启清晰度增强 |
setRuddyLevel |
设置红润级别 |
setFilter |
设置色彩滤镜效果 |
setFilterStrength |
设置色彩滤镜的强度 |
setGreenScreenFile |
设置绿幕背景视频 |
setEyeScaleLevel |
设置大眼级别 |
setFaceSlimLevel |
设置瘦脸级别 |
setFaceVLevel |
设置 V 脸级别 |
setChinLevel |
设置下巴拉伸或收缩 |
setFaceShortLevel |
设置短脸级别 |
setFaceNarrowLevel |
设置窄脸级别 |
setNoseSlimLevel |
设置瘦鼻级别 |
setEyeLightenLevel |
设置亮眼级别 |
setToothWhitenLevel |
设置牙齿美白级别 |
setWrinkleRemoveLevel |
设置祛皱级别 |
setPounchRemoveLevel |
设置祛眼袋级别 |
setSmileLinesRemoveLevel |
设置法令纹去除级别 |
setForeheadLevel |
设置发际线调整级别 |
setEyeDistanceLevel |
设置眼距 |
setEyeAngleLevel |
设置眼角调整级别 |
setMouthShapeLevel |
设置嘴型调整级别 |
setNoseWingLevel |
设置鼻翼调整级别 |
setNosePositionLevel |
设置鼻子位置 |
setLipsThicknessLevel |
设置嘴唇厚度 |
setFaceBeautyLevel |
设置脸型 |
setMotionTmpl |
选择 AI 动效挂件 |
setMotionMute |
是否在动效素材播放时静音 |
设备操作接口
isFrontCamera |
判断当前是否为前置摄像头(仅适用于移动端) |
switchCamera |
切换前置或后置摄像头(仅适用于移动端) |
getCameraZoomMaxRatio |
获取摄像头的最大缩放倍数(仅适用于移动端) |
setCameraZoomRatio |
设置摄像头的缩放倍数(仅适用于移动端) |
isAutoFocusEnabled |
查询是否支持自动识别人脸位置(仅适用于移动端) |
enableCameraAutoFocus |
开启自动对焦功能(仅适用于移动端) |
setCameraFocusPosition |
设置摄像头的对焦位置(仅适用于移动端) |
enableCameraTorch |
开启/关闭闪光灯,也就是手电筒模式(仅适用于移动端) |
setAudioRoute |
设置音频路由(仅适用于移动端) |
setExposureCompensation |
设置摄像头的曝光参数,取值范围从-1到1 |
setCameraCapturerParam |
设置摄像头采集偏好 |
弃用接口
setSystemVolumeType |
设置系统音量类型(仅适用于移动端) |
废弃接口
setListener |
设置 TRTC 事件回调 |
setBeautyStyle |
设置美颜、美白以及红润效果级别 |
setEyeScaleLevel |
设置大眼级别 |
setFaceSlimLevel |
设置瘦脸级别 |
setFaceVLevel |
设置 V 脸级别 |
setChinLevel |
设置下巴拉伸或收缩幅度 |
setFaceShortLevel |
设置短脸级别 |
setNoseSlimLevel |
设置瘦鼻级别 |
selectMotionTmpl |
设置动效贴纸 |
setMotionMute |
设置动效静音 |
setFilter |
设置色彩滤镜效果 |
setFilterConcentration |
设置色彩滤镜浓度 |
setGreenScreenFile |
设置绿幕背景视频 |
setReverbType |
设置混响效果 |
setVoiceChangerType |
设置变声类型 |
enableAudioEarMonitoring |
开启(或关闭)耳返 |
enableAudioVolumeEvaluation |
启用音量大小提示 |
switchCamera |
切换摄像头 |
isCameraZoomSupported |
查询当前摄像头是否支持缩放 |
setZoom |
设置摄像头缩放倍数(焦距) |
isCameraTorchSupported |
查询是否支持开关闪光灯 |
enableTorch |
开关/关闭闪光灯 |
isCameraFocusPositionInPreviewSupported |
查询摄像头是否支持设置焦点 |
setFocusPosition |
设置摄像头焦点坐标位置 |
isCameraAutoFocusFaceModeSupported |
查询是否支持自动识别人脸位置 |
setSystemVolumeType |
设置系统音量类型 |
checkAudioCapabilitySupport |
查询是否支持音频某种能力(仅适用于Android) |
startLocalAudio |
设置音频质量 |
startRemoteView |
开始显示远端视频画面 |
stopRemoteView |
停止显示远端视频画面,同时不再拉取该远端用户的视频数据流 |
setLocalViewFillMode |
设置本地图像的渲染模式 |
setLocalViewRotation |
设置本地图像的顺时针旋转角度 |
setLocalViewMirror |
设置本地摄像头预览画面的镜像模式 |
setRemoteViewFillMode |
设置远端图像的渲染模式 |
setRemoteViewRotation |
设置远端图像的顺时针旋转角度 |
startRemoteSubStreamView |
开始显示远端用户的辅路画面 |
stopRemoteSubStreamView |
停止显示远端用户的辅路画面 |
setRemoteSubStreamViewFillMode |
设置辅路画面的填充模式 |
setRemoteSubStreamViewRotation |
设置辅路画面的顺时针旋转角度 |
setAudioQuality |
设置音频质量 |
setPriorRemoteVideoStreamType |
设定优先观看大画面还是小画面 |
setMicVolumeOnMixing |
设置麦克风音量大小 |
playBGM |
启动播放背景音乐 |
stopBGM |
停止播放背景音乐 |
pauseBGM |
停止播放背景音乐 |
resumeBGM |
停止播放背景音乐 |
getBGMDuration |
获取背景音乐总时长(单位:毫秒) |
setBGMPosition |
设置背景音乐的播放进度 |
setBGMVolume |
设置背景音乐的音量大小 |
setBGMPlayoutVolume |
设置背景音乐的本地播放音量 |
setBGMPublishVolume |
设置背景音乐的远端播放音量 |
playAudioEffect |
播放音效 |
setAudioEffectVolume |
设置音效音量 |
stopAudioEffect |
停止播放音效 |
stopAllAudioEffects |
停止所有音效 |
setAllAudioEffectsVolume |
设置所有音效音量 |
pauseAudioEffect |
暂停音效 |
resumeAudioEffect |
暂停音效 |
enableCustomVideoCapture |
启用视频自定义采集模式 |
sendCustomVideoData |
投送自己采集的视频数据 |
muteLocalVideo |
暂停/恢复发布本地的视频流 |
muteRemoteVideoStream |
暂停 / 恢复订阅远端用户的视频流 |
snapshotVideo |
视频画面截图 |
startSpeedTest |
开始进行网络测速(进入房间前使用) |
startScreenCapture |
启动屏幕分享 |
对音视频的解决方案有疑惑?想了解解决方案收费? 联系解决方案专家
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心,购买腾讯云享受折上折,更有现金返利:同意关联,立享优惠
阿里云解决方案也看看?: 点击对比阿里云的解决方案
暂无评论,你要说点什么吗?