文件操作
文件操作
文件上传
FileManager.upload(File file, Map<String, dynamic> metaData)
metaData 参数说明(可选)
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
categoryID | String | N | 要上传的文件分类 ID |
categoryName | String | N | 要上传的文件分类名 |
info 请勿同时填写 categoryID 和 categoryName,默认只使用 categoryID
返回 CloudFile
对象
参数 | 类型 | 说明 |
---|---|---|
id | String | 文件 id |
name | String | 文件名 |
size | int | 文件大小,以字节为单位 |
category | FileCategory | 文件归属的目录 |
path | String | 上传成功后的访问地址 URL |
cdn_path | String | 文件在 CDN 中的相对路径 |
created_at | int | 创建时间 (格式为 unix 时间戳) |
mime_type | String | 文件媒体类型 |
media_type | String | 如果是视频/图片,表示文件的格式 |
示例代码
获取文件详情
FileManager.get(String fileID)
参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
fileID | String | Y | 文件 id |
示例代码
HError 对象结构请参考错误码和 HError 对象
删除文件
FileManager.delete(fileID)
参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
fileID | String or | Y | 文件 id (可为数组) |
示例代码
info 删除单个文件,如果权限不足,会返回 401;删除多个文件,如果权限不足,则直接跳过该文件
文件列表
查询,获取文件列表
FileManager.find([Query query])
文件查询与数据表查询方法一致,但只支持以下指定字段的筛选
支持字段 | 类型 | 说明 |
---|---|---|
id | String | 文件 id |
name | String | 文件名 |
size | Integer | 文件大小,以字节为单位 |
category_id | String | 文件分类 id |
category_name | String | 文件分类名 |
created_at | Integer | 创建时间 (格式为 unix 时间戳) |
示例代码
排序
文件查询排序与数据表排序方法一致,但只支持对以下指定字段进行排序
支持字段 | 类型 | 说明 |
---|---|---|
name | String | 文件名 |
size | Number | 文件大小,以字节为单位 |
created_at | Number | 文件上传时间 |
示例代码
分页
文件查询排序与数据表分页方法一致
示例代码
文件分类
获取文件分类
FileManager.getCategory(String cateID)
参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
cateID | String | Y | 文件分类 ID |
示例代码
查询指定分类下的文件
FileManager.find([Query query])
示例代码
参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
query | Query | N | 查询条件,详见数据表 - 查询 |
查询文件分类
FileManager.getCategoryList([Query query])
文件分类查询与数据表查询方法一致,但只支持以下指定字段的筛选:
参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
query | Query | N | 查询条件,详见数据表 - 查询 |
图片云处理
利用 CDN 图片云处理,可以快速便捷地完成图片缩放、裁切、打水印等操作,示例如下:
具体用法和更多功能可查看文档:如何通过图片 URL 进行图片云处理?
视频截图
info SDK 版本要求 >= 1.16.0
FileManager.genVideoSnapshot(Map<String, dynamic> params)
params参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
source | String | Y | 视频文件的 id |
save_as | String | Y | 截图保存的文件名 |
point | String | Y | 截图时间格式,格式:HH:MM:SS |
category_id | String | N | 文件所属类别 ID |
random_file_link | Boolean | N | 是否使用随机字符串作为文件的下载地址,不随机可能会覆盖之前的文件,默认为 true |
size | String | N | 截图尺寸,格式为 宽 x 高,默认是视频尺寸 |
format | String | N | 截图格式,可选值为 jpg,png, webp, 默认根据 save_as 的后缀生成 |
返回参数说明
res:
参数 | 类型 | 说明 |
---|---|---|
created_at | Integer | 创建时间 (格式为 unix 时间戳) |
path | String | 上传成功后的访问地址 URL |
created_by | Integer | 创建者 id |
mime_type | String | mime_type 类型 |
media_type | String | 媒体类型 |
size | Integer | 文件大小 |
name | String | 文件名 |
status | String | 文件状态 |
reference | String | 引用 |
cdn_path | String | 文件在 CDN 中的相对路径 |
updated_at | Integer | 更新时间 (格式为 unix 时间戳) |
categories | String | 文件所属类别 |
_id | String | 本条记录 ID |
示例代码
HError 对象结构请参考错误码和 HError 对象
返回示例
M3U8 视频拼接
FileManager.videoConcat(Map<String, dynamic> params)
params参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
m3u8s | Array | Y | 视频文件的 id 列表,按提交的顺序进行拼接 |
save_as | String | Y | 截图保存的文件名 |
category_id | String | N | 文件所属类别 ID |
random_file_link | Boolean | N | 是否使用随机字符串作为文件的下载地址,不随机可能会覆盖之前的文件,默认为 true |
返回参数说明
Map<String, dynamic> res:
参数 | 类型 | 说明 |
---|---|---|
created_at | Integer | 创建时间 (格式为 unix 时间戳) |
path | String | 上传成功后的访问地址 URL |
created_by | Integer | 创建者 id |
mime_type | String | mime_type 类型 |
media_type | String | 媒体类型 |
size | Integer | 文件大小 |
name | String | 文件名 |
status | String | 文件状态 |
reference | String | 引用 |
cdn_path | String | 文件在 CDN 中的相对路径 |
updated_at | Integer | 更新时间 (格式为 unix 时间戳) |
categories | String | 文件所属类别 |
_id | String | 本条记录 ID |
示例代码
HError 对象结构请参考错误码和 HError 对象
返回示例
M3U8 视频剪辑
FileManager.videoClip(Map<String, dynamic> params)
params参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
m3u8 | String | Y | 视频文件的 id |
save_as | String | Y | 截图保存的文件名 |
category_id | String | N | 文件所属类别 ID |
random_file_link | Boolean | N | 是否使用随机字符串作为文件的下载地址,不随机可能会覆盖之前的文件,默认为 true |
include | Array | N | 包含某段内容的开始结束时间,单位是秒。当 index 为 false 时,为开始结束分片序号 |
exclude | Array | N | 不包含某段内容的开始结束时间,单位是秒。当 index 为 false 时,为开始结束分片序号 |
index | Boolean | N | include 或者 exclude 中的值是否为 ts 分片序号,默认为 false |
返回参数说明
res:
参数 | 类型 | 说明 |
---|---|---|
created_at | Integer | 创建时间 (格式为 unix 时间戳) |
path | String | 上传成功后的访问地址 URL |
created_by | Integer | 创建者 id |
mime_type | String | mime_type 类型 |
media_type | String | 媒体类型 |
size | Integer | 文件大小 |
name | String | 文件名 |
status | String | 文件状态 |
reference | String | 引用 |
cdn_path | String | 文件在 CDN 中的相对路径 |
updated_at | Integer | 更新时间 (格式为 unix 时间戳) |
categories | String | 文件所属类别 |
_id | String | 本条记录 ID |
示例代码
HError 对象结构请参考错误码和 HError 对象
返回示例
M3U8 时长和分片信息
FileManager.videoMeta(Map<String, dynamic> params)
params参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
m3u8 | String | Y | 视频文件的 id |
返回参数说明
res:
参数 | 类型 | 说明 |
---|---|---|
status_code | Integer | 状态码 |
message | String | 返回信息 |
meta |
| 详见以下 |
meta 参数说明:
参数 | 类型 | 说明 |
---|---|---|
duartion | Number | m3u8 时长 |
points |
| 时间点 |
示例代码
HError 对象结构请参考错误码和 HError 对象
返回示例
音视频的元信息
FileManager.videoAudioMeta(Map<String, dynamic> params)
params参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
source | String | Y | 文件的 id |
返回参数说明
res:
参数 | 类型 | 说明 |
---|---|---|
format | Map<String, dynamic> | 音视频格式信息,详见以下 |
streams |
| stream 列表,详见以下 |
format 参数说明:
参数 | 类型 | 说明 |
---|---|---|
bitrate | int | 比特率 |
duration | num | 时长 |
format | String | 容器格式 |
fullname | String | 容器格式全称 |
streams 参数说明:
参数 | 类型 | 说明 |
---|---|---|
index | int | 表示第几路流 |
type | String | 一般情况下, video 或 audio |
bitrate | int | 流码率 |
codec | String | 流编码 |
codec_desc | String | 流编码说明 |
duration | num | 流时长 |
video_fps | num | (视频流)视频帧数 |
video_height | int | (视频流)视频高度 |
video_width | int | (视频流)视频宽度 |
audio_channels | int | (音频流)音频通道数 |
audio_samplerate | int | (音频流)音频采样率 |
示例代码
HError 对象结构请参考错误码和 HError 对象
返回示例
数据对象
CloudFile
参数 | 类型 | 说明 |
---|---|---|
id | String | 文件 id |
name | String | 文件名 |
size | int | 文件大小,以字节为单位 |
category | FileCategory | 文件归属的目录 |
path | String | 上传成功后的访问地址 URL |
cdn_path | String | 文件在 CDN 中的相对路径 |
created_at | int | 创建时间 (格式为 unix 时间戳) |
mime_type | String | 文件媒体类型 |
media_type | String | 如果是视频/图片,表示文件的格式 |
CloudFileList
参数 | 类型 | 说明 |
---|---|---|
limit | int | 返回文件的最大个数 |
offset | int | 返回文件的起始偏移值 |
total_count | int | 文件总数 |
next | String | 下一页地址,若为 null ,表示当前为最后一页 |
previous | String | 上一页地址,若为 null ,表示当前为第一页 |
files |
| 文件列表,每个元素为 CloudFile 类型 |
FileCategory
参数 | 类型 | 说明 |
---|---|---|
id | String | 分类 id |
name | String | 分类名称 |
files | int | 文件数量 |
created_at | int | 创建时间 (格式为 unix 时间戳) |
updated_at | int | 更新日期 (格式为 unix 时间戳) |
FileCategoryList
参数 | 类型 | 说明 |
---|---|---|
limit | int | 返回文件的最大个数 |
offset | int | 返回文件的起始偏移值 |
total_count | int | 文件总数 |
next | String | 下一页地址,若为 null ,表示当前为最后一页 |
previous | String | 上一页地址,若为 null ,表示当前为第一页 |
fileCategories |
| 分类列表,每个元素为 FileCategory 类型 |
Last updated