快速开始

文档流程

微吼云文档流程图

使用文档前准备

1 前提条件

  • 演示与观看工具

    实现文档功能需要具备演示文档和观看文档的工具,微吼云提供演示/观看SDK及体验Demo,可以通过Demo进行文档的演示和观看

    通过微吼云提供的下载页,下载安装演示/观看文档SDK及Demo。

2 操作步骤

2.1 登录

登录微吼云控制台

2.2 创建应用

详情参考如何创建应用

2.3 获取app_id

详情如何参考获取app_id

2.4 设置包名&签名

如需集成移动端SDK,则需设置包名&签名,详情参考设置包名&签名

2.5 添加服务

创建应用后,点击添加服务,弹出添加服务对话框,选择文档服务,点击确定,文档服务添加成功。

2.6 获取channel_id

channel_id为频道ID,用户可以通过频道进行文档演示和观看,channel_id可通过接口或API在线测试工具获取

2.6.1 接口获取

可通过接口获取channel_id,具体参考创建频道

2.6.2 API在线测试工具

参考通过在线测试接口工具完成获取频道ID

2.7 获取access_token

access_token即权限,调用接口生成access_token将传入SDK,SDK在请求时会附带access_token,具体方式参考生成access_token接口和API在线测试工具。

: access_token过期时间,默认为一天,最大为一天,过期后需要重新生成access_token。

2.7.1 接口获取

可通过接口获取access_token,具体参考生成access_token接口

2.7.2 API在线测试工具获取

参考通过在线测试接口工具完成获取access_token

上传文档

文档可通过API和控制台进行上传,以下分别以API和控制台为例进行说明。

API

支持通过服务端接口上传文档,具体参考上传文档接口

控制台

文档管理页面点击上传,可进行文档上传

文档演示

文档观看可通过微吼云提供的SDK(JS),以下以SDK Demo为例进行说明。

JS SDK Demo

1演示地址

https://static.vhallyun.com/jssdk/vhall-jssdk-doc/test/index.html

2实例化

页面中依次输入token、appid、roomid、文档区域宽、文档区域高,点击实例化,进入文档演示页面

注: roomid为选填项,不填写roomid时,不发起直播只进行文档演示。

3文档演示

可在页面选择文档进行加载,并对文档进行翻页、画笔等演示

文档观看

文档观看可通过微吼云提供的SDK(包含iOS、Android、JS),以下以SDK Demo为例进行说明。

JS SDK Demo

直播+文档

1 演示地址

https://static.vhallyun.com/jssdk/vhall-jssdk-doc/test/slave-live.html

2 实例化

页面中依次输入token、appid、roomid、channelid、文档区域宽、文档区域高,点击实例化,进入直播+文档观看页面

注: roomid为选填项,不填写roomid时,则只进行文档观看,进入观看页面时也只是观看文档的演示效果。

3 直播+文档观看

页面中可同时进行直播推流和文档演示。

点播+文档

1 演示地址

https://static.vhallyun.com/jssdk/vhall-jssdk-doc/test/slave-vod.html

2 实例化

页面中依次输入token、appid、recordid、channelid、docid、文档区域宽、文档区域高,点击实例化,进入点播+文档观看页面

3 点播+文档观看

观看对应点播和演示文档画面。

iOS SDK Demo

具体参考Demo使用指南

Android SDK Demo

具体参考Demo使用指南