目录 第 1 章调用说明 概述 请求结构说明... 1 请求地址... 1 公共参数... 1 地址示例 返回结果... 2 第 2 章转码服务相关接口 创建转码任务... 3 功能描述... 3 请求参数... 3 返回参数.

Transcription

1 ONAIR 视频云 转码 API 接口调用规范 版本号 :V1.0 北京新奥特云视科技有限公司 2018 年 8 月

2 目录 第 1 章调用说明 概述 请求结构说明... 1 请求地址... 1 公共参数... 1 地址示例 返回结果... 2 第 2 章转码服务相关接口 创建转码任务... 3 功能描述... 3 请求参数... 3 返回参数... 3 回调参数... 3 调用示例 取消转码任务... 6 功能描述... 6 请求参数... 6 返回参数... 6 调用示例 查询转码任务... 6 功能描述... 6 请求参数... 6 返回参数... 6 调用示例 查询转码列表... 8 功能描述... 8 请求参数... 8 返回参数... 8 调用示例... 9 第 3 章转码模板相关接口 查询转码模板列表 功能描述 I

3 请求参数 返回参数 调用示例 查询转码模版 功能描述 请求参数 返回参数 调用示例 第 4 章水印相关接口 创建水印模板 功能描述 请求参数 返回参数 调用示例 更新水印模板 功能描述 请求参数 返回参数 调用示例 查询水印模板 功能描述 请求参数 返回参数 调用示例 查询水印模板列表 功能描述 请求参数 返回参数 调用示例 删除水印模板 功能描述 请求参数 返回参数 调用示例 II

4 第 5 章存储库设置接口 设置存储库 功能描述 请求参数 调用示例 第 6 章截图 创建截图 功能描述 请求参数 返回参数 回调参数 调用示例 查询截图 功能描述 请求参数 返回参数 调用示例 第 7 章媒体信息 创建媒体信息任务 功能描述 请求参数 返回参数 回调参数 调用示例 查询媒体信息任务 功能描述 请求参数 返回参数 调用示例 第 8 章附录 数据类型 File TranscodeInputFile TranscodeOutputFile III

5 TranscodeOutput WarterMark WaterMarkTemplate TranscodeTask MessageResult TranscodeTemplate TranscodeTemplateContent Video Audio Container SnapshotPic SnapshotTask MediaInfoTask MediaInfo MediaInfoGeneral MediaInfoVideo MediaInfoAudio MediaInfoPic 参数详情 转码输入详情 转码输出详情 转码水印参数详情 输入详情 textwatermark 参数详情 水印模版配置详情 Timeline 详情 SubtitleConfig 详情 ExtSubtitle 详情 Container 详情 Video 详情 Audio 详情 存储配置详情 SnapshotConfig 详情 FontColor 列表 IV

6 8.3 预置模板详情 状态码 V

7 功能 描述 创建转码任务取消转码任务查询转码任务查询转码列表查询转码模板列表查询转码模板创建水印模板更新水印模板查询水印模板查询水印模板列表删除水印模板 创建转码任务取消已提交的转码任务查询该用户下发的转码任务详情查询该用户下发的所有转码任务查询系统已有的所有转码模板查询系统已有的转码模板详情创建水印模板更新已创建的水印模板查询该用户下某一个水印模板的详情查询该用户创建的所有水印模板删除该用户创建的水印模板 设置存储库创建转码任务前需要先在云平台中申请私有的对象存储服务, 用于存放转码完成后的音视频资源 创建截图查询截图创建媒体信息任务查询媒体信息任务 创建截图接口, 生成 jpg 格式图片查询调用接口后截得的图片调用该接口分析文件的媒体信息, 异步返回该文件的媒体信息查询该用户创建任务后所得的媒体信息任务 VI

8 视频云转码 API 接口调用规范 第 1 章调用说明 1.1 概述 欢迎使用转码服务 用户可以使用本文档介绍的 API 对转码服务进行相关操作 对服务接口调用统一采用标准的 RESTFul 风格的 API 接口, 支持 HTTP GET 方法发送请求, 这种方式下请求参数需要包含在请求的 URL 中接口, 某些请求工具不支持接口参数中的特殊字符, 可以使用浏览器进行调用测试 调用服务端统一为 HTTP(S) 协议的请求, 为了获得更高的安全性, 推荐您使用 HTTPS 通道发送请求 根据请求的处理情况, 系统响应数据格式统一为 JSON 数据格式 1.2 请求结构说明 请求地址服务调用接口地址规则 : 域名 ]/[ 接口地址 ]?[ 公共参数 ] 访问地址由三部分组成 : 域 名 : 接口服务部署后提供访问域名 接口地址 : 接口服务根据实现功能的不同提供相应的地址 公共参数 : 公共请求参数是指每一个接口都需要使用到的参数 注 : 所有公共参数项必须传递, 非必填项的值可以不传, 所有参数区分大小写, 命名遵循驼峰命名规则 请求及返回结果都使用 UTF-8 字符集进行编码, 请求参数需要先进行 urlencode 编码, 示例 :URLEncoder.encode(value, UTF-8 ).replace("+", "% 20").replace("*", "%2A").replace("%7E", "~") 公共参数属性含义类型说明必填 timestamp 时间戳 long 北京时间 1970 年 01 月 01 日 08 时 00 分 00 秒起至现在的总秒数地址示例 /api/log/v1/create?timestamp= [ 第一部分 ][ 第二部分 ] 第一部分是具体接口服务的接口地址, 由接口服务根据一定规则 ( 按照不同功能进行命名上的区分 ) 自定义, 第二部分为公共参数, 在调用每个接口时均需填入该部分 1

9 1.3 返回结果 "code": 0, # 状态码, 参照附录 "message": "success", # 描述信息 "data": "requestid": " F38-4W33-BER5-D CA58" # 结果数据 2

10 第 2 章转码服务相关接口 转码服务可以支持不同格式的视音频转码, 支持一入多出 模板方式等快捷的转码形式 利用集群优势, 使用切片转码方式可以极大的提高转码效率 转码服务提供任务创建 转码状态查询和转码列表接口 2.1 创建转码任务 功能描述 根据请求参数创建转码任务, 成功后返回对应的转码任务 ID 请求参数 参数 含义 格式 说明 必填 转码输入 JSON 对象, 参考附录 - 参数详 input 输入文件信息 情转码输入详情, 例如 是 "fileurl":"" callbackurl 回调地址 回调通知地址, 该地址不支持携带 GET 参数 outputbuck 需要先调用创建存储库接口, 为该 bucke 输出 Bucket et t 设置上传存储配置 是 转码输出集合,JSON 数组字符串, 参考 附录 - 参数详情转码输出详情, 如 output 输出集合 ["templateid":"s "," watermarks":["inputfile":"fileurl":"", 是 "watermarktemplateid":"88c6ca184c 0e47098a5b665e2a126797"]] userdata 用户自定义数据 用户自定义数据, 最大 1024 字节 返回参数 参数 含义 格式 说明 transcodetasklist 创建转码任务 transcodetask[] 创建转码作业结果 回调参数 转码任务结束后, 由转码服务发起回调, 回调地址为 callbackurl 的值, 具体调用参数 见下表 参数 含义 格式 说明 transcodeid 任务 Id 创建转码任务时, 产生的唯一标识 outputfilelist 转码输出信息 transcodeoutput 转码完成后的输出文件列表, 当转 3

11 File[] 码成功后有该参数 userdata 用户自定义数据 当用户创建任务时传递了该参数则存在该参数 回调请求示例 : "code": 0, "message": "", "data": "transcodetaskid": "582d8806e e321c40", "userdata": " 自定义参数 ", "outputfilelist": [ "outputfile": "fileurl": " "templateid": "57e36e01e f3d33caa", "watermarklist": [ "inputfile": "fileurl": "", "watermarktemplateid": "57e36e01e f3d33caa" ] ] 调用示例 请求示例 : 域名 ]/transcodetask/create?input="fileurl":" Bucket=bucketName&callbackUrl= S ","waterMarks":["inputFile":"fileUrl":"","waterMarkTemplateId":"88c6c a184c0e47098a5b665e2a126797"]] 返回示例 : "code": 0, 4

12 "message": "success", "data": "transcodetasklist": [ "id": "57e36e01e f3d33caa", "input": "fileurl": " "outputs": outputfilelist : [ "outputfilelist": [ "outputfile": null, "templateid": "57e36e01e f3d33caa", "watermarklist": [ "inputfile": "fileurl": " "watermarktemplateid": "57e36e01e f3 d33caa" ] ] ], "state": "Submitted", "sode": "", "message": "", "percent": 0, "userdata": "asf", "createtime": " T12:00:00Z", "messageresult": null ] 5

13 2.2 取消转码任务 功能描述 根据任务 id 取消已经已提交的转码任务, 若转码任务已经开始将无法取消 请求参数 参数 含义 格式 说明 必填 transcodetaskid 任务 id 是 返回参数 参数 含义 格式 说明 transcodetaskid 转码任务 Id 取消转码任务 id 调用示例请求示例 : 域名 ]/transcodetask/cancel?transcodetaskid=57e36e01e f3d33caa 返回示例 : "code": 0, "message": "", "data": "requestid": " F38-4W33-BER5-D CA58", "transcodetaskid": "57e36e01e f3d33caa" 2.3 查询转码任务 功能描述 根据任务 id 查询转码任务详情 请求参数 参数 含义 格式 说明 必填 transcodetaskids 任务 id 转码任务 ID 列表, 逗号分隔, 一次最多 10 个 是 返回参数参数 格式 说明 transcodetasklist TranscodeTask[] 查询到的转码任务列表 nonexisttranscodetaski [] 不存在的转码作业 ID 列表, 无数据时该结构 6

14 ds 调用示例 不返回 请求示例 : 域名 ]/transcodetask/query?transcodetaskids=57e36e01e f3d33caa 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "transcodetasklist": [ "id": "57e36e01e f3d33caa", "input": "fileurl": " "outputs": outputfilelist : [ "outputfilelist": [ "outputfile": null, "templateid": "57e36e01e f3d33caa", "watermarklist": [ "inputfile": "fileurl": " "watermarktemplateid": "57e36e01e f3d33caa" ] ] ], 7

15 "state": "Submitted", "code": "", "message": "", "percent": 0, "userdata": "asf", "createtime": " T12:00:00Z", "messageresult": null ] 2.4 查询转码列表 功能描述 查询转码任务列表, 可按照转码任务状态及转码任务创建时间的区间进行查询, 默认按 CreateTime 降序排序 请求参数 参数 格式 说明 必填 currentpage 当前分页, 默认是 1 pagesize 页大小,1-100 的数, 默认是 10 state 转码任务状态 :All 表示所有状态,Submitted 表示作业已提交,Transcoding 表示转码中,Tra nscodesuccess 表示转码成功,TranscodeFail 表示转码失败,TranscodeCancelled 表示转码取消, 默认是 All 依照转码任务创建时间对转码任务进行区间搜索 startofjobcreated 时的起始时间, 输入格式例为 yyyy-mm-dd hh: Time mm:ss 可不输入时间, 仅对日期 yyyy-mm-dd 进行搜索 依照转码任务创建时间对转码任务进行区间搜索 endofjobcreatedti 时的结束时间, 输入格式为 yyyy-mm-dd hh:m me m:ss 可不输入时间, 仅对日期 yyyy-mm-dd 进行搜索 返回参数 参数格式说明 8

16 list TranscodeTask[] 转码任务列表 currentpage int 当前页 pagesize int 页大小 totalcount int 总条数 pagecount int 总页数调用示例请求示例 : 域名 ]/transcodetask/list?currentpage=1&pagesize=10 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "currentpage": 1, "pagesize": 10, "totalcount": 1, "pagetotal": 1, "list": [ "id": "57e36e01e f3d33caa", "input": "fileurl": " "outputs": outputfilelist :[ "outputfilelist": [ "outputfile": null, "templateid": "57e36e01e f3d33caa", "watermarklist": [ "inputfile": "fileurl": " "watermarktemplateid": "57e36e01e

17 3f3d33caa" ] ] ], "state": "Submitted", "code": "", "message": "", "percent": 0, "userdata": "asf", "createtime": " T12:00:00Z", "messageresult": null ] 第 3 章转码模板相关接口 3.1 查询转码模板列表 功能描述查询系统已有转码模板 请求参数参数 格式 说明 必填 currentpage 当前分页, 默认是 1 pagesize 页大小,1-100 的数, 默认是 10 返回参数 参数 格式 说明 list TranscodeTemplate[] 模板列表 currentpage Int 当前页 pagesize Int 页大小 totalcount Int 总条数 pagecount Int 总页数 10

18 调用示例请求示例 : 域名 ]/transcodetemplate/list?currentpage=1&pagesize=10 返回示例 : "code": 0, "message": "", "data": "requestid": " F38-4W33-BER5-D CA58", "currentpage": 1, "pagesize": 10, "totalcount": 1, "pagecount": 1, "list": [ "id": "582d8806e e321c40", "name": " 高清 ", "templatecontent": "video": "vcodec": "", "state": "Normal" ] 3.2 查询转码模版 功能描述 根据转码模版 id 查询转码模版详情 请求参数 参数 格式 说明 必填 templateids 转码模版 ID, 逗号分隔, 每次最多 10 个 是 11

19 返回参数参数格式说明 templatelist TranscodeTemplate[] 模板列表 nonexisttemplatei 不存在模版 ID, 当查询参数中有不存在的模板 i ds [] d 时返回该字段, 无数据时该结构不返回调用示例请求示例 : 域名 ]/transcodetemplate/query?templateids=582d8806e e321c40 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "templatelist": [ "id": "582d8806e e321c40", "name": "MTS-example", "templatecontent": "video": "vcodec": "", "state": "Normal" ] 第 4 章水印相关接口 4.1 创建水印模板 功能描述创建水印模板 水印模板决定水印转码后输出文件的水印位置 大小 出现时长等状态 创建水印模板后, 需要在创建转码任务时输入水印文件在 OBS 中的 URL 地址 水印模板相关接口目前仅支持图片 视频水印模板的设置 文字水印需在调用 创建转 12

20 码任务 时设置 请求参数参数 格式 说明 必填 name 自定义的水印模板名称, 最大长度 128 字节 是 config 水印模板配置,JSON 对象, 参考附录 - 参数详情水印模版配置详情, 例如 : "width": "10", "height": "30", "dx": "10", "dy": "5", "referpos": "TopRight", 是 "type": "Image", "timeline": "start": "0", "duration": "10" 返回参数 参数 格式 说明 watermarktemplate WarterMarkTemplate 水印模板信息, 含水印模板 ID, 供调用水印模板使用 调用示例请求示例 : 域名 ]/transcodewartermark/create?name=wartermarktemplate1&config="widt h":"100","height":"50","dx":"100","dy":"100","referpos":"topright","type":"image" 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "watermarktemplate": "id": "88c6ca184c0e47098a5b665e2a126797", "name": "example-watermark", "width": "10", 13

21 "height": "30", "dx": "10", "dy": "5", "referpos": "TopRight", "type": "Image", "state": "Normal" 4.2 更新水印模板 功能描述更新已创建的水印模板 请求参数参数 格式 说明 必填 watermarktemplateid 水印模板 ID 是 name 模板名称, 最大长度 128 字节 是 config 水印模板配置,JSON 对象, 参考附录 - 参数详情水印模版配置详情, 例如 : "width":"10", "height":"30", "dx":"10", "dy":"5", 是 "referpos":"topright", "type":"image", "timeline":"start":"0", "duration":"10 " 返回参数 参数 格式 说明 watermarktemplate WarterMarkTemplate 更新后的模板 调用示例请求示例 : 域名 ]/transcodewartermark/update?watermarktemplateids=582d8806e

22 4e321c40&name=warterMarkTemplate1&config="width":"100","height":"50","dx":"100 ","dy":"100","referpos":"topright","type":"image" 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "watermarktemplate": "id": "88c6ca184c0e47098a5b665e2a126797", "name": "example-watermark", "width": "10", "height": "30", "dx": "10", "dy": "5", "referpos": "TopRight", "type": "Image", "state": "Normal" 4.3 查询水印模板 功能描述 根据水印模板 id 查询水印模板详情 请求参数 参数 格式 说明 必填 watermarktemplateids 水印模板 ID 列表, 最多一次查 10 个, 逗号分隔 是 返回参数 参数 格式 说明 watermarktemplatelist Template[] 查询到的模板列表 不存在的水印模板列表, 无数据时该结构 nonexistwatermarktemplateids [] 不返回 调用示例 请求示例 : 15

23 域名 ]/transcodewartermark/query?watermarktemplateids=582d8806e e321c40 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "watermarktemplate": "id": "88c6ca184c0e47098a5b665e2a126797", "name": "example-watermark", "width": "10", "height": "30", "dx": "10", "dy": "5", "referpos": "TopRight", "type": "Image", "state": "Normal" 4.4 查询水印模板列表 功能描述获取创建的水印列表 请求参数参数 格式 说明 必填 currentpage 当前页, 默认是 1 pagesize 页大小,1-100 的数, 默认是 10 state 水印模板状态 :All 表示所有,Normal 表示正常,Deleted 表示已删除的, 默认是 All 返回参数 参数 格式 说明 list WaterMarkTemplate[] 查询到的模板列表 16

24 currentpage int 当前页 pagesize int 页大小 totalcount int 总条数 pagecount int 总页数调用示例请求示例 : 域名 ]/transcodewartermark/list?currentpage=1&pagesize=10 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "currentpage": 1, "pagesize": 10, "totalcount": 1, "pagecount": 1, "list": [ "id": "88c6ca184c0e47098a5b665e2a126797", "name": "example-watermark", "width": "10", "height": "30", "dx": "10", "dy": "5", "referpos": "TopRight", "type": "Image", "state": "Normal" ] 4.5 删除水印模板 功能描述 删除创建好的水印模板 17

25 请求参数参数 含义 格式 说明 必填 watermarktemplateid 水印模板 id 需要删除的水印模板 id 是 返回参数参数 格式 说明 watermarktemplateid 删除成功的水印模板 id 调用示例请求示例 : 域名 ]/transcodewartermark/delete?watermarktemplateid=582d8806e e321c40 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "watermarktemplateid": "88c6ca184c0e47098a5b665e2a126799" 18

26 第 5 章存储库设置接口 5.1 设置存储库 功能描述 创建转码任务前需要先在云平台中申请私有的对象存储服务, 用于存放转码完成后的音 视频资源 需要通过此接口设置相应的输出 Bucket 及具备向该 bucket 发起上传的权 限的 AK(Access Key Id) 和 SK(Secret Access Key) 若需使用委托方式实现上 传, 则需将对应 token 与临时 AK/SK 一并传入 请求参数 参数 格式 说明 必填 name 自定义存储库名称, 最大长度 128 字节 是 config 存储库配置,JSON 对象, 参考附录 - 参数详情存储库配置详情, 例如 : "endpoint": " obs.cn-north-1.myhwclouds.com", "bucket": "bucketname", "AK": "IPNUAIMO1FH24TWUBX", "SK": "U6VIJHEyPHRPJqlRoDALBwG4ZpqxMlhs0H" 注 :bucket 唯一标识一个存储, 可以根据 bucket 进行新增或修改 是 调用示例 请求示例 : 域名 ]/bucket/setbucket?name=mybucket&config="endpoint":" obs.cn-north-1. myhwclouds.com","bucket":"bucketname", AK : 23asd, SK : sadfa 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58" 19

27 第 6 章截图 6.1 创建截图 功能描述创建截图接口, 目前支持生成 jpg 格式图片 消息通知 : 创建截图时如果指定了回调地址参数则在任务完成时将向该地址回调消息 请求参数参数格式说明必填 输入文件,JSON 对象, 参考附录 - 参数详情 - 输入详 情, 例如 : input 是 "fileurl": " 截图配置,JSON 对象, 参考附录 - 参数详情 -Snapsho snapshotconfig tconfig 详情 是 userdata 用户自定义数据 callbackurl 截图完成后回调地址 返回参数 参数 格式 说明 snapshotid 截图任务 id 回调参数 当截图任务结束后如果创建截图任务时传递了回调地址则将截图结果回调该地址 参数 含义 格式 说明 snapshotid 截图任务 Id 创建截图任务时, 产生的唯一标识 snapshotpiclist 截图输出信息 SnapshotPic[] 截图完成后的输出文件列表, 当截图成功后有该参数 userdata 用户自定义数据 当用户创建任务时传递了该参数则存在该参数 回调示例 : "code": 0, "message": "", "data": 20

28 "snapshotid": "582d8806e e321c40", "userdata": " 自定义参数 ", "snapshotpiclist": [ "outputfile": "fileurl": " "pointtime": "00:00:10.000", ] 调用示例 请求示例 : 域名 ]/videosnapshot/create?input="fileurl":" pshotconfig="outputbucket":"testbucket" 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "snapshotid": "582d8806e e321c40", 6.2 查询截图 功能描述根据截图 Id 查询截图详情 请求参数参数格式说明必填 snapshotids 截图任务 id, 当查询多个截图时使用英文逗号分 隔, 一次最多查询 10 个 是 21

29 返回参数参数格式说明 snapshottasklist SnapshotTask[] 查询到的截图任务列表不存在的截图作业 ID 列表, 无数据时该结 nonexistsnapshottaskids [] 构不返回调用示例请求示例 : 域名 ]/videosnapshot/query?snapshotids=582d8806e e321c40 返回参数 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "snapshottasklist": [ "id": "57e36e01e f3d33caa", "input": "fileurl": " "snapshotpiclist": [ "outputfile": fileurl : pointtime : 00:00: ], "state": "Submitted", "code": "", "message": "", "percent": 0, "userdata": "asf", "createtime": " T12:00:00Z", "messageresult": null ] 22

30 第 7 章媒体信息 7.1 创建媒体信息任务 功能描述 调用该接口分析文件的媒体信息, 媒体信息将以异步形式返回 请求参数 参数 格式 说明 必填 input 输入文件,JSON 对象, 参考附录 - 参数详情 - 输入详情, 例如 : 是 "fileurl": " userdata 用户自定义数据, 最大长度为 1024 字节 callbackurl 回调地址, 当分析任务结束后将结果通知该地址 返回参数 参数 格式 说明 mediainfotask MediaInfoTask 创建的媒体信息任务 回调参数 当分析任务结束后如果创建分析任务时传递了回调地址则将分析结果回调该地址 参数 含义 格式 说明 mediainfotaskid 媒体信息任务 Id 创建媒体信息任务时, 产生的唯一标识 mediainfo 媒体信息 MediaInfo 分析出的媒体信息, 当任务成功时有该参数 userdata 用户自定义数据 当用户创建任务时传递了该参数则存在该参数 回调示例 : "code": 0, "message": "success", "data": "mediainfotaskid": " F38-4W33-BER5-D CA58", "userdata": "sd", "mediainfo": "general": 23

31 "format": "JPEG", "size": "102400", "pic": "format": "JPEG", "width": "100", "height": "100" 调用示例 请求示例 : 域名 ]/mediainfo/create?input= fileurl : 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "mediainfotask": "id": "57e36e01e f3d33caa", "input": "fileurl": " "mediainfo": "general": "format": "JPEG", "size": "102400", "pic": "format": "JPEG", "width": "100", "height": "100", "state": "Submitted", 24

32 "sode": "", "message": "", "percent": 0, "userdata": "asf", "createtime": " T12:00:00Z", "messageresult": null 7.2 查询媒体信息任务 功能描述根据媒体信息任务 ID 查询媒体信息任务详情 请求参数参数格式说明必填 mediainfoids 媒体信息任务 ID, 当查询多个媒体信息时使用英文逗 号分隔, 一次最多查询 10 个 是 返回参数 参数 格式 说明 mediainfotasklist MediaInfoTask[] 查询到的媒体信息任务列表 nonexistmediainfotaskids [] 不存在的媒体信息任务 ID 列表, 无数据时该结构不返回 调用示例请求示例 : 域名 ]/mediainfo/query?mediainfoids=582d8806e e321c40 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "mediainfotasklist": [ "id": "57e36e01e f3d33caa", "input": "fileurl": " 25

33 ], "mediainfo": "general": "format": "JPEG", "size": "102400", "pic": "format": "JPEG", "width": "100", "height": "100", "state": "Submitted", "code": "", "message": "", "percent": 0, "userdata": "asf", "createtime": " T12:00:00Z" 26

34 第 8 章附录 8.1 数据类型 File 描述 文件 文件地址是 fileurl 或 (bucket+endpoint+objectkey), 如果都有值以 fileurl 为主 名称 格式 说明 fileurl 文件网络访问地址, 必须是对象存储访问地址 bucket 桶名称 objectkey 对象名称 endpoint 域名 TranscodeInputFile 文件地址是 fileurl 或 (bucket+endpoint+objectkey), 如果都有值以 fileurl 为主 名称 格式 说明 fileurl 文件网络访问地址 bucket 桶名称 objectkey 对象名称 endpoint 域名 TranscodeOutputFile 描述输出文件 名称 格式 说明 outputfile File 转码输出文件信息 templateid 使用的转码模版 id watermarklist WarterMark[] 使用的水印数组 userdata 用户自定义数据 TranscodeOutput 描述输出信息 名称 格式 说明 outputfilelist TranscodeOutputFile[] 转码输出文件信息列表 27

35 WarterMark 描述 水印 名称 格式 说明 inputfile File 水印输入文件 watermarktemplateid 水印模版 ID WaterMarkTemplate 描述 水印模版 名称 格式 说明 id 水印模版 ID name 水印模版名称 width Number 宽,[8,4096] 或 (0,1], 单位 px height Number 高,[8,4096] 或 (0,1], 单位 px dx Number 水平偏移量,[0,4096], 单位 px dy Number 垂直偏移量,[0,4096], 单位 px referpos 水印的位置,TopRight TopLeft Bott omright BottomLeft type 水印类型,Image Text state 水印模板的状态,Normal Deleted TranscodeTask 描述 转码任务 名称 格式 说明 id 转码任务 ID input TranscodeInputFile 转码任务输入 outputs TranscodeOutput 转码任务输出信息 作业状态 :Submitted 表示作业已提 交,Transcoding 表示转码中, state TranscodeSuccess 表示转码成功, TranscodeFail 表示转码失败, TranscodeCancelled 表示转码取消 code 转码失败时的错误码 message 转码失败时的消息 28

36 percent 转码进度 [0,100] userdata 用户自定义数据 createtime 创建转码任务时间 taskconsumetime 任务消耗毫秒数, 任务成功则有该字段 taskendtime 转码任务结束时间 messageresult MessageResult 回调结果 MessageResult 描述回调通知结果名称 格式 说明 errorcode 失败时错误码 errormessage 失败时错误信息 messageid 回调消息 ID messagecontent 回调内容 TranscodeTemplate 名称 格式 说明 id 转码模版 id name 转码模版名称 templatecontent TranscodeTemplateCo 参考附录 - 数据类型 -TranscodeTempla ntent tecontent state Normal 表示正常,Deleted 表示已删除 TranscodeTemplateContent 名称 格式 说明 video Video 视频信息 audio Audio 音频信息 container Container 打包信息 Video 名称 格式 说明 vcodec 视频编码格式 vbitrate 视频码率 fps 视频帧率 gop 图像组 29

37 width 图像宽 height 图像高 aspect 图像比例 pixelformat 图像格式 vprofile 视频概述 vlevel 视频级别 Audio 名称 格式 说明 acodec 音频编码格式 abitrate 音频码率 channel 音频声道 samplerate 采样率 Container 名称 格式 说明 format 打包格式 extrainfo 附加信息 ctype ( 清晰度 ) 如 : 视频 :ori( 原视频 ) sh d hd sd ld, 图片 :poster( 海报 ) thumbnail( 缩略图 ) ttype ( 终端类型 ) 如 :pc mb ott weight ( 收录权重 ) 如 :1280 的视频填 100;480 填 50;480 以下填 25 SnapshotPic 名称 格式 说明 outputfile File 截图文件 pointtime 时间点, 毫秒数 SnapshotTask 名称 格式 说明 id 截图任务 ID input File 截图任务输入 snapshotpiclist SnapshotPic[] 截图任务输出图片列表 state 截图状态 :Submitted 表示作业已提交,Snapshoting 表示截图中,Snapsh 30

38 otsuccess 表示截图成功,SnapshotFai l 表示截图失败,SnapshotCancelled 表示截图取消 code 截图失败时的错误码 message 截图失败时的消息 percent 截图进度 [0,100] userdata 用户自定义数据 createtime 创建截图任务时间 messageresult MessageResult 回调结果 MediaInfoTask 名称 格式 说明 id 媒体信息任务 ID input File 媒体信息任务输入 mediainfo MediaInfo 文件媒体信息 state 媒体信息状态 :Submitted 表示已提交,Analyzing 表示正在分析 Success 表示成功 Fail 表示失败 code 媒体信息失败时的错误码 message 媒体信息失败时的消息 percent 媒体信息进度 [0,100] userdata 用户自定义数据 createtime 创建媒体信息任务时间 MediaInfo 名称 格式 说明 general MediaInfoGeneral 文件基本信息 video MediaInfoVideo 文件视频信息, 当存在视频信息时存在 audio MediaInfoAudio 文件音频信息, 当存在音频信息时存在 pic MediaInfoPic 文件图片信息, 当存在图片信息时存在 MediaInfoGeneral 名称 格式 说明 format 文件格式 size 文件大小 MediaInfoVideo 名称 格式 说明 format 文件格式 31

39 size 文件大小 duration 时长 width 宽 height 高 framerate 文件帧率 bitrate 文件码率 MediaInfoAudio 名称 格式 说明 format 文件格式 size 文件大小 duration 时长 bitrate 文件码率 MediaInfoPic 名称 格式 说明 format 文件格式 size 文件大小 width 宽 height 高 8.2 参数详情 转码输入详情 文件地址是 fileurl 或 (bucket+endpoint+objectkey), 如果都有值以 fileurl 为主 名称 格式 说明 必填 fileurl 文件网络访问地址 bucket 桶名称 objectkey 对象名称 endpoint 域名 转码输出详情名称 格式 说明 必填 templateid 转码模版 ID 是 JSON 数组, 水印列表, 音频转码模板 watermarks WaterMark[] 不支持水印, 请参照转码水印参数详情, 水印数组大小上限为 4, 即同一路 输出最多支持 4 个水印, 示例 : 32

40 [ "inputfile": fileurl :, "watermarktemplateid":"88c6ca184 c0e47098a5b665e2a126797" ] userdata 用户自定义数据, 最大长度 1024 个字节 JSON 对象, 字幕配置, 请参照附录 - SubtitleConfig 详情, 示例 : ExtSubtitleList :[ Input : subtitleconfig Bucket : example-bucket, Location : obs-cn-hangzhou, Object : example.srt, CharEnc : UTF-8 ] 如设置则覆盖指定转码模版中的对应参 container 数, 参考附录 - 参数说明 -Container 详 情 JSON 对象, 视频配置, 如设置则覆盖 video 指定转码模版中的对应参数, 请参照 附录 - 参数说明 -Video 详情 JSON 对象, 音频配置, 如设置则覆盖 audio 指定转码模版中的对应参数, 请参照 附录 - 参数说明 -Audio 详情 outputobject ObjectKey 转码完成后存入改对象, 不 33

41 填写默认生成一个 32 位 uuid+. 文件格 式 转码水印参数详情名称 格式 说明 必填 watermarktemplateid 水印模版 ID 水印输入文件, 见 输入详情, 目前支持 inputfile.png.jpg.jpeg.bmp.gif.mp4.mov 文件作为输入 仅在水印类型为 Text 时, 可不传入参数 水印内容的宽度 若设置水印模板, 则此值覆盖水印模板对应水印 图片宽 值有像素 比例两种输入形式 : width Number 像素型指水印图片宽的像素值, 范围 [8,4096], 单位 px; 比例型指相对输出视频分辨率宽的比例, 范围 (0,1], 支持 4 位小数, 如 , 超出部分系统 自动丢弃 若水印模板未设置, 默认为水印源文件宽度 水印内容的高度 若设置水印模板, 则此值覆盖水印模板对应水印 图片高 值有像素 比例两种输入形式 : height Number 像素型指水印图片高的像素值, 范围 [8,4096], 单位 px; 比例型指相对输出视频分辨率高的比例, 范围 (0,1], 支持 4 位小数, 如 , 超出部分系统 自动丢弃 若水印模板未设置, 默认为水印源文件高度 dx Number 水印图片相对输出视频的水平偏移量 若设置水印模板, 则此值覆盖水印模板对应参 34

42 数 ; 值有像素 比例两种输入形式 : 像素型代表偏移像素, 范围 [0,4096], 单位 px; 比例型代表水平偏移量与输出分辨率宽的比率, 需输入小数, 范围 (0,1) 支持 4 位小数, 如 , 超出部分系统自动丢弃 若水印模板未设置, 默认为 0 水印图片相对输出视频的垂直偏移量 若设置水印模板, 则此值覆盖水印模板对应参 数 ; 值有像素 比例两种输入形式 : dy Number 像素型代表偏移像素, 范围 [0,4096], 单位 px; 比例型代表垂直偏移量与输出分辨率高的比率, 需输入小数, 范围 (0,1) 支持 4 位小数, 如 , 超出部分系统自动丢弃 若水印模板未设置, 默认 0 水印的位置 若设置水印模板, 则此值覆盖水印模板对应参 referpos 数, 值范围 TopRight TopLeft BottomRight BottomLeft 若水印模板未设置, 默认 TopRight 水印类型 若设置水印模板, 则此值覆盖水印模板对应参 type 数 可填入 Image Text 两种类型,Image: 图片水印,Text: 文字水印, 若填写 Text, 则必须 填写 textwatermark 字段 若水印模板未设置, 默认 Image 动态水印 timeline 若设置水印模板, 则此值覆盖水印模板对应参数, 见 Timeline 详情 若水印模板未设置, 默认为空 35

43 JSON 对象, 文字水印配置, 若类型为文字水 印, 则此配置项不能为空, 详见文字水印参数 textwatermark 详情, 示例 : content : 测试, Top :2, Left :10 文字水印的输出效果以该字段内的内容为准 输入详情 文件地址是 fileurl 或 (bucket+endpoint+objectkey), 如果都有值以 fileurl 为主 名称 格式 说明 必填 fileurl 文件网络访问地址 bucket 桶名称 objectkey 对象名称 endpoint 域名 textwatermark 参数详情 名称 格式 说明 必填 Content 文字水印内容 是 FontName 文字水印字体, 默认 SimSun FontSize Int 字体大小, 默认 16, 范围 :(4, 120) FontColor 字体颜色, 默认为黑色, 见 FontColor 列表 FontAlpha Int 字体透明度, 范围 :(0, 1], 默认 1.0 Top Int 文本上边距, 默认 0, 范围 :[0,] Left Int 文本左边距, 默认 0, 范围 :[0,] 水印模版配置详情 名称 格式 说明 必填 水印内容的宽度, 默认为水印源文件宽度 值有像素 比例两种输入形式 : width Number 像素型指水印图片宽的像素值, 范围 [8,4096], 单位 p x; 比例型指相对输出视频分辨率宽的比例, 范围 (0,1], 支 持 4 位小数, 如 , 超出部分系统自动丢弃 水印内容的高度, 默认为水印源文件高度 height Number 值有像素 比例两种输入形式 : 像素型指水印图片高的像素值, 范围 [8,4096], 单位 p 36

44 dx Number dy Number referpos type Timeline 详情 x; 比例型指相对输出视频分辨率高的比例, 范围 (0,1], 支持 4 位小数, 如 , 超出部分系统自动丢弃 水印图片相对输出视频的水平偏移量, 默认值是 0 值有像素 比例两种输入形式 : 像素型代表偏移像素, 范围 [0,4096], 单位 px; 比例型代表水平偏移量与输出分辨率宽的比率, 需输入小数, 范围 (0,1) 支持 4 位小数, 如 , 超出部分系统自动丢弃水印图片相对输出视频的垂直偏移量, 默认值是 0 值有像素 比例两种输入形式 : 像素型代表偏移像素, 范围 [0,4096], 单位 px; 比例型代表垂直偏移量与输出分辨率高的比率, 需输入小数, 范围 (0,1) 支持 4 位小数, 如 , 超出部分系统自动丢弃 水印的位置, 值范围 TopRight TopLeft BottomRi ght BottomLeft 默认 TopRight 水印类型, 水印模板当前仅支持 Image 类型设置 Tex t 类型水印请在 创建转码任务 接口中进行设置 名称格式说明必填 start duration SubtitleConfig 详情 单位秒, 水印开始出现时间, 取值范围数字, 默认为 0 水印持续时间, 取值范围 [ 数字,T oend], 默认为 ToEND 名称格式说明必填 JSON 数组, 最多 1 个, 外部字幕列表 详见 附录 - 参数说明 -ExtSubtitle 详情, 示例 : [ extsubtitlelist ExtSubtitle[] Input : fileurl : ] 37

45 ExtSubtitle 详情 名称格式说明必填 input JSON 对象, 外部输入字幕文件, 目前支持 srt ass 格式, 参考附录 - 输入详情, 示例 : fileurl : Container 详情 是 名称 格式 说明 必填 容器格式, 默认值为 mp4; 视频转码支持 flv mp format 4 m3u8; 音频转码支持 mp3 ogg flac; 音频 ogg 转码时, 音频编码格式需设置为 vorbis; 音频 flac 转码时, 音频编码格式需设置为 flac suffix 文件后缀, 不设置则使用 format 作为后缀 Video 详情 名称 格式 说明 必填 vcodec 视频编码格式 vbitrate 视频码率 fps 视频帧率 gop 图像组 width 图像宽 height 图像高 aspect 图像比例 pixelformat 图像格式 vprofile 视频概述 vlevel 视频级别 Audio 详情 名称 格式 说明 必填 acodec 音频编码格式 abitrate 音频码率 channel 音频声道 38

46 samplerate 采样率 存储配置详情 名称 格式 说明 必填 endpoint 域名地址, 如 obs.myhwclouds.com 是 bucket 存储桶名称 是 AK AK( 接入键标识,Access Key ID) 是 SK SK( 安全接入键,Secret Access Key) 是 token securitytoken, 委托方式上传时需要传入此参数 若不使用委托上传方式, 不传入此值 SnapshotConfig 详情 名称格式说明必填 outputbucket 截图文件存储的 bucket 是 time interval num width height outputobject FontColor 列表 FontColor 名称 AliceBlue 截图时间, 单位毫秒, 若指定该参数表示根据时间点截图, 若截取多个时间点图片则用英文半角逗号隔开, 例如 1000,2000 表示截取第 1 秒和第 2 秒的图片, 如有该值则优先生效截图间隔时间, 单位秒, 若指定则表示定时截图,interv al 必须大于 0, 优先于 num 参数生效 截图数量, 若指定则表示定量截图, 且必须大于 0, 当 tim e interval num 都没有值时使用首帧截图截图输出图片宽度, 单位 px, 范围 [8,4096], 默认 200, 只支持整数截图输出图片高度, 单位 px, 范围 [8,4096], 默认 120, 只支持整数截图文件输出对象 key, 在该 key 里可以定义这几个参数中的一个或多个 ( 如果确定会生成多张图片需要确定生成的文件名不会重复 ),taskid( 截图任务 id) index( 截图文件序号 ) suffix( 文件后缀 ) uuid( 随机生成的字符串 ), 参数使用英文 包围, 如 cc/bb/uuid.jpg, 截图服务在上传时会主动替换这些参数, 该参数不支持首字符为 /, 如果首字符为 / 则会被替换掉 如果不传该参数则会随机生成一个文件名 对应 16 进制颜色 0xF0F8FF 39

47 40 AntiqueWhite 0xFAEBD7 Aqua 0x00FFFF Aquamarine 0x7FFFD4 Azure 0xF0FFFF Beige 0xF5F5DC Bisque 0xFFE4C4 Black 0x BlanchedAlmond 0xFFEBCD Blue 0x0000FF BlueViolet 0x8A2BE2 Brown 0xA52A2A BurlyWood 0xDEB887 CadetBlue 0x5F9EA0 Chartreuse 0x7FFF00 Chocolate 0xD2691E Coral 0xFF7F50 CornflowerBlue 0x6495ED Cornsilk 0xFFF8DC Crimson 0xDC143C Cyan 0x00FFFF DarkBlue 0x00008B DarkCyan 0x008B8B DarkGoldenRod 0xB8860B DarkGray 0xA9A9A9 DarkGreen 0x DarkKhaki 0xBDB76B DarkMagenta 0x8B008B DarkOliveGreen 0x556B2F Darkorange 0xFF8C00 DarkOrchid 0x9932CC DarkRed 0x8B0000 DarkSalmon 0xE9967A DarkSeaGreen 0x8FBC8F DarkSlateBlue 0x483D8B DarkSlateGray 0x2F4F4F DarkTurquoise 0x00CED1 DarkViolet 0x9400D3

48 41 DeepPink 0xFF1493 DeepSkyBlue 0x00BFFF DimGray 0x DodgerBlue 0x1E90FF FireBrick 0xB22222 FloralWhite 0xFFFAF0 ForestGreen 0x228B22 Fuchsia 0xFF00FF Gainsboro 0xDCDCDC GhostWhite 0xF8F8FF Gold 0xFFD700 GoldenRod 0xDAA520 Gray 0x Green 0x GreenYellow 0xADFF2F HoneyDew 0xF0FFF0 HotPink 0xFF69B4 IndianRed 0xCD5C5C Indigo 0x4B0082 Ivory 0xFFFFF0 Khaki 0xF0E68C Lavender 0xE6E6FA LavenderBlush 0xFFF0F5 LawnGreen 0x7CFC00 LemonChiffon 0xFFFACD LightBlue 0xADD8E6 LightCoral 0xF08080 LightCyan 0xE0FFFF LightGoldenRodYellow 0xFAFAD2 LightGreen 0x90EE90 LightGrey 0xD3D3D3 LightPink 0xFFB6C1 LightSalmon 0xFFA07A LightSeaGreen 0x20B2AA LightSkyBlue 0x87CEFA LightSlateGray 0x LightSteelBlue 0xB0C4DE

49 42 LightYellow 0xFFFFE0 Lime 0x00FF00 LimeGreen 0x32CD32 Linen 0xFAF0E6 Magenta 0xFF00FF Maroon 0x MediumAquaMarine 0x66CDAA MediumBlue 0x0000CD MediumOrchid 0xBA55D3 MediumPurple 0x9370D8 MediumSeaGreen 0x3CB371 MediumSlateBlue 0x7B68EE MediumSpringGreen 0x00FA9A MediumTurquoise 0x48D1CC MediumVioletRed 0xC71585 MidnightBlue 0x MintCream 0xF5FFFA MistyRose 0xFFE4E1 Moccasin 0xFFE4B5 NavajoWhite 0xFFDEAD Navy 0x OldLace 0xFDF5E6 Olive 0x OliveDrab 0x6B8E23 Orange 0xFFA500 OrangeRed 0xFF4500 Orchid 0xDA70D6 PaleGoldenRod 0xEEE8AA PaleGreen 0x98FB98 PaleTurquoise 0xAFEEEE PaleVioletRed 0xD87093 PapayaWhip 0xFFEFD5 PeachPuff 0xFFDAB9 Peru 0xCD853F Pink 0xFFC0CB Plum 0xDDA0DD PowderBlue 0xB0E0E6

50 Purple Red RosyBrown RoyalBlue SaddleBrown Salmon SandyBrown SeaGreen SeaShell Sienna Silver SkyBlue SlateBlue SlateGray Snow SpringGreen SteelBlue Tan Teal Thistle Tomato Turquoise Violet Wheat White WhiteSmoke Yellow YellowGreen 8.3 预置模板详情 0x xFF0000 0xBC8F8F 0x4169E1 0x8B4513 0xFA8072 0xF4A460 0x2E8B57 0xFFF5EE 0xA0522D 0xC0C0C0 0x87CEEB 0x6A5ACD 0x xFFFAFA 0x00FF7F 0x4682B4 0xD2B48C 0x xD8BFD8 0xFF6347 0x40E0D0 0xEE82EE 0xF5DEB3 0xFFFFFF 0xF5F5F5 0xFFFF00 0x9ACD32 普通转码模板 模板 ID 模板名 容器容器视频码率音频码率分辨格式格式 (Kbps) (Kbps) 率 - 宽 S MP4 H p MP4 H S MP4 H264 流畅 270p MP4 H S MP4 H264 流畅 360p MP4 H H MP4 H265 流畅 360p MP4 H S MP4 H264 标清 540p MP4 H

51 H MP4 H265 标清 540p MP4 H S MP4 H264 高清 720p MP4 H H MP4 H265 高清 720p MP4 H S MP4 H264 超清 1080p MP4 H H MP4 H265 超清 1080p MP4 H S MP4 H264 2K 1440p MP4 H H MP4 H265 2K 1440p MP4 H S FLV H264 流畅 360p FLV H S FLV H264 标清 540p FLV H S FLV H264 高清 720p FLV H S FLV H264 超清 1080p FLV H S FLV H264 2K 1440p FLV H S M3U8 h264 流畅 360p M3U8 H S M3U8 H264 标清 540p M3U8 H S M3U8 H264 高清 720p M3U8 H S M3U8 H264 超清 1080p M3U8 H S MP4 H264 超清 1080p 监控纯视频 MP4 H 模板 ID D D D D D D D 感知增强高清模板 模板名 容器视频视频码率音频码率分辨格式编码格式 (Kbps) (Kbps) 率 - 宽 感知增强 MP4 h264 2K 1440p MP4 H 感知增强 MP4 h264 超清 1080p MP4 H 感知增强 MP4 h264 高清 720p MP4 H 感知增强 mp4 h264 标清 540p MP4 H 感知增强 mp4 h264 流畅 320p MP4 H 感知增强 FLV h264 2K 1440p FLV H 感知增强 FLV h264 超清 1080p FLV H

52 D D D 感知增强 FLV h264 高清 720p 感知增强 flv h264 标清 540p 感知增强 flv h264 流畅 360p FLV H FLV H FLV H 低转高模板 模板 ID 模板名 视频视频码容器音频码率分辨编码率 (Kbp 格式 (Kbps) 率 - 宽格式 s) LTH LowToHigh-SD_HD 720p MP4 H LTH LowToHigh-2k-4k 2160p MP4 H LTH001-F6027 LowToHigh-60Fps 720p MP4 H LTH001-F12027 LowToHigh-120Fps 720p MP4 H 音视频抽离模板 模板 ID 模板名 中文名 容器视频码率音频码率分辨率格式 (Kbps) (Kbps) - 宽 VS 视音频抽离 - 视频 视音频抽离 - 视频 MP AS 视音频抽离 - 音频 视音频抽离 - 音频 MP 竖屏转码模板 模板 ID 模板名 视频码音频码分辨容器视频编码率率率 - 格式格式 (Kbps) (Kbps) 宽 V MP4 H264 流畅 360p 竖屏 MP4 H HV MP4 H265 流畅 360p 竖屏 MP4 H V MP4 H264 标清 540p 竖屏 MP4 H HV MP4 H265 标清 540p 竖屏 MP4 H V MP4 H264 高清 720p 竖屏 MP4 H HV MP4 H265 高清 720p 竖屏 MP4 H V MP4 H264 超清 1080p 竖屏 MP4 H HV MP4 H265 超清 1080p 竖屏 MP4 H V FLV H264 流畅 360p 竖屏 FLV H

53 V FLV H264 标清 540p 竖屏 FLV H V FLV H264 高清 720p 竖屏 FLV H V FLV H264 超清 1080p 竖屏 FLV H V M3U8 H264 流畅 360p 竖屏 M3U8 H V M3U8 H264 标清 540p 竖屏 M3U8 H V M3U8 H264 高清 720p 竖屏 M3U8 H V M3U8 H264 超清 1080p 竖屏 M3U8 H 音频模板 模板 ID 模板名 容器格式 音频码率 (Kbps) 采样率 声道数 S MP3 64Kbps MP 状态码 代码 描述 说明 0 Success 操作成功 1 Failure 执行失败 Inner Error 系统内部错误 Input Parameter Invali 输入参数不正确 d file does not found 文件无法访问 no access 没有权限 其它错误 未知错误 46