开放平台
首页平台概述
开发者
  • API文档
  • SDK
产品功能
  • 新手入门
  • 产品功能
常见问题
首页平台概述
开发者
  • API文档
  • SDK
产品功能
  • 新手入门
  • 产品功能
常见问题
  1. Adroid SDK
  • demo
  • JS SDK
    • 产品介绍
    • 快速接入
    • SDK 对接示例
    • 观看直播
    • 暖场视频
    • 房间消息说明
    • 互动连麦
    • 文档白板
    • 全局事件
    • 全局错误码
    • 版本更新记录
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-公告
      • 互动-商品
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-聊天
      • 互动-优惠券
      • 互动-点赞
    • 直播间拓展功能
      • 资料下载
      • 观看限制验证
      • 观看协议
      • 回放章节
  • 点播SDK
    • 点播上传SDK
    • 更新记录
  • iOS SDK
    • 整体介绍
    • 快速接入
    • SDK 登录
    • 暖场视频
    • 视频轮询
    • 直播彩排
    • 高级美颜
    • 云导播
    • 观看协议
    • 文档白板演示
    • 聊天功能
    • 视频直播
      • 发起视频直播
      • 观看视频直播
    • 互动直播
      • 观众互动
      • 推流摄像头
      • 互动直播API
      • 主播发起互动直播
      • 嘉宾加入互动直播
    • 无延迟直播
      • 主播发起无延迟直播
      • 观众观看无延迟直播
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-章节打点
      • 互动-公告
      • 互动-商品
      • 互动-计时器
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-优惠券
      • 互动-点赞
    • 直播间拓展能力
      • 直播间特色功能配置项
      • 文件下载
      • 修改角色昵称
      • 观看权限校验
      • 投屏
      • 虚拟人数
    • 观看回放
      • 观看回放
    • 防录屏
      • 跑马灯
    • 字段说明
      • 互动活动详情字段
      • 错误码说明
      • 常量定义
      • 活动详情字段说明
    • 版本更新说明
      • 版本更新信息
      • v2.3.0 到 v2.4.0 升级说明
      • v3.0.1 到 v3.2.0 升级说明
      • V2.9.0到v3.0.1升级说明
      • v6.3.0
      • v6.2.1
      • v3.2.0 到 v4.0.1
      • v2.7.0 到 v2.8.0、v2.9.0 升级说明
      • 6.5.0
      • v5.0.x 到 v6.0.0
      • v6.4.0
  • Adroid SDK
    • 整体介绍
    • 快速接入
    • SDK登录
    • 暖场视频
    • 视频轮巡功能
    • 直播彩排
    • 高级美颜
    • 云导播功能
    • 观看协议
    • 文档白板
    • 聊天功能
    • 房间消息
    • 信息采集说明
    • 视频直播
      • 发起视频直播
      • 观看视频直播
    • 互动直播
      • 互动直播API
      • 主播发起互动直播
      • 嘉宾加入互动直播
      • 观众观看互动直播
    • 无延迟直播
      • 主播发起无延迟直播
      • 观众观看无延迟直播
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-公告
      • 互动-商品
      • 互动-计时器
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-优惠券
      • 互动-点赞
    • 直播拓展功能
      • 修改角色名称
      • 文件下载
      • 投屏演示
      • 虚拟人数
      • 观看权限校验
      • 直播间特色功能配置项
    • 观看回放
      • 观看回放/点播
    • 防录屏
      • 直播水印
      • 跑马灯
    • 字段说明
      • 房间消息字段说明
      • 聊天消息字段说明
      • 活动详情字段说明
    • 版本更新说明
      • 更新记录
      • v6.4.0
      • v6.3.0
      • v6.2.3
      • v6.2.1
      • v6.2.0
      • v6.1.0
      • v6.0.0
      • v5.0.0
      • v4.1.0
      • v4.0.0
      • v3.3.0
  • APP嵌入支付说明
    • 支付调起说明
    • Scheme规则说明
  1. Adroid SDK

房间消息

房间消息#

功能说明#

房间内消息比如:点赞,互动消息,签到等;

MessageServer消息服务class#

消息服务总类

MessageServer#Callback#

消息回调监听接口

使用说明#

在观看、发起、互动的初始化时 传入自己的实现的消息监听messageCallback(new MessageEventCallback())
代码示例

消息过滤#

MessageServer#MessageSupportMsgFilterOther
1.
过滤其他人的消息,默认过滤
2.
作为观众只需要关注自己的消息,会过滤其他人的消息(比如摄像头关闭消息)
3.
作为主持人需要关注全部成员的消息,则需要关闭过滤,在具体消息里面通过用户id判断消息目标用户。
代码示例
在上方MessageEventCallback 的基础上增加 MessageSupportMsgFilterOther接口处理

MessageServer#MsgInfo#

房间消息字段说明

房间消息服务类型列表#

MessageServer#Callback#onEvent#MsgInfo#event
MsgInfo#event描述返回值支持过滤
MessageServer.EVENT_OVER直播结束null否
MessageServer.EVENT_KICKOUT踢出null否
MessageServer.EVENT_KICKOUT_RESTORE取消踢出null否
MessageServer.EVENT_DISABLE_CHAT禁言null是
MessageServer.EVENT_PERMIT_CHAT取消禁言null是
MessageServer.EVENT_CHAT_FORBID_ALL全员禁言data否
MessageServer.EVENT_CHART_DELETE聊天信息被删除msg_id_delete否
MessageServer.EVENT_DIFINITION_CHANGED切换清晰度null否
MessageServer.EVENT_START_LOTTERY开始抽奖消息键lotteryInfo否
MessageServer.EVENT_END_LOTTERY结束抽奖消息键lotteryInfo否
MessageServer.EVENT_NOTICE公告data否
MessageServer.EVENT_SIGNIN签到data否
MessageServer.EVENT_QUESTION问答开关messageInfo.status 1开启 0关闭否
MessageServer.EVENT_SURVEY发起问卷调查data否
MessageServer.EVENT_SHOWH5DOCh5文档messageInfo.watchType 1 开启文档 0 关闭文档(开启显示文档view,关闭隐藏文档view)否
MessageServer.EVENT_PAINTH5DOC文档画面加载messageInfo.h5DocView 文档展示view(DocumentView)否
MessageServer.EVENT_RESTART重新拉流null否
MessageServer.EVENT_INTERACTIVE_ALLOW_HAND举手开关messageInfo.status 1开启 0关闭否
MessageServer.EVENT_INTERACTIVE_HAND上麦申请消息data否
MessageServer.EVENT_INTERACTIVE_ALLOW_MIC接收主持人同意上麦消息data
MessageServer.EVENT_INTERACTIVE_DOWN_MIC接收下麦消息data是
MessageServer.EVENT_SWITCH_DEVICE切换设备data是
MessageServer.EVENT_INVITED_MIC被邀请上麦data否
MessageServer.EVENT_VRTC_CONNECT_SUCCESS用户上麦成功data否
MessageServer.EVENT_VRTC_DISCONNECT_SUCCESS用户下麦成功data否
MessageServer.EVENT_VRTC_CONNECT_INVITE_AGREE用户同意邀请data否
MessageServer.EVENT_VRTC_SPEAKER_SWITCH互动设置为主讲人data否
MessageServer.EVENT_VRTC_CONNECT_REFUSED拒绝申请上麦data否
MessageServer.EVENT_CONNECT_INVITE_REFUSED拒绝邀请data否
MessageServer.EVENT_VRTC_BIG_SCREEN_SET流消息 互动流设置混流大画面data否
MessageServer.EVENT_EDIT_WEBINAR_ROLE_NAME修改角色信息data否
MessageServer.EVENT_SURVEY_PUSH发起问卷提交data否
MessageServer.EVENT_QUESTION_ANSWER_SET修改问答昵称设置messageInfo.question_name 问答昵称否
MessageServer.EVENT_DIRECTOR_STREAM云导播直播间流状态messageInfo.director_stream_status 2 没有流 1 有流否
MessageServer.EVENT_VIDEO_ROUND_START轮巡开始null否
MessageServer.EVENT_VIDEO_ROUND_USERS轮巡用户List#String uids 当前参与轮巡的用户id,如果没有自己则要退出,有自己则需要参加轮巡否
MessageServer.EVENT_VIDEO_ROUND_END轮巡结束null否
MessageServer.EVENT_TIMER_START计时器开始data否
MessageServer.EVENT_TIMER_END计时器结束data否
MessageServer.EVENT_TIMER_RESET计时器重置data否
MessageServer.EVENT_TIMER_RESUME计时器 继续data否
MessageServer.EVENT_TIMER_PAUSE计时器 暂停data否
MessageServer.EVENT_PRAISE_TOTAL点赞messageInfo.likeNum 点赞数目否
MessageServer.EVENT_GIFT_SEND_SUCCESS礼物消息data否
MessageServer.EVENT_LIVE_START_REHEARSAL开始彩排null否
MessageServer.EVENT_LIVE_OVER_REHEARSAL结束彩排null否
MessageServer.EVENT_EXAM_PAPER_SEND发送直播答题null否
MessageServer.EVENT_EXAM_PAPER_END结束直播答题null否
MessageServer.EVENT_EXAM_PAPER_AUTO_END自动结束直播答题null否
MessageServer.EVENT_EXAM_PAPER_SEND_RANK直播答题公布成绩null否
MessageServer.EVENT_EXAM_PAPER_AUTO_SEND_RANK自动直播答题公布成绩null否
MessageServer.EVENT_DATA_DOWNLOAD_UPDATE更新文件下载菜单file_download_menu否

问答#

参数说明
字段描述
status开关(1开启、0关闭)
question_name问答昵称

全员禁言#

参数说明
1.
问答状态 根据全体禁言判断 如果开启禁言则根据 qa_status判断 1开启 0关闭 如果关闭全体禁言 则直接开启问答
2.
聊天 如果开启 则不可以聊 如果关闭则根据当前的 个人禁言情况
字段描述
status开关(1开启、0关闭)
chat_status公聊维度:1禁言 0取消禁言
qa_status问答维度:1禁言 0取消禁言
private_chat_status私聊维度:1禁言 0取消禁言
代码示例

抽奖#

观看直播时播主可以发起抽奖,而在移动端观看时可以接受抽奖消息

开始抽奖#

event = “MessageServer. EVENT_START_LOTTERY”
参数说明
字段描述
lotteryInfo抽奖数据类

结束抽奖#

msgInfo.event = “MessageServer. EVENT_END_LOTTERY”
参数说明
字段描述
id抽奖ID
winnerLottery是否中奖
lotteryInfo抽奖数据类
代码示例

公告#

当PC段发送一段公共消息,消息服务器会接受到这句公共消息,用户自定义显示消息样式
MessageServer.EVENT_NOTICE
参数说明
字段描述
content公告内容
publish_release_time公告发布时间
代码示例

签到#

当主播正在直播,可以发布签到,观看用户可以签到
MessageServer.EVENT_SIGNIN
参数说明
字段描述
webinar_id活动ID
id签到ID
user_id用户ID
sign_show_time签到初始时间
代码示例

问卷#

当主播正在直播,可以发布问卷,观看用户可以显示问卷

发起问卷#

参数说明
字段描述
webinar_id活动ID
id问卷ID
user_id用户ID
survey_name问卷名字
代码示例

提交问卷#

MessageServer.EVENT_SURVEY_PUSH
参数说明
字段描述
user_id提交人的id
代码示例

文档#

观看直播文档/6.7.0之后看回放也支持

文档开关#

开启显示文档view,关闭隐藏文档view
MessageServer.EVENT_SHOWH5DOC
参数说明
字段描述
watchType1 开启文档 0 关闭文档

文档画面加载#

MessageServer.EVENT_PAINTH5DOC
参数说明
字段描述
h5DocView文档展示view

连麦消息#

上麦申请#

MessageServer.EVENT_INTERACTIVE_HAND
参数说明
字段描述
role提交人的角色
user_id提交人的id
status0取消举手,1举手
nick_name提交人的昵称

接收下麦消息#

MessageServer.EVENT_INTERACTIVE_DOWN_MIC
MessageServer#MessageSupportMsgFilterOther如果开启过滤则接收全部否只接受自己的
参数说明
字段描述
role提交人的角色
user_id提交人的id
nick_name提交人的昵称

切换设备#

MessageServer.EVENT_SWITCH_DEVICE
MessageServer#MessageSupportMsgFilterOther如果开启过滤则接收全部否只接受自己的
参数说明
字段描述
device1麦克风 2摄像头
user_id提交人的id
status0关 1开

切换主讲人#

MessageServer.EVENT_VRTC_SPEAKER_SWITCH
参数说明
字段描述
roomJoinId主讲人id

互动流设置混流大画面#

MessageServer.EVENT_VRTC_BIG_SCREEN_SET
参数说明
字段描述
roomJoinId大画面人的id

修改角色信息#

MessageServer.EVENT_EDIT_WEBINAR_ROLE_NAME
参数说明
字段描述
edit_role_name被修改昵称
edit_role_type被修改的角色

计时器#

只有无延迟观看模式才支持显示计时器

计时器开始#

MessageServer.EVENT_TIMER_START 根据状态显示计时器UI 开始倒计时
参数说明
字段描述
timerData计时器数据类

计时器结束#

MessageServer.EVENT_TIMER_END 关闭计时器UI

计时器重置#

MessageServer.EVENT_TIMER_RESET 关闭计时器UI
参数说明
字段描述
timerData计时器数据类

计时器暂停#

MessageServer.EVENT_TIMER_PAUSE 停止倒计时
参数说明
字段描述
timerData计时器数据类

点赞#

MessageServer.EVENT_PRAISE_TOTAL
参数说明
字段描述
likeNum点赞总数

礼物#

MessageServer.EVENT_GIFT_SEND_SUCCESS
参数说明
字段描述
giftInfoData礼物数据类

彩排#

快问快答#

参数说明
字段描述
ExamInfo快问快答数据类

更新文件下载菜单#

参数说明
MenuListInfoData#MenuItem
字段描述
id文件下载菜单id
name菜单名称
type类型 文件下载 为9
status是否显示菜单: 0 不显示 1 显示
修改于 2025-05-27 10:33:25
上一页
聊天功能
下一页
信息采集说明
Built with