类名 VhallDocPassive
观看端初始化成功后,会自动创建画板和文档区域,当主持端有操作时,会自动同步显示。
初始化方法
/**
* 初始化文档观看端
*/
var doc = new VhallDocPassive({
channelId:'ch_6659b2c2',//频道ID
docNode:'my-doc-area',//文档显示节点div id
showLastPage:true,//显示上一次操作的文档,缺省或传空值,则不会显示,传值为true则会显示。
synchWithVideo:false,//设置文档消息与视频同步,此参数在直播观看+文档观看场景下使用,用于同步文档内容与视频,true为同步处理,false 为不处理。单文档场景下不需要设置此参数,或设置为false
width:'800',//非必填
height:'450',//非必填
syncDelay: 0// 设置文档观看延时,默认为0秒
});
参数说明
参数名称 | 必填 | 说明 |
---|---|---|
channelId | 是 | 频道ID |
docNode | 是 | 显示文档区域的容器 |
width | 否 | 文档区域的宽 |
height | 否 | 文档区域的高 |
showLastPage | 否 | 显示上一次操作的文档 |
synchWithVideo | 否 | 设置文档消息与视频同步 |
文档区域大小重置
/**
* 重置文档区域大小,简单调用
* @param {number} 文档宽度,数值型
* @param {number} 文档高度,数值型
*/
doc.resize(160,90);
/**
* 重置文档区域大小,带回调调用
* @param {number} 文档宽度,数值型
* @param {number} 文档高度,数值型
* @param {function} 成功回调,非必填
* @param {function} 失败回调,非必填
*/
doc.resize(160,90,function(){
console.log('重置成功!');
},function(reason){
console.log('重置失败:' + reason);
});
destroy
销毁文档对象
//销毁文档对象
doc.destroy();