全局事件说明
调用方式:
在实例化,VhallSDK 之后, 用vhallSDK的实例句柄,用$on方法进行使用。
事件 名称 | 功能描述 | 参数 | 返回值 | 备注 | ||||
---|---|---|---|---|---|---|---|---|
ready | 初始化完成 | null | null | |||||
playerReady | 播放器初始化成功 | null | null | |||||
streamOver | Flash 类型活动,直播结束 | null | null | 仅Flash 类型活动会派发此事件 | ||||
publishStart | Flash 类型活动,直播开始事件 | null | null | 仅Flash 类型活动会派发此事件 | ||||
live_start | H5类型活动 ,直播开始事件 | null | null | 仅H5 类型活动会派发此事件 | ||||
live_over | H5类型活动 ,直播结束事件 | null | null | 仅H5 类型活动会派发此事件 | ||||
userOnline | 用户上线通知 | callback(datat), 类型:Function | data,类型:Object | data.data = {hide: false,socket_id: "1TBpcjxU2mf2ye6vDy-r",type: "Join"} | ||||
userOffline | 用户离线通知 | callback(data), 类型:Function | data,类型:Object | data.data = {hide: false,socket_id: "94TPRGTW4LFT2KstDy-V",type: "Leave"} | ||||
chatMsg | 聊天消息监听 | callback(data), 类型:Function | data,类型:Object | 返回消息体 | ||||
sendCustomEvent | 发送自定义消息监听 | callback(data), 类型:Function | data,类型:Object | 返回消息体 | ||||
customEvent | 自定义广播消息监听 | callback(data), 类型:Function | data,类型:Object | 返回消息体 | ||||
question_answer_open | 开启问答 | callback(data), 类型:Function | data,类型:Object | data.data = {nick_name: '主持人',type: 'question_answer_open' } | ||||
question_answer_close | 关闭问答 | callback(data) , 类型:Function | data,类型:Object | data.data = {nick_name: '主持人',type: 'question_answer_close' } | ||||
question_answer_commit | 主讲人回复问答消息 | callback(data) , 类型:Function | data,类型:Object | 主讲人回复消息 | ||||
question_answer_backout | 主讲人撤回问答回复 | callback(data) , 类型:Function | data,类型:Object | data.data = {question_answer_id: "4137",type: "question_answer_backout"} | ||||
startSign | 开始签到环节 | callback(data) , 类型:Function | data,类型:Object | data.data = {room_id:"lss_32f5a298",sign_creator_avatar: "//a.com/15.jpeg",sign_creator_id:"16420899",sign_creator_nickname: "Batur",sign_id: "19061",sign_show_time: "30",type: "sign_in_push"} | ||||
sendSign | 签到 | callback(data), 类型:Function | data,类型:Object | data = {code:200} | ||||
questionnaire_push | 打开问卷消息 | callback(data), 类型:Function | data,类型:Object | data.data = {nick_name: "Batur",questionnaire_id: "271631",room_join_id: "16420899",room_role: "1",type: "questionnaire_push"} questionnaire_id:问卷id room_role:房间角色 1主持人 2观众 3嘉宾 4助理 | ||||
questionarie_submit_success | 问卷提交成功 | callback(data), 类型:Function | data,类型:Object | data.data = {naire_id: 问卷id} | ||||
questionarie_submit_error | 问卷服务提交失败 | callback(data), 类型:Function | data,类型:Object | 返回错误信息error | ||||
questionPagerList | 获取问卷列表 | null | null | 返回问卷数据data | ||||
lotteryStart | 开始抽奖 | callback(data), 类型:Function | data,类型:Object | data.data = {lottery_creator_avatar: "//ll.com/upload/15.jpeg",lottery_creator_id: "16420899",lottery_creator_nickname: "Batur",lottery_id: "6904",lottery_number: "1",lottery_status: 0,lottery_type: "1",room_id: "lss_32f5a298",type: "lottery_push"}lottery_id:奖品id,lottery_number:中奖人数lotteryResultNotice | 结束抽奖 | null | callback(datat), 类型:Function | data.data = ["lottery_winners" : []] 返回中间人数组 |
disadbleChat | 禁言 | callback(datat), 类型:Function | data,类型:Object | data.data = {nick_name: "dazhen" ,role_name: "2" ,room_join_id: "16420899" ,target_id: "16422570" ,type: "disable"} target_id:被禁言成员id | ||||
permitChat | 恢复禁言 | callback(data), 类型:Function | data,类型:Object | 消息体说明:{data: {target_id: "16422570", type: "permit"} }target_id: 取消禁言成员id | ||||
forbidChat | 全体禁言 | callback(data), 类型:Function | data,类型:Object | data.data = {allStatus: 1} allStatus:1为全员禁言,0为恢复全员禁言 | ||||
kickoutrestore | 恢复踢出 | null | null | |||||
kickout | 踢出 | callback(data), 类型:Function | data,类型:Object | data.data = {role_name: "2", room_join_id: "16420899", target_id: "16422570", type: "room_kickout"} target_id: 踢出id | ||||
room_announcement | 收到公告消息 | callback(data), 类型:Function | data,类型:Object | 返回数据 | ||||
UpdateUser | 更新用户信息 | null | null | |||||
hostNotice | 主持人下线消息 | null | null | |||||
error | 错误日志 | null | callback(data),类型:Object | 返回 {msg, data} msg是错误提示信息, data是错误消息体包含code,msg,data信息 |
代码示例
var vhallSDKInstance = new VhallSDK({
... // 微吼SDK 初始化参数
})
// 播放器初始化成功
vhallSDKInstance.$on('ready', () => {
})
// 播放器初始化成功
vhallSDKInstance.$on('playerReady', () => {
})
// 直播停止推流
vhallSDKInstance.$on('streamOver', () => {
})
// 直播开始推流
vhallSDKInstance.$on('publishStart', () => {
})
// H5直播开始事件
vhallSDKInstance.$on('live_start', () => {
})
// H5直播结束事件
vhallSDKInstance.$on('live_over', () => {
})
// 用户上线通知
vhallSDKInstance.$on('userOnline', (data) => {
})
// 用户离线通知
vhallSDKInstance.$on('userOffline', (data) => {
})
// 聊天消息监听
vhallSDKInstance.$on('chatMsg', (data) => {
})
// 发送自定义消息监听
vhallSDKInstance.$on('sendCustomEvent', (data) => {
})
// 自定义广播消息监听
vhallSDKInstance.$on('customEvent', (data) => {
})
// 开启问答
vhallSDKInstance.$on('question_answer_open', (data) => {
})
// 关闭问答
vhallSDKInstance.$on('question_answer_close', (data) => {
})
// 主讲人回复问答消息
vhallSDKInstance.$on('question_answer_commit', (data) => {
})
// 主讲人撤回问答回复
vhallSDKInstance.$on('question_answer_backout', (data) => {
})
// 开始签到环节
vhallSDKInstance.$on('startSign', (data) => {
})
// 签到
vhallSDKInstance.$on('sendSign', (data) => {
})
// 打开问卷消息
vhallSDKInstance.$on('questionnaire_push', (data) => {
})
// 问卷提交成功
vhallSDKInstance.$on('questionarie_submit_success', (data) => {
})
// 问卷服务提交失败
vhallSDKInstance.$on('questionarie_submit_error', (error) => {
})
// 获取问卷列表
vhallSDKInstance.$on('questionPagerList', (data) => {
})
// 开始抽奖
vhallSDKInstance.$on('lotteryStart', (data) => {
})
// 结束抽奖
vhallSDKInstance.$on('lotteryResultNotice', (data) => {
})
// 禁言
vhallSDKInstance.$on('disableChat', (data) => {
})
// 恢复禁言
vhallSDKInstance.$on('permitChat', (data) => {
})
// 全体禁言1为全员禁言,0为恢复全员禁言
vhallSDKInstance.$on('forbidChat', (data) => {
})
// 恢复踢出
vhallSDKInstance.$on('kickoutrestore', () => {
})
// 踢出
vhallSDKInstance.$on('kickout', (data) => {
})
// 收到公告消息
vhallSDKInstance.$on('room_announcement', (data) => {
})
// 更新用户信息
vhallSDKInstance.$on('UpdateUser', () => {
})
// 错误日志统一对外消息
vhallSDKInstance.$on('error', ({msg, data}) => {
})
// 主持人下线消息
vhallSDKInstance.$on('hostNotice', () => {
})