虎牙开放平台文档

hyExt.fs.isResExists

  • 判断资源是否存在
  • 引入版本 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 isResExists(params: ExistsReq): Promise<ExistsRsp> } /** * 判断资源是否存在参数 */ type ExistsReq = { /** * 资源md5 */ md5: string /** * 文件名 */ fileName: string /** * 目标文件是否自动解压 */ unzip?: boolean /** * 路径类型;取值说明: 0 目录1; 1 目录2; 2 目录3; */ pathType?: number /** * 要下载的资源url */ url?: string /** * 要下载的加密资源url */ encryptUrl?: string /** * 加密资源md5 */ encryptMd5?: string } /** * 判断结果 */ type ExistsRsp = { /** * 是否存在 */ isExists: boolean /** * 如果存在,则返回目标文件的完整路径,否则为空 */ path: string } }

示例代码

hyExt.fs .isResExists({ md5: "md5", fileName: "fileName", unzip: false, pathType: 0, url: "", encryptUrl: "", encryptMd5: "", }) .then((res) => { const { isExists, path } = res console.log("调用hyExt.fs.isResExists成功", res) }) .catch((err) => { console.log("调用hyExt.fs.isResExists失败", err) })

注意事项

  • 此SDK判断的是本地资源是否存在,并不能判断远程资源是否存在。只有通过 hyExt.fs.downloadBatchRes SDK 将资源下载到本地之后,返回的isExists字段为true,否则将永远为false

  • fileName文件名的值 是远程资源的文件名(并不是本地上传文件的文件名),并且必须添加文件类型后缀。示例代码中 文件名edbb5e316927215b.png取自于远程资源http://t11834349a5461b9-gxrzxdvz.test.hyext.com/extImg/0b6cd7a1b9/edbb5e316927215b.png

  • md5为文件资源的md5值,是文件资源的唯一标识,使用任意工具验证查看即可。

相关链接