{% import “/js-sdk/macro/total_count.md” as totalCount %}

{% macro filter() %} 文件查询与数据表查询方法一致，但只支持以下指定字段的筛选

{% endmacro %}

文件操作

实例化一个 BaaS.File 对象，以下操作都是在该对象上进行操作，如下进行实例化：

{% ifanrxCodeTabs %} let MyFile = new wx.BaaS.File() {% endifanrxCodeTabs %}

文件上传

MyFile.upload(fileParams, metaData)

fileParams 参数说明（必须）

metaData 参数说明（可选）

info 1.请勿同时填写 categoryID 和 categoryName，默认只使用 categoryID

2.randomFileLink 举例说明：

metaData.randomFileLink 为 true 时，如果 fileParams.fileName 为 avatar.png， 则返回值中 res.data.file.path 为 https://cloud-minapp-xxx.cloud.ifanrusercontent.com/1j6ZGvnzSpJ7YBZ8.png

metaData.randomFileLink 为 false 时，如果 fileParams.fileName 为 avatar.png， 则返回值中 res.data.file.path 为 https://cloud-minapp-xxx.cloud.ifanrusercontent.com/avatar.png

返回参数说明

res.data:

file 参数说明：

示例代码

{% tabs first=”微信小程序”, second=”Web” , third=”支付宝小程序” %}

{% content “first” %}

wx.chooseImage({
  success: function(res) {
    let MyFile = new wx.BaaS.File()
    let fileParams = {filePath: res.tempFilePaths[0]}
    let metaData = {categoryName: 'SDK'}
    MyFile.upload(fileParams, metaData).then(res => {
      // 上传成功
      let data = res.data  // res.data 为 Object 类型
    }, err => {
      // HError 对象
    })
  }
})

监听上传进度变化事件和中断上传任务 (仅限微信小程序)

在 1.1.2 版本的基础上，1.8.0 版本中增加了对 UploadTask 的支持， upload API 返回的 Promise 对象上增加了 onProgressUpdate 和 abort 方法，使文件上传增加了以下两个特性：

• 监听上传进度：onProgressUpdate(callback)
• 中断上传任务：abort()

callback 接收一个对象类型的参数，其结构如下：

示例代码

wx.chooseImage({
  success: function(res) {
    let MyFile = new wx.BaaS.File()
    let fileParams = {filePath: res.tempFilePaths[0]}
    let metaData = {categoryName: 'SDK'}
    // upload API 返回一个 Promise，1.8.0 后返回值增加了 onProgressUpdate 和 abort 方法
    let uploadTask =  MyFile.upload(fileParams, metaData)
    // 文件成功上传的回调
    uploadTask.then(res=>{
    })
    // 监听上传进度
    uploadTask.onProgressUpdate(e => {
      console.log(e)
    })
    // 600 毫秒后中断上传
    setTimeout(()=> uploadTask.abort(), 600)
  }
})

onProgressUpdate 接收参数示例

{
  "progress":80,
  "totalBytesSent":1507328,
  "totalBytesExpectedToSend":1883803
}

{% content “second” %}

<input type="file" id="file">

var f = document.getElementById('file')
f.addEventListener('change', function(e) {
   let File = new BaaS.File()
   let fileParams = {fileObj: e.target.files[0]}
   File.upload(fileParams).then(res => {
     console.log(res)
   }, err => {
   // HError
   })
})

{% content “third” %}

my.chooseImage({
  success: function(res) {
    let MyFile = new wx.BaaS.File()
    let fileParams = {
      filePath: res.apFilePaths[0],
      fileType: 'image',
    }
    let metaData = {categoryName: 'SDK'}
    MyFile.upload(fileParams, metaData).then(res => {
      // 上传成功
      let data = res.data  // res.data 为 Object 类型
    }, err => {
      // HError 对象
    })
  }
})

{% endtabs %}

HError 对象结构请参考错误码和 HError 对象

info file 字段可用于含有 file 类型的数据表的数据操作，详细见 新增数据项

获取文件详情

MyFile.get(fileID)

参数说明

返回参数说明

res.data:

category 参数说明：

示例代码

{% ifanrxCodeTabs %}

let MyFile = new wx.BaaS.File()
MyFile.get('5a2fe93308443e313a428c4f').then((res) => {
  // success
}, err => {
  // HError 对象
})

{% endifanrxCodeTabs %}

HError 对象结构请参考错误码和 HError 对象

返回示例

{
  "category": {
    "id": "5a2fe91508443e3123dbe1cb",
    "name": "科技"
  },
  "created_at": 1507822469,
  "id": "5a2fe93308443e313a428c4f",
  "mime_type": "image/png",
  "name": "sdk-test-minapp2.png",
  "path": "https://cloud-minapp-7894.cloud.ifanrusercontent.com/1eOledhCbvjgaCSE.png",
  "size": 3879
}

删除文件

MyFile.delete(fileID)

参数说明

示例代码

{% ifanrxCodeTabs %}

let MyFile = new wx.BaaS.File()
MyFile.delete('5a2fe93308443e313a428c4f').then()
MyFile.delete(['5a2fe93308443e313a428c4c', '5a2fe93308443e313a428c4d']).then()

{% endifanrxCodeTabs %}

info 删除单个文件，如果权限不足，会返回 401；删除多个文件，如果权限不足，则直接跳过该文件

获取符合条件的文件总数

BaaS.File#count()

info SDK v3.0 新增

{{filter()}}

{% ifanrxCodeTabs comment=”目前会自动将 wx.BaaS 替换为 window 和 my” %}

let MyFile = new wx.BaaS.File()
let query = new wx.BaaS.Query()
query.compare('category_name', '=', categoryName)
query.contains('name', substr)
MyFile.setQuery(query).count().then(num => {
  // success
  console.log(num)  // 10
}, err => {
  // err
})

{% endifanrxCodeTabs %}

查询，获取文件列表

BaaS.File#find(options)

参数说明

options:

{{totalCount.withCountTips()}}

{{filter()}}

文件查询与数据表查询方法一致，但只支持以下指定字段的筛选

示例代码

{% ifanrxCodeTabs %}

let MyFile = new wx.BaaS.File()
// 查找所有文件
MyFile.find()
let query = new wx.BaaS.Query()
// 查询某一文件分类下的所有文件
query.compare('category_name', '=', categoryName)
// 查询文件名包含指定字符串的文件
query.contains('name', substr)
MyFile.setQuery(query).find()

{% endifanrxCodeTabs %}

{% ifanrxCodeTabs %}

let MyFile = new wx.BaaS.File()
// 查找所有文件
MyFile.find()
// 按创建时间范围查询: 2018年10月24日17时10分57秒 至今上传的文件
let query = wx.BaaS.Query.and(new wx.BaaS.Query().compare('created_at', '<=', Math.ceil(Date.now() / 1000)), new wx.BaaS.Query().compare('created_at', '>=', 1540372257))
MyFile.setQuery(query).find()

{% endifanrxCodeTabs %}

排序

文件查询排序与数据表排序方法一致，但只支持对以下指定字段进行排序

示例代码

{% ifanrxCodeTabs %}

let MyFile = new wx.BaaS.File()
MyFile.orderBy('-created_at').find().then()

{% endifanrxCodeTabs %}

分页

文件查询排序与数据表分页方法一致

示例代码

{% ifanrxCodeTabs %}

let MyFile = new wx.BaaS.File()
MyFile.limit(10).offset(5).find().then()

{% endifanrxCodeTabs %}

返回示例

成功时 res 结构如下

 {
  "meta": {
    "limit": 20,
    "next": "/dserve/v1.3/uploaded-file/?limit=20&offset=20&where=%7B%22%24and%22%3A%5B%7B%22category_name%22%3A%7B%22%24eq%22%3A%22%E5%9B%BE%E7%89%87%22%7D%7D%5D%7D",
    "offset": 0,
    "previous": null,
    "total_count": 36
  },
  "objects": [{
    "category": {"id": "5b73f36f2a4f56246e76b7b3", "name": "图片"},
    "created_at": 1534823603,
    "id": "5b7b8cb3839c611ab4eb2599",
    "mime_type": "image/jpeg",
    "name": "wxc6b86e382a1e3294.o6zAJs5dCuYRqqJOq0MwNPlGiFVM.CGLDGRT03IsI7fa51717abe74ed34e0c9cc77dbe7079.jpg",
    "path": "https://cloud-minapp-11033.cloud.ifanrusercontent.com/1frxjPBNFAOrQtOS.jpg",
    "size": 11189
  }]
}

图片云处理

利用 CDN 图片云处理，可以快速便捷地完成图片缩放、裁切、打水印等操作，示例如下：

// 缩放图片至 400x400
https://cloud-minapp-7894.cloud.ifanrusercontent.com/1eRuaPvwdleauqyZ.jpg!/both/400x400
// 在图片右下角添加 “知晓云” 文字水印
https://cloud-minapp-7894.cloud.ifanrusercontent.com/1eiuEUuISgOstoVZ.png!/watermark/align/southeast/text/55+l5pmT5LqRCg==

具体用法和更多功能可查看文档：如何通过图片 URL 进行图片云处理？

视频截图

info SDK 版本要求 >= 1.16.0

MyFile.genVideoSnapshot(params)

params参数说明

返回参数说明

res:

示例代码

let MyFile = new wx.BaaS.File()
let params = {
  "source": "xxxxxxxxxx",
  "save_as": "hello.png",
  "point": "00:00:10",
  "category_id": "5c18bc794e1e8d20dbfcddcc",
  "random_file_link": false
}
MyFile.genVideoSnapshot(params).then((res) => {
  // success
}, err => {
  // HError 对象
})

HError 对象结构请参考错误码和 HError 对象

返回示例

{
  "created_at": 1547461561,
  "path": null,
  "created_by_id": 16042162,
  "mime_type": "image/png",
  "media_type": "image",
  "size": 99391,
  "name": "1gizRRuY71ZUcSZX.png",
  "status": "success",
  "reference": "",
  "cdn_path": "1gizRRRdklnf7gCD.png",
  "updated_at": 1547461561,
  "categories": [],
  "_id": "5c3c63b9d1606e0b3fc7acb7"
}

M3U8 视频拼接

info SDK 版本要求 >= 1.16.0

MyFile.videoConcat(params)

params参数说明

返回参数说明

res:

示例代码

let MyFile = new wx.BaaS.File()
let params = {
  "m3u8s": ["xxxxxxxxxx", "xxxxxxxxxx"],
  "save_as": "hello.m3u8",
  "category_id": "5c18bc794e1e8d20dbfcddcc",
  "random_file_link": false,
}
MyFile.videoConcat(params).then((res) => {
  // success
}, err => {
  // HError 对象
})

HError 对象结构请参考错误码和 HError 对象

返回示例

{
  "created_at": 1547461561,
  "path": null,
  "created_by_id": 16042162,
  "mime_type": "",
  "media_type": "",
  "size": "",
  "name": "hello.m3u8",
  "status": "pengding",
  "reference": "",
  "cdn_path": "1gizRRRdklnf7gCD.m3u8",
  "updated_at": 1547461561,
  "categories": [],
  "_id": "5c3c63b9d1606e0b3fc7acb7"
}

M3U8 视频剪辑

info SDK 版本要求 >= 1.16.0

MyFile.videoClip(params)

params参数说明

返回参数说明

res:

示例代码

let MyFile = new wx.BaaS.File()
let params = {
  "m3u8": "xxxxxxxxxx",
  "include": [0, 20],
  "save_as": "0s_20s.m3u8",
  "category_id": "5c18bc794e1e8d20dbfcddcc",
  "random_file_link": false
}
MyFile.videoClip(params).then((res) => {
  // success
}, err => {
  // HError 对象
})

HError 对象结构请参考错误码和 HError 对象

返回示例

{
  "created_at": 1547461561,
  "path": null,
  "created_by_id": 16042162,
  "mime_type": "",
  "media_type": "",
  "size": "",
  "name": "hello.m3u8",
  "status": "pending",
  "reference": "",
  "cdn_path": "1gizRRRdklnf7gCD.m3u8",
  "updated_at": 1547461561,
  "categories": [],
  "_id": "5c3c63b9d1606e0b3fc7acb7"
}

M3U8 时长和分片信息

info SDK 版本要求 >= 1.16.0

MyFile.videoMeta(params)

params参数说明

返回参数说明

res:

meta 参数说明：

示例代码

let MyFile = new wx.BaaS.File()
let params = {
  "m3u8": "xxxxxxxxxx"
}
MyFile.videoMeta(params).then((res) => {
  // success
}, err => {
  // HError 对象
})

HError 对象结构请参考错误码和 HError 对象

返回示例

{
  "status_code": 200,
  "message": "ok",
  "meta": {
    "duration": 2850.2974559999984,
    "points": [
      11.277933,
      23.7237,
      34.6346,
      42.008632999999996,
      50.483765999999996,
      64.764699,
      70.80406599999999,
      82.31556599999999,
      92.892799,
      100.200099,
      114.74796599999999,
      123.92379899999999,
      131.09763199999998,
      140.97416499999997,
      158.32483199999996,
      160.05989899999994,
      172.70586599999996,
      181.04753299999996,
      191.79159999999996
    ]
  }
}

音视频的元信息

info SDK 版本要求 >= 1.16.0

MyFile.videoAudioMeta(params)

params参数说明

返回参数说明

res:

format 参数说明：

streams 参数说明：

示例代码

let MyFile = new wx.BaaS.File()
let params = {
  "source": "xxxxxxxxxx"
}
MyFile.videoAudioMeta(params).then((res) => {
  // success
}, err => {
  // HError 对象
})

HError 对象结构请参考错误码和 HError 对象

返回示例

{
  "streams": [
    {
      "index": 0,
      "type": "video",
      "video_fps": 25,
      "video_height": 236,
      "video_width": 426,
      "codec_desc": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
      "codec": "h264",
      "bitrate": 99608,
      "duration": 184.8,
      "metadata": {
        "handler_name": "VideoHandler",
        "language": "und"
      }
    },
    {
      "index": 1,
      "type": "audio",
      "audio_channels": 2,
      "audio_samplerate": 44100,
      "codec_desc": "AAC (Advanced Audio Coding)",
      "codec": "aac",
      "bitrate": 48005,
      "duration": 184.855011,
      "metadata": {
        "handler_name": "SoundHandler",
        "language": "und"
      }
    }
  ],
  "format": {
    "duration": 184.902,
    "fullname": "QuickTime / MOV",
    "bitrate": 154062,
    "filesize": 3560797,
    "format": "mov,mp4,m4a,3gp,3g2,mj2"
  }
}