文档HowTo
准备工作:注册微吼云账号,并拿到appId,如未则点击微吼云
页面引用SDK文件
在需要播放视频的页面(包括PC或H5)中引入初始化脚本
<script src="https://static.vhallyun.com/jssdk/vhall-jssdk-doc-1.0.0.js"></script>
<script src="https://static.vhallyun.com/jssdk/vhall-jssdk-base-1.0.0.js"></script>
注意:
- 直接用本地网页是调试不了的
- 上面所有文件都需要引用,而且顺序需要保持与上面一致
- 建议直接复制上面代码
创建文档容器
在需要web播放的页面位置加入播放器对象容器,也就是放一个div,然后给它取个名字,比如: my-video 。之后推流回显画面都会在这个容器里渲染,容器的大小控制您可以使用div的属性进行控制,示例代码如下:
<div id="my-doc" style="width:100%; height:450px;"></div>
注册ready事件
Vhall.ready(function(){
//todo
})
注意: 初始化完成之后,会执行ready回调事件,机制同jQuery ready事件,播放器调用逻辑需要写在此事件里。
初始化SDK配置
初始化配置:
Vhall.config({
appId :'',//应用 ID ,必填
accountId :'',//第三方用户唯一标识,必填
token:'',//token必填
})
注意: appId获取方式:登陆微吼云>>进应用管理>>取得对应AppId token生成方式:通过API生成,生成accessToken接口说明
初始化主持端文档
var doc = new VhallDoc({
docNode:'my-doc',//文档容器
width:'800'//文档显示的宽度,非必填
height:'450'//文档显示的高度,非必填
});
参数说明
name | type | require | description |
---|---|---|---|
docNode | string | yes | 文档容器 |
width | string | no | 文档显示的宽度 |
height | string | no | 文档显示的高度 |
初始化观看端文档
VhallDocPassive({
channelId:'ch_6659b2c2',//频道ID
docNode:'my-doc-area',//文档显示节点div id
width:'800',//非必填
height:'450'//非必填
});
参数说明
参数名称 | 必填 | 说明 |
---|---|---|
channelId | 是 | 频道ID |
docNode | 是 | 显示文档区域的容器 |
width | 否 | 文档区域的宽 |
height | 否 | 文档区域的高 |
完整代码