文档中心
体验 AppSDK 中心API 中心常见问题代码市场
中文
中文 English
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录控制台
中文站 English
产品
    客户端 API

    功能总览

    更新时间：2023-07-25 16:56

    ZEGO SDK 拥有全面覆盖全球重点区域的网络节点，提供丰富的 API，为多端提供清晰稳定的实时语音视频云服务。

    以下为基本 API 的简要介绍。

    SDK初始化

    方法名 描述
    renewToken 更新文件服务 token
    setLogConfig 日志高级配置。
    getConfig 根据Key值获取指定的扩展内容
    on 注册回调事件
    createView 创建 ZegoDocsView
    getVersion 获取 SDK 版本信息
    setConfig 设置配置项

    文件上传和加载功能

    方法名 描述
    loadFile 加载文件
    unloadFile 将 ZegoDocsView 从视图中卸载
    switchSpeaker 动态演示文件指定扬声器设备
    uploadFile 上传文件到 ZegoDocs 服务
    uploadH5File 上传自定义H5课件到 ZegoDocs 服务
    cancelUploadFile 在上传文件的过程中取消上传动作
    cacheFile 将文件缓存到本地
    cancelCacheFile 在缓存文件的过程中取消缓存动作
    queryFileCached 查询文件缓存是否存在

    文件内容的操作功能（翻页/缩放/滚动）

    方法名 描述
    getFileID 获取当前 ZegoDocsView 对应的 fileID ，与 loadFile 传入的 fileID 一致
    getFileType 获取当前 ZegoDocsView 的文件类型
    getCurrentPage 获取当前展示的 ZegoDocsView 页码
    getPageCount 获取当前已加载 ZegoDocsView 的总页数
    getVerticalPercent 获取当前纵向偏移（垂直滚动条）的百分比
    getVisibleSize 获取当前 ZegoDocsView 可见区域的宽高
    getContentSize ZegoDocsView 内容的宽高，根据当前设置的显示宽度得出的总高度
    playAnimation 根据 [animationInfo] 具体信息播放文件中的相应动画，仅对带有动画效果的动态 PPT 有效。
    stopPlay 停止本端动态 PPT ZegoDocsView 某一页的音视频播放
    flipPage 跳转到文件的指定页面和指定动画步骤
    scrollTo 跳转到纵向偏移百分比
    setScaleFactor 同步区域，包括缩放、偏移、滑动范围等。应用场景：如与白板操作同步
    getPPTNotes 获取 PPT 指定页码的备注
    getThumbnailUrlList 获取当前 ZegoDocsView 缩略图列表，仅支持 PDF ，PPT，动态 PPT，H5 文件格式
    switchSheet 将 Excel 文件切换到指定 sheet
    nextStep 动态 PPT 的下一步，仅针对动态 PPT ZegoDocsViewFileTypeDynamicPPTH5 类型操作
    previousStep 动态 PPT 的上一步，仅针对动态 PPT ZegoDocsViewFileTypeDynamicPPTH5 类型操作
    本篇目录
    • 免费试用

    • 联系我们