直播SDK3.0兼容旧版本升级方案

SDK DEMO地址

访问地址: http://cnstatic01.e.vhall.com/jssdk/dist/3.0.7/login.html

访问地址登录成功后,观看地址(请注意:变更为old.html) http://cnstatic01.e.vhall.com/jssdk/dist/3.0.7/old.html?app_key=app_key&signedat=signedat&sign=sign&id=roomid&account=account&username=username

升级方案使用限制

旧版本升级方案从SDK3.0.1起开始支持,以下SDK使用方式仅适用于兼容方案中的old.html页面,用来兼容SDK3.0前版本

依赖库

本SDK依赖于JQuery库,请在需要引入JQuery的页面按以下代码示例进行引入,对JQuery版本没有要求

<script src="http://cnstatic01.e.vhall.com/3rdlibs/jquery/1.11.2/jquery.min.js" type="text/javascript"></script>

引入JS文件

在需要调用SDK的页面插入以下代码以引入JS文件:

<script type="text/javascript" src="http://cnstatic01.e.vhall.com/jssdk/dist/3.0.7/VhallSDK.js"></script>

SDK初始化

使用以下的方法和参数进行SDK的初始化以及权限的验证

VHALL_SDK.init({
	   account : '',// 必填,唯一用户id,与使用第三方创建用户接口所传的third_user_id需一致)
	   username : '',// 必填,用户昵称用以在各模块中显示
	   roomid :'',// 必填,当前聊天所在活动id
	   app_key :'',// 必填,启用服务唯一验证,API/SDK权限申请后生成
	   signedat :'',// 必填,启用服务唯一验证,unix时间戳
	   sign :'',// 必填,启用服务唯一验证,有效期一小时
	   email : '',// 非必填,当前版本已不建议使用
	   videoContent : '#videoId',// 必填,视频容器
	   docContent: '#docId',// 必填,文档容器
	   x5_video_type: false,  // 非必填,启用腾讯H5同层播放器,默认false, true为开启
	   x5_video_fullscreen: false, // 非必填,字符串,启用腾讯H5全屏方式,默认false, true为开启
	   questionarieContainer: '#test' // 非必填 问卷容器
});

注1: 签名生成规则同SDK3.0
注2: 兼容方案中SDK初始化传参取消wrapper参数,H5和Flash活动文档容器统一使用docContent字段,并使用id值为参数。
注3: 兼容方案中SDK初始化传参取消protocol参数,SDK3.0.1起根据http泛协议,可以根据地址中http/https自动切换,不再需要用户通过传参切换协议。
注4: 兼容方案中SDK初始化传参取消facedom和textdom参数,facedom是聊天输入区域中自定义表情面板容器,从SDK3.0起由用户在业务层维护,SDK不再提供支持。textdom为聊天等输入内容,从SDK3.0起聊天等输入内容由用户通过调用SDK方法时,作为参数传递给SDK。

SDK API

兼容方案中,对于SDK API的调用以及传参方式沿用SDK3.0之前版本使用方式

SDK 事件监听

兼容方案中,对于SDK 事件监听的调用方式沿用SDK3.0之前版本使用方式