直播调用

获取直播功能信息

聊天和问答需要获取用户标识与头像，需提前使用第三方创建用户接口创建用户，如传入的第三方用户信息未匹配到用户标识，将自动进行创建，并默认为游客以及使用微吼的默认头像。目前聊天和问答模块只支持观看端，如需要进行管理操作（禁言、踢出、过滤以及回答等功能），请前往微吼平台上进行操作

主要调用API

tips： 蓝色标注为最新版本新增方法

对应城市编号

响应事件API

tips： 蓝色标注为最新版本新增相应消息

注意：chatMsg中收到的消息"type":"image"时表示图片类型，其中image_urls:['url','url']图片链接 ,图片链接前缀为https://cnstatic01.e.vhall.com/upload/ 图片支持动态大小缩放，使用方法参考：https://help.aliyun.com/document_detail/44688.html?spm=a2c4g.11186623.6.1238.3bb0c1f60HfRCX

VHALL_SDK客户端错误代码

VHALL_SDK客户端播放器初始化说明

注意：播放器初始化时会提供一套control控制，pc会提供弹幕输入控制，在使用时如需自定义，请自行用样式覆盖 如：

// 控制弹幕输入隐藏
.vhallPlayer-container .vhallPlayer-barrage-box{
   display: none !important;
}

主要代码示例

所有api及event事件的使用样例 SDK准备就绪后触发事件

     /**
     * [ready sdk准备就绪]
     */
    VHALL_SDK.on('ready', function() {
        VHALL_SDK.getUserinfo();
        /**

         * {
         *     avatar:"//cnstatic01.e.vhall.com/static/images/watch/head50.png" //头像
         *     forbidchat:"" //0:未开启全员禁言，1：已开启全员禁言
         *     is_gag:0 //0：未禁言，1：禁言
         *     is_kickout:0 //0：未踢出，1：踢出
         *     role:"user"//用户角色
         *     userid:"用户参会id"
         *     username:"昵称"
         * }
         */
        VHALL_SDK.getRoominfo();
        /**

         *  {
         *     type: 1 // 1：活动直播中，2：预约中，3：活动结束
         *     openQuestion : 1 //1: 开启，0 || ''：关闭
         * }
         */
    });

SDK调用错误事件

    /**

     * [error sdk调用错误事件]
     * @param  {[type]} msg [description]
     */
    VHALL_SDK.on('error', function(msg) {
        console.log(msg);
    });`</code>`

播放器就绪后触发事件

    VHALL_SDK.on("playerReady", function(){
     let speedList = VHALL_SDK.player.getSpeedList()
	 console.log('倍速列表：' + speedList)
	 /**
     * 设置倍速
     */
	 VHALL_SDK.player.playSpeed(1.5)
    /**
     * 可播线路消息
     */
    VHALL_SDK.player.on('canPlayLines', function(msg) {
        var _src = '';
        //  i 的值为之后调用方法VHALL_SDK.player.setPlayerLine的传参
        for (var i in msg) {
            _src += `<li>` + i + `</li>`;
        }
   $("#lines").html(_src).find("li").eq(0).addClass('active');
    });
    /**

     * 可播清晰度消息
     */
    VHALL_SDK.player.on('canPlayDefinitions', function(msg) {
        var _src = '';
         //  i 的值为之后调用方法VHALL_SDK.player.setPlayerDefinition的传参
        for (var i in msg) {
            _src += `<li>` + i + `</li>`;
        }
        $("#definitions").html(_src).find("li").eq(0).addClass('active');
    });
});
// 监听主持人上下线消息
VHALL_SDK.on('hostNotice', function (msg) {
  if (msg.type == 'online') {
    console.log('主持人上线');
  } else {
    console.log('主持人下线');
  }
});
VHALL_SDK.queryRoominfo().then(res => {
	console.log('----实时通过接口获取活动信息----');
 	console.log(res)
})

活动开始推流
  VHALL_SDK.on('publishStart', function(msg) {
            alert('活动开始推流');            
        });`</code>`
直播结束
`<code>`
  VHALL_SDK.on('streamOver', function(msg) {
            alert('活动已结束');            
        });`</code>`

用户上线

    /**

     * [userOnline 用户上线]
     * @param  {[type]} msg [description]
     */
    VHALL_SDK.on('userOnline', function(msg) {
        console.log(msg);
    });`</code>`
    
用户下线

    /**

     * [userOffline 用户下线]
     * @param  {[type]} msg [description]
     */
    VHALL_SDK.on('userOffline', function(msg) {
        console.log(msg);
    });`</code>`

收到直播聊天消息

    /**

     * [chatMsg 直播收到聊天消息]
     * @param  {[type]} msg [object]
     */
    VHALL_SDK.on('chatMsg', function(msg) {
        console.log(msg);
    });`</code>`

直播消息发送后触发事件

     * [sendChat 直播消息发送后事件] （H5活动不会调用回调函数）
     */
    VHALL_SDK.on('sendChat, function(msg) {
        console.log(msg);
    });`</code>`

问答消息发送后触发事件

    /**

     * [sendQuestion 直播问答消息发送事件]
     */
    VHALL_SDK.on('sendQuestion, function(msg) {
        console.log(msg);
    });
    
直播禁言消息

    /**

     * [disadbleChat 直播禁言消息]
     * @param  {[type]} [禁言用户id]
     */
    VHALL_SDK.on('disadbleChat', function(userid) {
        console.log(userid);
    });`</code>`
    
直播恢复禁言消息

    /**

     * [forbidchat 直播全员禁言消息]
     * @param  {[type]} status [1:开启，0：关闭]
     */
    VHALL_SDK.on('forbidChat', function(status) {
        console.log(status);
    });

直播踢出消息

    /**

     * [kickout 直播踢出消息]
     * @param  {[type]} userid [被踢出用户id]
     */
    VHALL_SDK.on('kickout', function(userid) {
        console.log(userid);
    });
        
直播恢复踢出消息

    /**

     * [kickoutRestore 直播恢复踢出消息]
     * @param  {[type]} userid [恢复踢出用户id]
     */
    VHALL_SDK.on('kickoutRestore', function(userid) {
        console.log(userid);
    });
       
获取直播历史消息成功回调

    /**

     * [vhall_live_history_chat_msg 获取直播历史消息成功回调]
     * @param  {[arraylist]} msg [数据数组]
     */
    VHALL_SDK.on('vhall_live_history_chat_msg', function(msg) {
        console.log(msg);
    });
    
获取回放历史消息成功回调

    /**

     * [vhall__record_history_chat_msg 获取回放历史消息成功回调]
     * @param  {[arraylist]} msg [数据数组，回放中有curr_page,total,total_page有数据]
     */
    VHALL_SDK.on('vhall_record_history_chat_msg', function(msg) {
        console.log(msg);
    });
    
问答开关消息

    /**

     * [questionSwitch 直播问答开关消息]
     * @param  {[type]} msg [msg.status 1：开启，0：关闭]
     */
    VHALL_SDK.on('questionSwitch', function(msg) {
        console.log(userid);
    });
    
发送问答消息后触发事件
`<code>`
    /**

     * [sendQuestion 直播问答消息发送事件]
     */
    VHALL_SDK.on('sendQuestion, function(msg) {
        console.log(msg);
    });
    
收到问答消息

    /**

     * [question 直播问答消息]
     * @param  {[type]} msg [消息体]
     */
    VHALL_SDK.on('questionMsg', function(msg) {
        console.log(userid);
    });
    
拉取问答消息后触发事件

    /**

     * [getQuestionList 获取直播问答历史消息]
     * @type {[type]}
     */
    VHALL_SDK.getQuestionList();
	
	/**
    * 监听主讲发送的问卷消息
    * @param  {[type]} msg [问卷消息体]
    */
	VHALL_SDK.on('questionPagerList', function (msg) {
	  console.log('-----------收到主讲发送的问卷消息-----------')
	  console.log(msg)
	});
	
	/**
    * 监听抽奖开始消息
    * @param  {[type]} msg [消息体]
    */
	VHALL_SDK.on('lotteryStart', function (msg) {
	   alert('抽奖开始')
	});
	
	/**
    * 监听抽奖结束消息
    * @param  {[type]} msg [消息体]
    */
	VHALL_SDK.on('lotteryResultNotice', function (msg) {
	   // msg: {winners: [中奖用户列表], lottery_id:'抽奖id', won: true| false}
	   // won 当前用户是否中奖
	   window.lotteryData = msg
       var lotteryTip = msg.won ? '恭喜中奖，请填写中奖信息' : '抽奖结束，很遗憾未中奖'
       alert(lotteryTip)
       if(msg.won){
         $('.lottery-box').css('display','block')
       }
	});
	
	/**
    * 监听提交问卷答案成功消息
    * @param  {[type]} msg [消息体]
    */
	VHALL_SDK.on('questionarie_submit_success', function (msg) {
	   alert('问卷提交成功')
	});
	
	/**
    * 监听提交问卷答案失败消息
    * @param  {[type]} msg [消息体]
    */
	VHALL_SDK.on('questionarie_submit_error', function (msg) {
	   alert('问卷提交失败')
	});
	
	/* 发送问卷答案，报文样例 */
	var questionPager = {
		survey_id: "8102",
		data: {
			text: {
			  "7722": "少时诵诗书所"
			},
			radio: {
				"7720": {
				   "13275": "选项1"
				}
			},
			checkbox: {
				"7721": {
					"13277": "选项1",
					"13278": "选项2",
					"13279": "是是是"
				}
			},
			select: {
				"7723": "19,1188"
			}
		}
	};
	VHALL_SDK.sendQuestionPagerAnswer(questionPager)
	监听H5文档和白板的切换事件
	VHALL_SDK.on('panelchange',function(type){
		if(type=='document'){
			//文档区域已切换为文档类型
		}else{
			//文档区域已切换为白板类型
		}
	})
	监听H5文档观众是否可见事件
     VHALL_SDK.on('docvisibility',function(data){
        if(data.status == 'off'){
          // 文档观众不可见
        }else{
           // 文档观众可见
          }
     })