文件共享
  • 平台类型
  • 框架 / 引擎
  • iOS
  • Android
  • macOS
  • Windows
  • Linux
  • Web
  • 小程序

功能实现

更新时间:2021-01-22 19:00

1 功能简介

集成 SDK 完成后,要想使用 SDK 的功能,需要在初始化 SDK 后,创建文件实例对象 DocView ,再进一步调用 ZegoExpressDocs 提供的各项 API。

2 初始化 SDK

/**
* 初始化 ZegoExpressDocs SDK
* @param appID: ZEGO 为开发者签发的应用 ID,请从 ZEGO 管理控制台申请
* @param token: token
* @param userID: userID
* @param isTestEnv: 是否在测试环境执行,该值默认为 false,为正式环境
*/
const zegoExpressDocs = new ZegoExpressDocs({appID, token, userID, isTestEnv});

/**
* 创建 Docsview
* @param parent: ZegoDocsView 挂载容器 ID
* eg:<div id="parent"></div>
*/
let docView = zegoExpressDocs.createView(parent);

请参考 登录房间鉴权 获取 Token。

3 上传文件

调用 uploadFile 接口上传文件,分两个阶段进行:

  1. 上传文件至服务器。
  2. 文件转码成展示文件类型。
zegoExpressDocs.uploadFile(file, renderType)

4 加载文件

调用 loadFile 接口加载文件。

  1. 此方式可能需要请求文件转码权限,如遇到加载失败的情况,请先查看错误码文档。可能的失败场景如下:
  • 无加载文件转码所需权限。
  • AppID & AppSign 与要加载的文件转码不匹配。
  • 文件转码在正式环境而初始化的 SDK 在测试环境。
  1. 当前 DocsView 已调用 loadFile 接口加载文件后,需要先调用 unloadFile 接口卸载文件,才能再次使用 loadFile 加载文件。
//authKey可为空字符串
docView.loadFile(fileID, authKey)

5 滚动翻页

调用 flipPage 接口翻页,调用 scrollTo 接口滚动。跳转页面和当页步数都是以 1 为起始。

/**
* 跳转到指定页位置。
* @param page: 跳转目标页,从 1 开始
* @param step: 跳转目标页对应的 step,从1开始(仅针对动态PPT)
*/
docView.flipPage(page: number, step?: number)

/**
* 跳转到纵向偏移百分比。
* @param verticalPercent: 纵向偏移百分比,参数取值范围 0.00 ~ 1.00,例如要跳转到一半的位置,则传入参数为 0.50
*/
docView.scrollTo(verticalPercent: number)

6 缩放

调用 setScaleFactor 接口缩放。

  1. 文件缩放需要指定缩放因子scaleFactor,即放大或缩小的比例系数。
  2. scaleOffset代表了在放大或缩小后需要展示的区域的左起点。
/**
* 缩放
* @param scaleFactor: 缩放倍数,不小于 1 的正数
* @param scaleOffsetX: X轴缩放偏移量
* @param scaleOffsetY: Y轴缩放偏移量
* @note  目前偏移量尚未支持,可不传
*/
docView.setScaleFactor(scaleFactor: number, scaleOffsetX?: number, scaleOffsetY?: number)

/**
* 获取缩放对象
* @return {scaleFactor: 缩放倍数; scaleOffsetX: X轴缩放偏移量; scaleOffsetY: Y轴缩放偏移量}
*/
docView.getScaleFactor(): {scaleFactor: number; scaleOffsetX: number; scaleOffsetY: number}

7 缩略图

调用 getThumbnailUrlList 接口获取缩略图。

  1. 获取当前文件缩略图列表,仅支持 PDF ,PPT,动态 PPT 文件格式。
  2. 需要在文件加载成功后调用。
/**
* 获取当前文件缩略图列表,仅支持 PDF,PPT,动态PPT 文件格式,可在文件加载成功后调用
* @return 文件缩略图URL数组
*/
docView.getThumbnailUrlList(): Array<string>

8 动态 PPT 操作

调用 nextStep 接口执行动画的下一步操作。 调用 previousStep 接口执行动画上一步操作。

/**
* 下一步,仅针对动态 PPT ZegoDocsViewFileTypeDynamicPPTH5 类型操作
*/
docView.nextStep()

/**
* 上一步,仅针对动态 PPT ZegoDocsViewFileTypeDynamicPPTH5 类型操作
*/
docView.previousStep()

9 Excel 文件切换 sheet

Excel 文件如果存在很多个 sheet 页,可以使用下面的接口进行 sheet 页切换。 sheet 下标,从 0 开始

docView.switchSheet(sheetIndex)