虎牙开放平台文档

hyExt.fs.downloadBatchRes

  • 批量下载资源
  • 这个接口仅用于创建批量下载资源的任务,resolve并不等于文件下载完毕
    • 使用 hyExt.context.on('downloadProgress', ({ res, msg, url, md5, bytesLoaded, bytesTotal, path, encryptUrl, encryptMd5 }) => {}) 监听每个任务的下载进度
  • 引入版本 2.1.0
  • 适用终端
    • 虎牙直播APP-iOS:未实现
    • 虎牙直播APP-安卓:未实现
    • 虎牙直播助手-iOS:4.16.0
    • 虎牙直播助手-安卓:4.16.0
    • 虎牙直播PC客户端-主播侧:4.23.0.0
    • 虎牙直播PC客户端-观众侧:未实现

接口签名

declare namespace hyExt { module fs { /** * 批量下载资源 * @param params 输入参数 */ function downloadBatchRes(params: BatchRes[]): Promise<void> } /** * 下载资源信息 */ type BatchRes = { /** * 要下载的资源url */ url: string /** * 资源md5 */ md5: string /** * 自动解压 */ unzip: boolean /** * 是否离线资源 */ offline?: boolean /** * 路径类型;取值说明: 0 目录1; 1 目录2; 2 目录3; */ pathType?: number /** * 资源名,用于当二级目录名 */ sourceName?: string /** * 要下载的加密资源url */ encryptUrl?: string /** * 加密资源md5 */ encryptMd5?: string /** * 唯一标记 */ tag?: string } }

示例代码

hyExt.fs .downloadBatchRes([ { url: "url", md5: "md5", unzip: true, offline: false, pathType: 0, sourceName: "", encryptUrl: "", encryptMd5: "", tag: "", }, ]) .then(() => { console.log("调用hyExt.fs.downloadBatchRes成功") }) .catch((err) => { console.log("调用hyExt.fs.downloadBatchRes失败", err) })

相关链接