跳转至

TKRoomManager.h 是SDK主要的接口类文件,其中定义了房间调用相关的主要接口,主要类是 TKRoomManager。以下是该类中定义的属性和方法。

初始化和注册设置

接口名称 接口功能
createclient 创建client指针
destroyclient 销毁client
init 初始化SDK
uninit deinitialize sdk
setLoggerInfo 设置日志打印信息
registerroomobserver 设置房间信令回调代理
registermediaobserver 设置获取音视频数据回调代理

进出房间和房间信息

接口名称 接口功能
joinroom 进入普通房间,房间需要在后台创建后才能进入
joinRoomEx 进入即时房间,房间无需在后台创建
leaveroom 离开房间
setroomprofile 设置房间类型
getroomproperties 获取房间相关属性
getserverlist 获取服务器列表

发布和播放音视频

接口名称 接口功能
publishvideo
publishvideobyid
发布自己的视频(有多流的重载)
unpublishvideo
unpublishvideobyid
停止发布自己的视频(有多流的重载)
publishaudio 发布自己的音频
unpublishaudio 停止发布自己的音频
playvideo
playVideo
播放视频(有多流的重载)
unplayvideo
unplayVideo
停止播放视频(有多流的重载)
playaudio 播放音频(有多流的重载)
unplayaudio 停止播放音频(有多流的重载)

信令和修改属性

接口名称 接口功能
sendmessage
sendmessage_json
发送聊天消息
pubmsg_number
pubmsg_string
pubmsg_json
pubmsg
发布自定义消息
delmsg 取消发布的自定义信令消息
evictuser 踢用户出房间
switchonlyaudioroom 是否切换房间为纯音频房间
selectserver 切换当前链接的服务器
changeuserproperty_number
changeuserproperty_string
changeuserproperty_json
改变用户属性

设置本地音视频属性

接口名称 接口功能
setlocalvideomirror 设置本地视频镜像
setVideoProfile
setVideoProfileById
设置我的视频采集和发布分辨率(有多流的重载)
setremoteaudiovolume 设置用户音频音量大小

分享和播放媒体流

接口名称 接口功能
startsharemediafile 发布分享媒体流文件
stopsharemediafile 取消分享媒体流文件
playmediafile 播放分享的媒体流
unplaymediafile 停止播放分享的媒体流
pausemediafile 暂停播放分享的媒体流
seekmediafile seek分享的媒体流

播放桌面共享

接口名称 接口功能
startsharescreen 开始桌面共享
stopsharescreen 停止共享桌面
updatesharescreen 更新共享
getvalidwindowlist 获取有效共享窗口
playscreen 播放某个用户共享的屏幕
unplayscreen 停止播放桌面共享音视频流

服务器录制和本地录制

接口名称 接口功能
startserverrecord 开启服务器录制
stopserverrecord 停止服务器录制
startrecordscreen 开始录制本地桌面
stoprecordscreen 停止录制本地桌面
pauserecordscreen 暂停录制本地桌面
startrecordaudio 开始音频录制
stoprecordaudio 停止音频录制
pauserecordaudio 暂停音频录制

开启大小流

接口名称 接口功能
enabledualstream 是否开启本地大小流模式
setsmallstreamparameter 设置小流的视频分辨率(仅在开启大小流模式下起作用)
setremotedefaultvideostreamtype 设置订阅远端音视频流的默认类型(仅在开启大小流模式下起作用)
setremotevideostreamtype 设置远端视频流类型和视频采集设备ID(仅在开启大小流模式下起作用)

大规模房间

接口名称 接口功能
changeuserpropertybyroles 改变指定了角色的用户属性
changeuserpropertybyids 改变指定了ID的用户属性
getuserinfobyroles 获取房间用户信息(用户列表)
getusernumberbyroles 大规模教室时获取房间人数

© 2016-2023 北京拓课网络科技有限公司 版权所有  京ICP备17018423号-1 京公网安备11010502043461号