TKRoomSDK回放接口

• 回放说明
• TKPlayBackManager
• instance
• destroy
• setLoggerInfo
• init
• registerRoomObserver
• joinPlayBackRoom
• getRoomProperties
• getUser
• playVideo
• playAudio
• unPlayVideo
• unPlayAudio
• playMediaFile
• unPlayMediaFile
• playScreen
• unPlayScreen
• playFile
• unPlayFile
• seekPlayback
• pausePlayback
• resumePlayBack

最近更新时间：2022-01-05 11:31:49

回放说明

• TKRoomSDK 支持房间完全回放功能，可以完整的还原房间实时直播内容和过程。

TKPlayBackManager

• 回放主接口类

instance

简要描述 - 创建一个 TKPlaybackManager 单例对象，必须通过此接口创建对象。

接口名称
- + getInstance()

方法示例

TKPlayBackManager.getInstance()

返回值说明

类型	说明
无	无

destroy

简要描述 - 销毁 TKPlaybackManager 单例对象，必须调用此接口。

接口名称
- + (void)destroy

方法示例

TKPlayBackManager.getInstance().destroy();

返回值说明

类型	说明
无	无

setLoggerInfo

简要描述 - 设置SDK日志打印等级，日志会写入沙盒。

接口名称
- + setLoggerInfo(int filter, String logFilePath)

参数

参数名	必填	类型	说明
level	是	int	日志等级
logPath	否	String	日志文件地址（必须可以读写文件路径）

方法示例

TKPlayBackManager.getInstance().setLoggerInfo(LogLevel.ERROR,"");

返回值说明

类型	说明
无	无

init

简要描述 - 设置AppID，需要调用此接口初始化房间信息

接口名称
- - init(Context applicationContext, String appId, HashMap<String, Object> params)

参数

参数名	必填	类型	说明
appId	是	String	企业Key值
params	否	Map	房间扩展信息
applicationContext	是	Context	上下文对象

方法示例

HashMap<String, Object> params = new HashMap<>();
params.put(TKRoomManager.max_reconnect_count, 5);
params.put(TKRoomManager.tkUiVersion, Tools.getVersion());
params.put(TKRoomManager.tkCheckroomInterrupt, isOpen);
params.put(TKRoomManager.tkAutoCloseCamera, true);
params.put(TKRoomManager.useSecureSocket, true);
params.put(TKRoomManager.tkGetRoomFile, false);
params.put(RoomVariable.tk_sdk_uniform_version, Config.TKSDKUNIFORMVERSION);
TKRoomManager.getInstance().init(activity.getApplicationContext(), "talkplus", params);

返回值说明

类型	说明
无	无

registerRoomObserver

简要描述 - 注册房间 registerRoomObserver 代理，用以接受房间信息回调。

接口名称
- - registerRoomObserver(TKPlayBackManagerObserver callBack)

参数

参数名	必填	类型	说明
callBack	否	TKPlayBackManagerObserver	实现 TKPlayBackManagerObserver 代理的对象

方法示例

TKRoomManager.getInstance().registerRoomObserver(null);

返回值说明

类型	说明
无	无

joinPlayBackRoom

简要描述 - 进入回放房间接口

接口名称

    - (int)joinPlayBackRoom(final String host, final int port, String nickname, Map<String, Object> params, Map<String, Object> properties) ;

参数

参数名	必填	类型	说明
host	是	String	服务器地址 默认是https
port	是	int	服务器端口
nickname	是	String	昵称
params	是	Map	房间所需的基本参数
properties	是	Map	进入房间时用户的初始化的信息, 该信息会保存到 RoomUser 对象的 properties 属性中。可根据自身需求自定义，比如 giftNumber（礼物数）

方法示例
authKey方式：

    HashMap<String, Object> params = new HashMap<String, Object>();
if (RoomVariable.param != null && !RoomVariable.param.isEmpty())
    params.put("param", RoomVariable.param);
if (RoomVariable.domain != null && !RoomVariable.domain.isEmpty())
    params.put("domain", RoomVariable.domain);
if (RoomVariable.finalnickname != null && !RoomVariable.finalnickname.isEmpty())
    params.put("servername", RoomVariable.finalnickname);
if (RoomVariable.path != null && !RoomVariable.path.isEmpty()) {
    params.put("playback", true);
}
if (!TextUtils.isEmpty(RoomVariable.path)) {
    params.put("path", RoomVariable.path);
}
if (type != -1) {
    params.put("type", type);
}
params.put("password", RoomVariable.password);
params.put("nickname", RoomVariable.nickname);
params.put("mobilenameOnList", RoomVariable.mobilenameNotOnList);
params.put("serial", RoomVariable.serial);
params.put("userrole", RoomVariable.userrole);
params.put("recordtitle", RoomVariable.recordtitle);
RoomVariable.params = params;
if (!TextUtils.isEmpty(RoomVariable.host)) {
    int code = TKPlayBackManager.getInstance().joinPlayBackRoom(RoomVariable.host, RoomVariable.port,
            RoomVariable.nickname, RoomVariable.params, new HashMap<String, Object>());
    if (code != 0) {
        isjoinRoomcallBack = true;
    }
}

返回值说明

类型	说明
int	0:表示调用成功，非0:表示调用失败
### leaveRoom
简要描述
- 退出教室

接口名称
- - (int)leaveRoom(boolean force) 同步退出 - (int)leaveRoom();

参数

参数名	必填	类型	说明
force	是	boolean	是否同步执行

方法示例

     TKPlayBackManager.getInstance().joinPlayBackRoomLeaveRoom();

返回值说明

类型	说明
int	0:表示调用成功，非0:表示调用失败

getRoomProperties

简要描述 - 获取房间属性

需在调用 joinroom 接口后调用才能获取有效结果。 返回房间相关的所有信息，例如房间ID、房间类型、配置项等。 配置项：表示该房间是否开启了教学辅助功能，例如自动下课、答题器等等教学互动功能。

接口名称
- - JSONObject getRoomProperties();

方法示例

    TKPlayBackManager.getInstance().getRoomProperties();

返回值说明

类型	说明
JSONObject	房间相关信息的字典

getUser

简要描述 - 根据用户ID获取用户

RoomUser 是用户对象类，存储了用户的相关信息。 需在调用 joinroom 接口后调用才能获取有效结果。

接口名称
- - RoomUser getUser(String peerId)

参数

参数名	必填	类型	说明
peerId	是	NSString	用户ID

方法示例

    TKPlayBackManager.getInstance().getUser("1");

返回值说明

类型	说明
RoomUser	如果房间中有这个用户ID的用户，则返回 RoomUser的用户对象，否则返回 null

playVideo

简要描述 - 播放用户视频 参考TKRoomManager中的playVideo 。

playAudio

简要描述 - 播放用户音频 参考TKRoomManager中的playAudio 。

unPlayVideo

简要描述 - 停止播放用户视频 参考TKRoomManager中的unPlayVideo 。

unPlayAudio

简要描述 - 停止播放用户音频 参考TKRoomManager中的unPlayAudio 。

playMediaFile

简要描述 - 播放用户分享的媒体流文件 参考TKRoomManager中的playMediaFile 。

unPlayMediaFile

简要描述 - 停止播放分享的媒体流文件 参考TKRoomManager中的unPlayMediaFile 。

playScreen

简要描述 - 播放屏幕共享 参考TKRoomManager中的playScreen 。

unPlayScreen

简要描述 - 停止播放屏幕共享 参考TKRoomManager中的unPlayScreen 。

playFile

简要描述 - 播放用户共享的电影文件 参考TKRoomManager中的playFile 。

unPlayFile

简要描述 - 停止播放用户共享的电影文件 参考TKRoomManager中的unPlayFile 。

seekPlayback

简要描述 - 设置回放的进度

接口名称
- - seekPlayback(long positionTime);

参数

参数名	必填	类型	说明
positionTime	是	long	进度时间点

方法示例

   TKPlayBackManager.getInstance().seekPlayback(20);

返回值说明

类型	说明
无	无

pausePlayback

简要描述 - 暂停回放

接口名称
- - pausePlayback();

参数
无

方法示例

    TKPlayBackManager.getInstance().pausePlayback();

返回值说明

类型	说明
int	0:表示调用成功，非0:表示调用失败

resumePlayBack

简要描述 - 播放回放

接口名称
- - resumePlayBack();

参数
无

方法示例

  TKPlayBackManager.getInstance().resumePlayBack();

返回值说明

类型	说明
int	0:表示调用成功，非0:表示调用失败