API

模块

基础函数

登录/注销

房间管理

进出房间

房间和成员管理

音频管理

视频管理

影音共享

屏幕共享

本地录制/本地直播

云端录制/互动直播

接口详情

getSDKVersion

• 详情: RTCSDK.getSDKVersion()
• 功能: 获取原生SDK版本号
• 返回值: SDK版本号

init

• 详情: RTCSDK.init(initObj, initCallback)
• 功能: SDK初始化
• 返回值: 无

uninit

• 详情: RTCSDK.uninit()
• 功能: SDK反初始化
• 返回值: 无

setServerAddr

• 详情: RTCSDK.setServerAddr(addr)
• 功能: 设置服务器地址
• 返回值: 无

login

• 详情: RTCSDK.login(LoginObj)
• 功能: 登录
• 返回值: 无

• 补充说明:

登陆成功则回调 loginSuccess ,登陆失败则回调 loginFail

logout

• 详情: RTCSDK.logout()
• 功能: 注销
• 返回值: 无

• 补充说明:

退出程序时，必须注销本次登录，然后再进行SDK反初始化操作

loginSuccess

• 详情: RTCSDK.on("loginSuccess", ({ userID }) => {})
• 功能: 登陆成功

loginFail

• 详情: RTCSDK.on("loginFail", ({ sdkErr }) => {})
• 功能: 登录失败

lineOff

• 详情: RTCSDK.on("lineOff", ({ sdkErr }) => {})
• 功能: 通知自己掉线

createMeeting

• 详情: RTCSDK.createMeeting()
• 功能: 创建房间
• 返回值: 无

• 补充说明:

操作成功则回调createMeetingSuccess，失败则回调createMeetingFail

destroyMeeting

• 详情: RTCSDK.destroyMeeting(meetID, cookie)
• 功能: 销毁房间
• 返回值: 无

• 补充说明:

回调函数destroyMeetingRslt

createMeetingSuccess

• 详情: RTCSDK.on("createMeetingSuccess", ({ MeetInfo }) => {})
• 功能: 通知创建房间成功

createMeetingFail

• 详情: RTCSDK.on("createMeetingFail", ({ sdkErr }) => {})
• 功能: 通知创建房间失败

destroyMeetingRslt

• 详情: RTCSDK.on("destroyMeetingRslt", ({ sdkErr, cookie }) => {})
• 功能: 销毁房间响应

enterMeeting

• 详情: RTCSDK.enterMeeting(meetID)
• 功能: 进入房间
• 返回值: 无

• 补充说明:

操作完成则回调enterMeetingRslt

exitMeeting

• 详情: RTCSDK.exitMeeting()
• 功能: 离开房间
• 返回值: 无

enterMeetingRslt

• 详情: RTCSDK.on("enterMeetingRslt", ({ sdkErr }) => {})
• 功能: 进入房间结果

userEnterMeeting

• 详情: RTCSDK.on("userEnterMeeting", ({ UID }) => {})
• 功能: 有人进入房间通知

userLeftMeeting

• 详情: RTCSDK.on("userLeftMeeting", ({ UID }) => {})
• 功能: 有人离开房间通知

getAllMembers

• 详情: RTCSDK.getAllMembers()
• 功能: 获取房间所有成员信息列表
• 返回值: 返回含多个成员信息（Array ------MemberInfo）

getMemberInfo

• 详情: RTCSDK.getMemberInfo(UID)
• 功能: 获取单个成员信息
• 返回值: 返回成员信息（MemberInfo）

sendMeetingCustomMsg

• 详情: RTCSDK.sendMeetingCustomMsg(msg, cookie)
• 功能: 房间内发送广播消息
• 返回值: 无

• 补充说明:

需要进进入房间议后才能调用

notifyNickNameChanged

• 详情: RTCSDK.on("notifyNickNameChanged", ({ userID, oldName, newName }) => {})
• 功能: SDK通知某用户改变了昵称

• 补充说明:

改昵称的用户自身不会接收到此通知

sendMeetingCustomMsgRslt

• 详情: RTCSDK.on("sendMeetingCustomMsgRslt", ({ sdkErr, cookie }) => {})
• 功能: 通知发送房间内自定义广播消息结果

notifyMeetingCustomMsg

• 详情: RTCSDK.on("notifyMeetingCustomMsg", ({ fromUserID, text }) => {})
• 功能: 通知接收到房间内用户自定义广播

netStateChanged

• 详情: RTCSDK.on("netStateChanged", ({ level }) => {})
• 功能: 通知我的网络变化

openMic

• 详情: RTCSDK.openMic(UID)
• 功能: 打开麦克风
• 返回值: 无

• 补充说明:

打开自已的麦克风时，先会进入到AOPENING状态，等服务器处理后才会进入AOPEN状态，此时说话才能被采集到。回调函数audioStatusChanged

closeMic

• 详情: RTCSDK.closeMic(UID)
• 功能: 关闭麦克风
• 返回值: 无

• 补充说明:

关麦操作是立即生效的，本地会立即停止采集。回调函数audioStatusChanged

setAllAudioClose

• 详情: RTCSDK.setAllAudioClose()
• 功能: 关闭所有人的麦克风
• 返回值: 无

• 补充说明:

关闭所有用户的麦克风(自己除外) ， 调用此接口后会话内其他人的麦克风会关闭，同时收到消息audioStatusChanged

getAudioCfg

• 详情: RTCSDK.getAudioCfg()
• 功能: 获取音频参数
• 返回值: 音频配置,参见AudioCfg

setAudioCfg

• 详情: RTCSDK.setAudioCfg(AudioCfg)
• 功能: 设置音频参数
• 返回值: 无

• 补充说明:

注意：成功进入房间后，才可以设置音频属性。

getSpeakerVolume

• 详情: RTCSDK.getSpeakerVolume()
• 功能: 获取本地扬声器音量
• 返回值: 本地扬声器音量(number),音量等级类型 0-255

setSpeakerVolume

• 详情: RTCSDK.setSpeakerVolume(level)
• 功能: 设置本地扬声器音量
• 返回值: 无

getSpeakerOut

• 详情: RTCSDK.getSpeakerOut()
• 功能: 获取当前是否外放
• 返回值: Boolean

setSpeakerOut

• 详情: RTCSDK.setSpeakerOut(speakerOut)
• 功能: 设置是否外放
• 返回值: 无

audioStatusChanged

• 详情: RTCSDK.on("audioStatusChanged", ({ userID, oldStatus, newStatus }) => {})
• 功能: 通知用户音频状态变化

micEnergyUpdate

• 详情: RTCSDK.on("micEnergyUpdate", ({ userID, oldLevel, newLevel }) => {})
• 功能: 通知成员麦克风声音能量变化

openVideo

• 详情: RTCSDK.openVideo(UID)
• 功能: 打开摄像头
• 返回值: 无

closeVideo

• 详情: RTCSDK.closeVideo(UID)
• 功能: 关闭摄像头
• 返回值: 无

getMyVideoPosition

• 详情: RTCSDK.getMyVideoPosition()
• 功能: 获取前后置摄像头ID
• 返回值: 参见前后置摄像头配置

getVideoCfg

• 详情: RTCSDK.getVideoCfg()
• 功能: 获取设置的摄像头参数
• 返回值: 摄像头参数,参见VideoCfg

setVideoCfg

• 详情: RTCSDK.setVideoCfg(VideoCfg)
• 功能: 设置摄像头参数
• 返回值: 无

getVideoEffects

• 详情: RTCSDK.getVideoEffects()
• 功能: 获取视频效果配置
• 返回值: 视频效果配置,参见VideoEffects

• 补充说明:

该接口仅安卓可用

setVideoEffects

• 详情: RTCSDK.setVideoEffects(VideoEffects)
• 功能: 设置视频效果配置
• 返回值: 无

• 补充说明:

该接口仅安卓可用

getDefaultVideo

• 详情: RTCSDK.getDefaultVideo(UID)
• 功能: 获取指定用户的默认摄像头
• 返回值: 摄像头ID

setDefaultVideo

• 详情: RTCSDK.setDefaultVideo(UID, videoID)
• 功能: 设置默认的摄像头
• 返回值: 无

getAllVideoInfo

• 详情: RTCSDK.getAllVideoInfo(UID)
• 功能: 获取摄像头设备列表
• 返回值: 用户的所有摄像头信息列表，数据类型为: VideoInfosObj

videoStatusChanged

• 详情: RTCSDK.on("videoStatusChanged", ({ userID, oldStatus, newStatus }) => {})
• 功能: 通知用户视频状态变化

openVideoRslt

• 详情: RTCSDK.on("openVideoRslt", ({ deviceID, success }) => {})
• 功能: 打开摄像头设备操作结果

videoDevChanged

• 详情: RTCSDK.on("videoDevChanged", ({ userID }) => {})
• 功能: 通知用户的视频设备有变化

getMediaCfg

• 详情: RTCSDK.getMediaCfg()
• 功能: 获取影音共享配置参数
• 返回值: 影音共享配置参数,参见VideoCfg

setMediaCfg

• 详情: RTCSDK.setMediaCfg(VideoCfg)
• 功能: 配置影音共享图像质量参数
• 返回值: 无

startPlayMedia

• 详情: RTCSDK.startPlayMedia(filename, bLocPlay)
• 功能: 播放影音文件
• 返回值: 无

pausePlayMedia

• 详情: RTCSDK.pausePlayMedia(isPause)
• 功能: 暂停或恢复播放影音
• 返回值: 无

stopPlayMedia

• 详情: RTCSDK.stopPlayMedia()
• 功能: 停止影音播放
• 返回值: 无

• 补充说明:

回调函数notifyMediaStop

setMediaPlayPos

• 详情: RTCSDK.setMediaPlayPos(pos)
• 功能: 设置播放进度
• 返回值: 无

getMediaInfo

• 详情: RTCSDK.getMediaInfo()
• 功能: 查询当前影音共享状态
• 返回值: 影音文件信息MediaInfoObj

notifyMediaOpened

• 详情: RTCSDK.on("notifyMediaOpened", ({ totalTime, width, height }) => {})
• 功能: 通知影音文件打开

• 补充说明:

收到该通知即可渲染媒体共享组件

notifyMediaStart

• 详情: RTCSDK.on("notifyMediaStart", ({ userID }) => {})
• 功能: 收到他人开启了影音共享的通知

• 补充说明:

收到该通知即可渲染媒体共享组件

notifyMediaPause

• 详情: RTCSDK.on("notifyMediaPause", ({ userID, pause }) => {})
• 功能: 收到他人暂停了影音共享的通知

notifyMediaStop

• 详情: RTCSDK.on("notifyMediaStop", ({ userID, reason }) => {})
• 功能: 收到他人停止了影音共享的通知

• 补充说明:

收到该通知即可销毁媒体共享组件

getScreenShareCfg

• 详情: RTCSDK.getScreenShareCfg()
• 功能: 获取屏幕共享配置
• 返回值: 屏幕共享配置,参见ScreenShareCfg

setScreenShareCfg

• 详情: RTCSDK.setScreenShareCfg(ScreenShareCfg)
• 功能: 设置本地屏幕共享配置
• 返回值: 无

startScreenShare

• 详情: RTCSDK.startScreenShare(ScreenMessageCfg)
• 功能: 开启屏幕共享
• 返回值: 无

• 补充说明:

回调函数startScreenShareRslt
屏幕共享需要相应授权，否则无法进行屏幕共享。参考配置

stopScreenShare

• 详情: RTCSDK.stopScreenShare()
• 功能: 停止屏幕共享
• 返回值: 无

• 补充说明:

回调函数stopScreenShareRslt

startScreenShareRslt

• 详情: RTCSDK.on("startScreenShareRslt", ({ sdkErr }) => {})
• 功能: 开启屏幕共享的响应事件

notifyScreenShareStarted

• 详情: RTCSDK.on("notifyScreenShareStarted", ({ userID }) => {})
• 功能: 通知他人开启了屏幕共享

• 补充说明:

收到该通知即可渲染屏幕共享组件

stopScreenShareRslt

• 详情: RTCSDK.on("stopScreenShareRslt", ({ sdkErr }) => {})
• 功能: 停止屏幕共享的响应事件

notifyScreenMarkStarted

• 详情: RTCSDK.on("notifyScreenMarkStarted", () => {})
• 功能: 通知屏幕标注开始

notifyScreenMarkStopped

• 详情: RTCSDK.on("notifyScreenMarkStopped", () => {})
• 功能: 通知屏幕标注停止

notifyScreenShareStopped

• 详情: RTCSDK.on("notifyScreenShareStopped", ({ userID }) => {})
• 功能: 通知他人停止了屏幕共享

createLocMixer

• 详情: RTCSDK.createLocMixer(mixerID, mixerCfg, mixerContents)
• 功能: 创建本地混图器
• 返回值: 错误码

• 补充说明:

创建本地混图器（用于本地录制、本地推流），当需要多个不同内容的录制、或直播时，就要创建多个混图器 。混图器开消比较大，多个同样图像的输出应该有一个混图器加上多个输出实现；

updateLocMixerContent

• 详情: RTCSDK.updateLocMixerContent(mixerID, mixerContents)
• 功能: 更新本地混图器内容
• 返回值: 错误码

destroyLocMixer

• 详情: RTCSDK.destroyLocMixer(mixerID)
• 功能: 消毁本地混图器
• 返回值: 无

• 补充说明:

消毁本地混图器后， 基于此混图器的录制输出、直播推流输出将自动结束

getLocMixerState

• 详情: RTCSDK.getLocMixerState(mixerID)
• 功能: 获取本地混图器状态
• 返回值: 混图器状态

addLocMixerOutput

• 详情: RTCSDK.addLocMixerOutput(mixerID, MixerOutPutCfgs)
• 功能: 开启本地录制、开启直播推流
• 返回值: 错误码

rmLocMixerOutput

• 详情: RTCSDK.rmLocMixerOutput(mixerID, nameOrUrls)
• 功能: 停止本地录制、直播推流
• 返回值: 无

• 补充说明:

所有输出停止后并不会消毁混图器，如果混图器不再需要请手工消毁

getAllRecordFiles

• 详情: RTCSDK.getAllRecordFiles()
• 功能: 取得所有录制文件信息
• 返回值: 所有录制文件信息: Array<RecordFileShow>

addFileToRecordMgr

• 详情: RTCSDK.addFileToRecordMgr(filename, filePath)
• 功能: 添加本地文件到录制文件管理中
• 返回值: -1：本地文件不存在，0：成功，1：文件已经被添加过

• 补充说明:

第三方录制文件调用此接口后可进行本地回放和上传到视频服务器上，和自己录制的文件一样可以正常

removeFromFileMgr

• 详情: RTCSDK.removeFromFileMgr(filename)
• 功能: 删除本地的录制文件
• 返回值: 无

• 补充说明:

上传中的文件会被取消上传 , 已上传完成的服务器文件不受影响

uploadRecordFile

• 详情: RTCSDK.uploadRecordFile(filename, svrPathFileName)
• 功能: 上传文件到服务器指定位置
• 返回值: 无

cancelUploadRecordFile

• 详情: RTCSDK.cancelUploadRecordFile(filename)
• 功能: 取消上传中的录制文件
• 返回值: 无

setPicResource

• 详情: RTCSDK.setPicResource(resId, picPath)
• 功能: 添加图片资源
• 返回值: 无

locMixerStateChanged

• 详情: RTCSDK.on("locMixerStateChanged", ({ mixerID, state }) => {})
• 功能: 本地混图器状态变化通知

locMixerOutputInfo

• 详情: RTCSDK.on("locMixerOutputInfo", ({ mixerID, nameOrUrl, outputInfo }) => {})
• 功能: 本地录制文件、本地直播信息通知

notifyRecordFileStateChanged

• 详情: RTCSDK.on("notifyRecordFileStateChanged", ({ fileName, state }) => {})
• 功能: 通知录制文件状态更改

notifyRecordFileUploadProgress

• 详情: RTCSDK.on("notifyRecordFileUploadProgress", ({ fileName, percent }) => {})
• 功能: 通知录制文件上传进度

createCloudMixer

• 详情: RTCSDK.createCloudMixer(cfg)
• 功能: 开始云端录制、云端直播
• 返回值: 云端混图器ID

• 补充说明:

可以开启多个云端混图器，具体个数和企业购买的授权相关；
开启云端混图器后，房间内所有人都将收到cloudMixerStateChanged通知状态值为1；
云端混图器部署有少量耗时，如果在部署过程遇到异常，将收到createCloudMixerFailed回调；
云端混图器启动完成并进入录制或推流状态时，将收到cloudMixerStateChanged通知状态值为2；
开启云端混图器在进入工作中的状态后，可以通过updateCloudMixerContent更新内容；
混图器如果在工作中遇到异常而停止时，将收到cloudMixerStateChanged通知，状态值为0，并携带错误原因；

updateCloudMixerContent

• 详情: RTCSDK.updateCloudMixerContent(mixerID, cfg)
• 功能: 更新云端录制、云端直播内容
• 返回值: 错误码

• 补充说明:

更新混图器内容时，只能更新内容和布局，不能更改混图器规格、输出目标；
更新混图器内容时，房间内所有人都将收到cloudMixerInfoChanged通知；

destroyCloudMixer

• 详情: RTCSDK.destroyCloudMixer(mixerID)
• 功能: 停止云端录制、云端直播
• 返回值: 无

getCloudMixerInfo

• 详情: RTCSDK.getCloudMixerInfo(mixerID)
• 功能: 获取云端录制、云端直播信息
• 返回值: CloudMixerInfo

getAllCloudMixerInfo

• 详情: RTCSDK.getAllCloudMixerInfo()
• 功能: 获取房间内所有云端录制、云端直播信息
• 返回值: CloudMixerInfo[]

createCloudMixerFailed

• 详情: RTCSDK.on("createCloudMixerFailed", ({ mixerID, sdkErr }) => {})
• 功能: 启动云端录制、云端直播失败通知

cloudMixerStateChanged

• 详情: RTCSDK.on("cloudMixerStateChanged", ({ mixerID, state, exParam, operUserID }) => {})
• 功能: 云端录制、云端直播状态变化通知

cloudMixerOutputInfoChanged

• 详情: RTCSDK.on("cloudMixerOutputInfoChanged", ({ mixerID, outputInfo }) => {})
• 功能: 云端录制文件、云端直播输出变化通知

cloudMixerInfoChanged

• 详情: RTCSDK.on("cloudMixerInfoChanged", ({ mixerID }) => {})
• 功能: 云端录制、云端直播配置变化通知

• 补充说明:

可调用：getCloudMixerInfo获取相关信息