TKRoomManager.h 是SDK主要的接口类文件,其中定义了房间调用相关的主要接口,主要类是 TKRoomManager。以下是该类中定义的属性和方法。
初始化和注册设置
| 接口名称 | 接口功能 |
|---|---|
| GetRoomClient | 获取实例化的SDK对象 |
| DelRoomClient | 销毁SDK对象 |
| GetSdkVersion | 获取SDK版本号 |
| init | 初始化SDK |
| uninit | deinitialize sdk |
| getInterface | 获取相关实例类的接口对象 |
| setLoggerInfo | 设置日志打印信息 |
| registerRoomObserver | 设置房间信令回调代理 |
| registerMediaObserver | 设置获取音视频数据回调代理 |
进出房间和房间信息
| 接口名称 | 接口功能 |
|---|---|
| joinRoom | 进入普通房间,房间需要在后台创建后才能进入 |
| joinRoomEx | 进入即时房间,房间无需在后台创建 |
| leaveRoom | 离开房间 |
| setRoomProfile | 设置房间类型 |
| getRoomProperties | 获取房间相关属性 |
| getRoomUserByID | 获取指定用户对象 |
| getServerList | 获取服务器列表 |
发布和播放音视频
| 接口名称 | 接口功能 |
|---|---|
| publishVideo | 发布自己的视频(有多流的重载) |
| unPublishVideo | 停止发布自己的视频(有多流的重载) |
| publishAudio | 发布自己的音频 |
| unPublishAudio | 停止发布自己的音频 |
| playVideo | 播放视频(有多流的重载) |
| unPlayVideo | 停止播放视频(有多流的重载) |
| playAudio | 播放音频(有多流的重载) |
| unPlayAudio | 停止播放音频(有多流的重载) |
信令和修改属性
| 接口名称 | 接口功能 |
|---|---|
| sendMessage | 发送聊天消息 |
| pubMsg | 发布自定义消息 |
| delMsg | 取消发布的自定义信令消息 |
| evictUser | 踢用户出房间 |
| switchOnlyAudioRoom | 是否切换房间为纯音频房间 |
| selectServer | 切换当前链接的服务器 |
| changeUserProperty | 改变用户属性 |
设置本地音视频属性
| 接口名称 | 接口功能 |
|---|---|
| setLocalVideoMirror | 设置本地视频镜像 |
| setVideoProfile | 设置我的视频采集和发布分辨率(有多流的重载) |
| setRemoteAudioVolume | 设置用户音频音量大小 |
| setVideoRenderMirror | 设置本地渲染及编码视频镜像 |
分享和播放媒体流
| 接口名称 | 接口功能 |
|---|---|
| startShareMediaFile | 发布分享媒体流文件 |
| stopShareMediaFile | 取消分享媒体流文件 |
| playMediaFile | 播放分享的媒体流 |
| unplayMediaFile | 停止播放分享的媒体流 |
| pauseMediaFile | 暂停播放分享的媒体流 |
| seekMediaFile | seek分享的媒体流 |
播放桌面共享
| 接口名称 | 接口功能 |
|---|---|
| startShareScreen | 开始桌面共享 |
| stopShareScreen | 停止共享桌面 |
| updateShareScreen | 更新共享 |
| getValidWindowList | 获取有效共享窗口 |
| getValidWindowListEx | 获取有效共享窗口(该接口可以获取缩略图或图标) |
| getCount | 获取可共享的窗口和屏幕的个数。 |
| getWindowInfo | 获取指定的可共享窗口或屏幕的信息。 |
| release | 释放 ITKValidWindowList |
| playScreen | 播放某个用户共享的屏幕 |
| unplayScreen | 停止播放桌面共享音视频流 |
| updateScreenCaptureParameters | 更新屏幕共享窗口列表 |
播放本地音视频文件
| 接口名称 | 接口功能 |
|---|---|
| startPalyAudioFile | 播放本地音频文件 |
| stopPlayAudioFile | 停止播放本地音频文件 |
| pauseAndresumePlayAudioFile | 暂停和恢复播放本地音频文件 |
| seekPalyAudioFile | 动播放进度 |
| setPlayAudioFileVolume | 设置播放本地音频文件的音量大小 |
| startPlayMediaFile | 播放本地视频文件 |
| stopPlayMediaFile | 停止播放本地视频文件 |
| pausePlayMediaFile | 暂停和恢复播放本地视频文件 |
| seekPlayMediaFile | 拖动播放本地视频文件进度 |
| setPlayMediaFileVolume | 设置播放本地视频文件的音量大小 |
服务器录制和本地录制
| 接口名称 | 接口功能 |
|---|---|
| startServerRecord | 开启服务器录制 |
| stopServerRecord | 停止服务器录制 |
| startRecordScreen | 开始录制本地桌面 |
| stopRecordScreen | 停止录制本地桌面 |
| pauseRecordScreen | 暂停录制本地桌面 |
| startRecordAudio | 开始音频录制 |
| stopRecordAudio | 停止音频录制 |
| pauseRecordAudio | 暂停音频录制 |
开启大小流
| 接口名称 | 接口功能 |
|---|---|
| enableDualStream | 是否开启本地大小流模式 |
| setSmallStreamParameter | 设置小流的视频分辨率(仅在开启大小流模式下起作用) |
| setRemoteDefaultVideoStreamType | 设置订阅远端音视频流的默认类型(仅在开启大小流模式下起作用) |
| setRemoteVideoStreamType | 设置远端视频流类型和视频采集设备ID(仅在开启大小流模式下起作用) |
大规模房间
| 接口名称 | 接口功能 |
|---|---|
| changeUserPropertyByRoles | 改变指定了角色的用户属性 |
| changeUserPropertyByIds | 改变指定了ID的用户属性 |
| getUserInfoByRoles | 获取房间用户信息(用户列表) |
| getUserNumberByRoles | 大规模教室时获取房间人数 |




