TKRoomManager.h概览
最近更新时间：2022-01-24 18:02:46 星期一
TKRoomManager.h 是SDK主要的接口类文件，其中定义了房间调用相关的主要接口，主要类是 TKRoomManager。以下是该类中定义的属性和方法。
TKRoomManager类
属性
| 属性名称 | 属性描述 |
|---|---|
| localUser | 本地用户对象，只读属性，调用 joinRoomWithHost 接口后，localUser 对象就会出初始化 |
| inBackground | app是否进入后台 |
初始化和注册设置
| 接口名称 | 接口功能 |
|---|---|
| instance | 实例化SDK单例对象 |
| destory | 销毁SDK对象 |
| setLogLevel | 设置打印SDK日志等级 |
| initWithAppKey | 初始化SDK |
| registerRoomManagerDelegate | 设置房间信令回调代理 |
| registerMediaDelegate | 设置获取音视频数据回调代理 |
进出房间和房间信息
| 接口名称 | 接口功能 |
|---|---|
| joinRoomWithHost | 进入普通房间，房间需要在后台创建后才能进入 |
| joinRoomEx | 进入即时房间，房间无需在后台创建 |
| leaveRoom | 离开房间 |
| getRoomProperty | 获取房间相关属性 |
| getRoomUserWithUId | 获取用户对象 |
| getServerList | 获取服务器列表 |
| getStreamStats | 获取用户的上行音视频统计信息数据 |
发布和播放音视频
| 接口名称 | 接口功能 |
|---|---|
| publishVideo | 发布自己视频 |
| unPublishVideo | 停止发布自己视频 |
| publishAudio | 发布自己音频 |
| unPublishAudio | 停止发布自己音频 |
| playVideo | 播放视频 |
| playAudio | 播放音频 |
| unPlayVideo | 停止播放视频 |
| unPlayAudio | 停止播放音频 |
信令和修改属性
| 接口名称 | 接口功能 |
|---|---|
| sendMessage | 发送聊天消息 |
| pubMsg | 发布自定义信令消息 |
| delMsg | 取消发布的自定义信令消息 |
| evictUser | 踢用户出房间 |
| switchOnlyAudioRoom | 是否切换房间为纯音频房间 |
| changeCurrentServer | 切换当前链接的服务器 |
| changeUserProperty | 修改用户属性 |
设置本地音视频属性
| 接口名称 | 接口功能 |
|---|---|
| setLocalVideoMirrorMode | 设置本地视频镜像模式 |
| setVideoProfile | 设置我的视频采集和发布分辨率 |
| selectCameraPosition | 切换我的前后置摄像头 |
| setVideoOrientation | 设置我的视频采集方向 |
| enableLocalVideo | 是否禁用本地摄像头 |
| enableLocalAudio | 是否禁用本地麦克风 |
| useLoudSpeaker | 音频是否外放 |
| setRemoteAudioVolume | 设置用户音频音量大小 |
分享和播放媒体流
| 接口名称 | 接口功能 |
|---|---|
| startShareMediaFile | 发布分享媒体流文件 |
| stopShareMediaFile | 取消分享媒体流文件 |
| playMediaFile | 播放分享的媒体流 |
| unPlayMediaFile | 停止播放分享的媒体流 |
| pauseMediaFile | 暂停播放分享的媒体流 |
| seekMediaFile | seek分享的媒体流 |
播放桌面共享和电影文件流
| 接口名称 | 接口功能 |
|---|---|
| playScreen | 播放桌面共享音视频流 |
| unPlayScreen | 停止播放桌面共享音视频流 |
| playFile | 播放共享的电影文件流 |
| unPlayFile | 停止播放共享的电影文件流 |
服务器录制和本地录制
| 接口名称 | 接口功能 |
|---|---|
| startServerRecord | 开启服务器录制课程 |
| stopServerRecord | 停止服务器录制课程 |
| pauseServerRecord | 暂停服务器录制课程 |
| resumeServerRecord | 恢复服务器录制课程 |
| startAudioRecord | 开始本地录制音频 |
| pauseAudioRecord | 暂停本地录制音频 |
| stopAudioRecord | 停止本地录制音频 |
开启大小流
| 接口名称 | 接口功能 |
|---|---|
| enableDualStream | 是否开启本地大小流模式 |
| setSmallStreamParameter | 设置小流的视频分辨率（仅在开启大小流模式下起作用） |
| setRemoteDefaultVideoStreamType | 设置订阅远端音视频流的默认类型（仅在开启大小流模式下起作用） |
| setRemoteVideoStreamType | 设置远端视频流类型和视频采集设备ID（仅在开启大小流模式下起作用） |
播放本地音视频文件
| 接口名称 | 接口功能 |
|---|---|
| startPlayAudioFile | 播放本地音频文件（音频文件会以流形式混音播放） |
| stopPlayAudioFile | 停止播放本地音频文件 |
| pauseAudioFile | 暂停播放本地音频文件 |
| resumeAudioFile | 恢复播放本地音频文件 |
| setAudioFileVolume | 设置播放本地音频文件的音量 |
| startPlayMediaFile | 播放本地媒体文件 |
| stopPlayMediaFile | 停止播放本地媒体文件 |
| pausePlayMedia | 暂停播放本地媒体文件 |
| resumePlayMedia | 恢复播放本地媒体文件 |
| seekPlayMedia | seek播放本地媒体文件 |
| setPlayMediaVolume | 设置播放本地媒体文件的音量 |
大规模房间
| 接口名称 | 接口功能 |
|---|---|
| getRoomUserWithPeerId | 大规模房间时获取指定ID的用户 |
| getRoomUserNumberWithRole | 大规模教室时获取房间人数 |
| getRoomUsersWithRole | 大规模教室时获取房间用户信息（用户列表） |
| batchChangeUserPropertyByIds | 批量改变指定了ID的用户属性 |
| changeUserPropertyByRole | 改变指定了角色的用户属性 |
| getUsersByProperty | 根据用户属性获取用户列表 |
