导入资源
1.接口描述
接口说明:导入资源到媒体文件中。资源文件已通过上传资源文件上传至设备。
请求方式:
- 固件版本 V2.6.0 及以上:POST [ip]/mwapi/V2.0/source/import-source
- 固件版本 V2.5.0 及以下:POST [ip]/mwapi/import-source
注意:
- 导入PDF资源需通过监听设备状态变更信息 中 DEVICE_STATUS_CHANGED_PDF_IMPORTING 获取导入过程及结果。
- 导入网页资源需通过监听设备状态变更信息 中 DEVICE_STATUS_CHANGED_IMPORT_WEB_BROWSER 获取导入结果。
| 管理员权限 | 登录认证 |
|---|---|
| 否 | 是 |
2.输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| sourceType | 是 | Int | 资源类型 1:图片;2:视频;6:音乐;7:笔记背景图片 13:PDF;14:网页 |
| fileName | 否 | String | 文件名称,sourceType为 14 时为非必要参数 |
| md5 | 否 | String | 文件MD5值,sourceType为 14 时为非必要参数 |
| url | 否 | String | 网页地址,仅在sourceType为 14 时为必要参数 |
3.输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Int | 状态码 |
| message | String | 状态描述 |
| info | InfoData | 资源信息 |
InfoData
| 参数名称 | 类型 | 描述 |
|---|---|---|
| duration | Int | 资源持续时间。仅视频音乐有效。 |
| filePath | String | 资源文件相对路径。可通过http访问http://[设备IP]/file/相对路径。 |
| height | Int | 资源高度 |
| id | Int | 资源ID,资源在设备中的唯一身份标识。 |
| name | String | 资源名称 |
| rotation | Int | 旋转角度,逆时针方向,范围[0~360] |
| thumbnailPath | String | 资源缩略图相对路径。可通过http访问http://[设备IP]/file/相对路径 |
| type | Int | 资源类型 0:预置资源(采集+图片+视频)1:图片;2:视频;6:音乐;7:笔记背景图片;10:GFX图片;11:画面背景图片;12:画面背景色;13:PDF 文件;14:网页 |
| width | Int | 资源宽度 |
4.示例
导入图片资源“3840x2160.png”到媒体文件。
输入示例
{
"fileName": "3840x2160.png",
"md5": "a983f73f834efc80bfc21e447352317f",
"sourceType": "1"
}
输出示例
{
"info":{
"duration":0,
"filePath":"2039/2039.png",
"height":1080,
"id":2039,
"name":"IMG_3162",
"rotation":0,
"thumbnailPath":"2039/2039.thumb.jpeg",
"type":1,
"width":1440
},
"message":"success",
"result":0
}
5.错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 定义 | 说明 |
|---|---|---|
| 7 | MW_STATUS_INVALID_ARG | 参数缺失或错误 |
| 7 | MW_STATUS_SOURCE_EXIST | 资源已存在 |
| 9 | MW_STATUS_DECODE_FAIL | 文件解码失败(格式不支持) |
| 29 | MW_STATUS_NO_SPACE | 磁盘空间不足 |