聊天模块

聊天模块功能API 说明

调用方式：在实例化，VhallSDK 之后，用vhallSDK的实例句柄，下 chat 模块进行调用访问。

API 名称	功能描述	参数	返回值	备注
sendChat	自助操作发送聊天消息	msg, 类型：String	null	聊天内容, 最多140字符
sendCustomEvent	自助操作发送自定义聊天消息	msg, 类型：Object	null	自定义消息对象, {type: '自定义消息类型', data:{ name: '自定义消息数据'}}
vhall_get_live_history_chat_msg	自助操作获取直播聊天历史记录	opt, 类型：Object	null	参数为查询参数, {currPage:1, pageSize:50, startTime: '2020/07/13', endTime: '2020/07/15'} 返回primise。出于性能考虑，目前只支持返回最新50条聊天消息内容。注意：3.0.0至3.0.4版本采用当前对象传参
vhall_get_live_history_chat_msg	自助操作获取直播聊天历史记录	opt, 类型：Number	null	参数为查询页码，且每分页固定返回50条数据。注意：从3.0.5版本起仅支持通过页码，查询分页数据
vhall_get_record_history_chat_msg	自助操作获取直播聊天历史记录	page, 类型：Number	null	参数为查询页码。注意：从3.0.5版本起不在支持此方法，统一使用vhall_get_live_history_chat_msg方法获取历史聊天数据
destroy	自助操作销毁聊天SDK、播放器SDk

代码示例

 
 var vhallSDKInstance = new VhallSDK({
    ... // 微吼SDK 初始化参数
 })

 // 自助操作 发送聊天消息
 vhallSDKInstance.chat.sendChat(msg)

 // 自助操作 发送自定义聊天消息
 vhallSDKInstance.chat.sendCustomEvent(msg)
 
 // 自助操作 获取直播聊天历史记录
 vhallSDKInstance.vhall_get_live_history_chat_msg(opt)

 // 自助操作 回放拉取历史聊天记录
 vhallSDKInstance.chat.vhall_get_record_history_chat_msg(page)
 
 // 自助操作 销毁播放器和文档SDK
 vhallSDKInstance.chat.destroy()

聊天模块 功能API 说明

代码示例

聊天模块功能API 说明