全局事件

监听方式

在实例化，VhallSDK 之后，用vhallSDK的实例句柄，用$on方法进行使用。

具体监听事件

- 房间消息

事件名称	功能描述	参数	返回值	备注
ready	初始化完成	-	-
live_start	H5类型活动，直播开始事件	-	-	仅H5 类型活动会派发此事件
live_over	H5类型活动，直播结束事件	-	-	仅H5 类型活动会派发此事件
onlinePopulation	当前房间内浏览量pv以及在线终端数	-	data, 类型：Object	{pv: 热度(包含真实 + 虚拟热度), uv:在线终端数}
UpdateUser	更新用户信息	-	-
UpdateRoleName	更新自定义角色名称	-	data, 类型: Object	返回数据 host_name:主持人昵称，assistant_name: 助理昵称， guest_name: 嘉宾昵称
hostNotice	主持人下线消息	-	-
error	错误日志	-	callback(data),类型：Object	返回 {msg, data} msg是错误提示信息， data是错误消息体包含code,msg,data信息
vrtc_big_screen_set	设为主讲人	callback(data), 类型：Function	data，类型：Object	data.data ={ avatar: "", device_status: "1", device_type: "0", kicked_out: 0, nick_name: "411314", prohibit_speak: 0, room_join_id: "visit_v1457694333058174976", room_role: "4", target_id: "visit_v1457694333058174976", type: "vrtc_big_screen_set" }
vrtc_speaker_switch	设置主屏	callback(data), 类型：Function	data，类型：Object	data.data = { avatar: "", device_status: "1", device_type: "0", kicked_out: 0, nick_name: "411314", nospeck: 0, prohibit_speak: 0, room_join_id: "visit_v1457694333058174976", room_role: "4", target_id: "visit_v1457694333058174976", type: "vrtc_speaker_switch" }
streamOver	Flash 类型活动，直播结束	-	-	仅Flash 类型活动会派发此事件，v3.5.0已失效
publishStart	Flash 类型活动，直播开始事件	-	-	仅Flash 类型活动会派发此事件 v3.5.0已失效

- 播放器

事件名称	功能描述	参数	返回值	备注
playerReady	播放器初始化成功	-	-
vhallplay_LAG_REPORT	视频卡顿	-	-
vhallplay_LAG_RECOVER	卡顿恢复	-	-
vhallplay_AUTOPLAY_FAILED	自动播放失败	-	e	错误信息
vhallplay_ERROR	播放器出错	-	e	错误信息
vhallplay_EXITFULLSCREEN	播放器退出全屏	-	-
vhallplay_IS_FULL_SCREEN	播放器是否是全屏	-	status	status: true 全屏状态, false：非全屏状态
vhallplay_PLAY	播放器播放	-	-
vhallplay_PAUSE	播放器暂停	-	-
noSupportVideo	H5类型活动，加密视频支持能力判断事件	-	-	如果当前浏览器无法支持加密视频播放(回放/点播)，将触发该事件监听。JSSDK3.1.8版本起支持该能力
vhallplay_CURRENTTIME_CHANGE	当前时间改变	-	-	点播当前播放时间被改变时触发。JSSDK3.5.4版本起支持该能力
vhallplay_LOOP_CHANGE	循环状态改变	-	-	点播循环状态被改变时触发。JSSDK3.5.4版本起支持该能力
vhallplay_MUTE_CHANGE	静音状态改变	-	-	静音状态被改变时触发。JSSDK3.5.4版本起支持该能力
vhallplay_RATE_CHANGE	倍速改变	-	-	倍速被改变时触发。JSSDK3.5.4版本起支持该能力
vhallplay_VOLUME_CHANGE	声音改变	-	-	声音被改变时触发。JSSDK3.5.4版本起支持该能力
vhallplay_FULLSCREEN_CHANGE	全屏状态改变	-	-	全屏状态改变时触发。JSSDK3.5.4版本起支持该能力
vhallplay_DEFINITION_CHANGE	当前清晰度改变	-	-	当前清晰度改变时触发(卡顿时自动切清晰度触发，手动切换不触发)。JSSDK3.5.4版本起支持该能力
vhallplay_PLAYING	视频正在播放中	-	-	视频正在播放中触发。JSSDK3.5.4版本起支持该能力
vhallplay_PROGRESS	视频加载中	-	-	点播视频加载中时触发。JSSDK3.5.4版本起支持该能力
vhallplay_LOADEDMETADATA	视频元数据加载完成	-	-	视频元数据加载完成时触发。JSSDK3.5.4版本起支持该能力
vhallplay_LOADED	视频加载完成	-	-	视频加载完成时触发。JSSDK3.5.4版本起支持该能力
vhallplay_ENDED	播放完毕	-	-	点播视频播放完毕时触发。JSSDK3.5.4版本起支持该能力
vhallplay_OPEN_BARRAGE	开启弹幕	-	-	开启弹幕时触发。JSSDK3.5.4版本起支持该能力
vhallplay_CLOSE_BARRAGE	关闭弹幕	-	-	关闭弹幕时触发。JSSDK3.5.4版本起支持该能力
vhallplay_CLEAR_BARRAGE	清空弹幕	-	-	清空弹幕时触发。JSSDK3.5.4版本起支持该能力
vhallplay_TIMEUPDATE	播放时间改变	-	-	播放时间改变时触发。JSSDK3.5.4版本起支持该能力

- 聊天

事件名称	功能描述	参数	返回值	备注
userOnline	用户上线通知	callback(data), 类型：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	返回消息体
chatDelete	聊天消息删除	callback(data), 类型：Function	{ msg_id: 0 // 消息id }	3.7.4及以上支持
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"}
disableChat	禁言	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	取消踢出	-	-
sso_kickout	相同账号踢出	-	-
kickout	踢出	callback(data), 类型：Function	data，类型：Object	data.data = {role_name: "2", room_join_id: "16420899", target_id: "16422570", type: "room_kickout"} target_id: 踢出id

- 文档白板

事件名称	功能描述	参数	返回值	备注
DocOpenStatus	文档白板开关状态	callback(data), 类型：Function	data，类型：String	该字段用来监听主播是否开启白板或者文档对观众展示，但不能用于判断白板和文档之前切换场景。备注：on: 开启， off: 关闭
DocAndWhiteStatus	当前开启白板/文档	callback(data), 类型：Function	data，类型：String	该字段用来监听当前是显示文档还是白板，但不能用于判断白板和文档是否对用户展示的场景。备注：document: 当前开启文档， board: 当前开启白板

- 互动连麦

事件名称	功能描述	参数
mic_ready	上麦初始化完成	-
vrtc_connect_open	允许举手上麦	-
vrtc_connect_close	不允许举手	-
vrtc_connect_invite	主持人邀请上麦	{ avatar: "",//头像 device_status: "1",//设备状态1：可上麦2：不可上麦 device_type: "2",//设备类型1:移动端2:PC端 event_type: "vrtc_connect_invite",//事件类型 inviter_role_name: "1",//邀请角色1主持人 kicked_out: 0, nick_name: "vhall",//昵称 prohibit_speak: 0, room_join_id: "163472197", room_role: "2",//角色2观众 target_id: "163472197",//邀请用户id type: "vrtc_connect_invite"}
vrtc_connect_agree	同意上麦	{avatar: "", device_status: "1", device_type: "2", event_type: "vrtc_connect_invite_agree", extra_params: "", inviter_account_id: "161265412", kicked_out: 0, nick_name: "vhall", prohibit_speak: 0, room_join_id: "163472197", room_role: "2", type: "vrtc_connect_invite_agree"}
vrtc_connect_apply_cancel	取消上麦	-
vrtc_connect_success	用户上麦成功	{avatar: "", device_status: "1", device_type: "2", event_type: "vrtc_connect_success", kicked_out: 0, member_info: {},//上麦人员信息 nick_name: "vhall", prohibit_speak: 0, room_join_id: "163472197", room_role: "2", type: "vrtc_connect_success", vrtc_audio_status: "on",//音频状态 vrtc_connect_type: 1, vrtc_video_status: "on"//视频状态}
vrtc_connect_invite_refused	用户拒绝上麦	{avatar: "", device_status: "1", device_type: "2", event_type: "vrtc_connect_invite_refused", extra_params: "", inviter_account_id: "161265412", kicked_out: 0, nick_name: "vhall", prohibit_speak: 0, room_join_id: "163472197", room_role: "2", type: "vrtc_connect_invite_refused"}
apply_mic_success	申请上麦成功
vrtc_disconnect_success	下麦成功	{ event_type: "vrtc_disconnect_success", member_info: {}, nick_name: "vhall", room_join_id: "163472197", room_role: "2", target_id: "163472197", type: "vrtc_disconnect_success", vrtc_reason: ""}
create_local_stream_success	本地流创建成功	streamId：本地流id
interactReady	互动sdk初始化成功	{members:[],//非自己和非特殊流的远端流列表, special:[],//特殊流列表包含插播和桌面共享流, isSpeakOn:true/是否在麦上}
remoteAddStream	互动远端流加入信息	[{accountld: "16623362", attributes: { roleName: 1, accountld:'16623362', nickname: 't10002', nickName: 't10002', role: 1}, audioMuted: false, streamld:"512318688187516100”//远端流id, streamType: 2,//流类型0纯音频，1：只是视频,2：音视频 3：屏幕共享，4:插播 videoMuted: false]远端流列表
remoteRemoveStream	互动远端流离开信息	{id:"270464373034610050",//流id type: 3//流类型}
OUTPUT_LEVEL	订阅消息（声音源实时输出）
EVENT_REMOTESTREAM_MUTE	流音视频状态改变事件	当远端流的视频或音频被禁用或启用后会触发该事件

- 互动工具

包含问卷、问答、抽奖、计时器、公告、签到等互动工具消息。

事件名称	功能描述	参数	返回值	备注
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"}
endSign	主持人结束签到	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_end"}
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	获取问卷列表	-	-	返回问卷数据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	结束抽奖	-	callback(datat), 类型：Function	data.data = ["lottery_winners" : []] 返回中间人数组
timer_start	计时器开始	callback(datat), 类型：Function	data，类型：Object	data.data = {duration: "600",is_all_show: "1",is_timeout: "1",role_name: "1",room_id: "lss_e6693b1c",type: "timer_start"}
timer_pause	计时器暂停	callback(datat), 类型：Function	data，类型：Object	data.data = {remain_time: 555,role_name: 1,type: "timer_pause"}
timer_end	计时器结束	callback(datat), 类型：Function	data，类型：Object	关闭直播时触发。data.data = {room_join_id: 16421489，switch_type: “1"，type: "live_over"}
timer_reset	计时器重置	callback(datat), 类型：Function	data，类型：Object	data.data = {duration: “600”，is_all_show: “1"，is_timeout: “1"，role_name: “1"，room_id: “lss_e6693b1c"，type:"timer_reset"}
timer_resume	计时器继续，与timer_pause配合使用	callback(datat), 类型：Function	data，类型：Object	data.data = {room_join_id: 16421489，switch_type: “1"，type: "live_over"}
timer_info_init	刷新时，若是有计时器进度信息，获取当前计时器进度。通过此消息可监听到查询计时器进度 - 一次触发	callback(datat), 类型：Function	data，类型：Object	data.data = { duratio: 0 ，// 总时间，单位秒 is_all_show：0，// 是否所有人可见 0 : 不可见, 1 : 可见 is_timeout：0，// 是否允许超时 0=否 ,1= 是， remain_time：100，// 剩余时间，单位秒， status： 4 // 4表示暂停，计时器暂停时刷新等情况下返回}
openQuestion	获取问卷	Data, 类型：Object	-	该事件为事件派发，由用户触发后，向JSSDK内部派发事件，并传递参数问卷ID。
questionarie_last_info	获取当前活动最近一个问卷	Data，类型：Object	-	该事件在用户进入或刷新时，如果有历史问卷，将派发该消息，仅生效于化蝶活动
room_announcement	收到公告消息	callback(data), 类型：Function	data，类型：Object	返回数据

- 视频轮巡

事件	名称	功能描述	返回值	备注
VIDEO_POLLING_READY_START	直播间已开启视频轮巡	直播间已开启视频轮巡，观众再进入即可收到该消息	-	-
VIDEO_POLLING_START	开始视频轮巡	主持人开始视频轮询，将会推送您摄像头图像到主持人端	-	-
VIDEO_POLLING_END	结束视频轮巡	主持人结束视频轮巡	-

- 文档融屏

事件	名称	功能描述	返回值	备注
speakerAndShowLayout	文档融屏设置	直播间开启文档融屏设置	0:未开启，1:开启

- 拓展功能

事件	名称	功能描述	返回值	备注
customerMenuFile	资料下载菜单	用于直播课件、白皮书等资料的留资下载	{ id: 16421489，// 菜单id name: “资料下载" //菜单名称 }	3.7.4及以上支持

代码示例

注意事项

1、 userOnline事件监听的返回对象内根据哪个字段区分用户类型的？

答：role_name字段 1主持 2观众 3嘉宾 4 助理

监听方式#

具体监听事件#

- 房间消息#

- 播放器#

- 聊天#

- 文档白板#

- 互动连麦#

- 互动工具#

- 视频轮巡#

- 文档融屏#

- 拓展功能#

代码示例#

注意事项#

监听方式

具体监听事件

- 房间消息

- 播放器

- 聊天

- 文档白板

- 互动连麦

- 互动工具

- 视频轮巡

- 文档融屏

- 拓展功能

代码示例

注意事项