江苏台荔枝云总体技术方案V1.0

Transcription

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

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

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

4 调用示例 查询水印模板 功能描述 请求参数 返回参数 调用示例 水印列表 功能描述 请求参数 返回参数 调用示例 删除水印模板 功能描述 请求参数 返回参数 调用示例 第 5 章存储库设置接口 设置存储库 功能描述 请求参数 调用示例 第 6 章截图 创建截图 功能描述 请求参数 返回参数 III

5 回调参数 调用示例 查询截图 功能描述 请求参数 返回参数 调用示例 第 7 章媒体信息 创建媒体信息任务 功能描述 请求参数 返回参数 回调参数 调用示例 查询媒体信息任务 功能描述 请求参数 返回参数 调用示例 第 8 章附录 数据类型 File TranscodeInputFile TranscodeOutputFile TranscodeOutput WarterMark IV

6 WaterMarkTemplate TranscodeTask MessageResult TranscodeTemplate TranscodeTemplateContent Video Audio Container SnapshotPic SnapshotTask MediaInfoTask MediaInfo MediaInfoGeneral MediaInfoVideo MediaInfoAudio MediaInfoPic 参数详情 转码输入详情 转码输出详情 转码水印参数详情 输入详情 文字水印参数详情 水印模版配置详情 Timeline 详情 SubtitleConfig 详情 ExtSubtitle 详情 Container 详情 V

7 Video 详情 Audio 详情 存储配置详情 SnapshotConfig 详情 状态码 VI

8 第 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", "~")

9 公共参数 属性 含义 类型 说明 必填 timestamp 时间戳 long 北京时间 1970 年 01 月 01 日 08 时 00 是 分 00 秒起至现在的总秒数 地址示例 第一部分 第二部分 timestamp= 第一部分是具体接口服务的接口地址, 由接口服务根据一定规则 ( 按照不同功能进行命 名上的区分 ) 自定义, 第二部分为公共参数, 是每个接口调用的必填项 1.3. 返回结果 "code": 0, # 状态码, 参照附录 "message": "success", # 描述信息 "data": "requestid": " F38-4W33-BER5-D CA58" # 结果数据 8

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

11 返回参数 参数含义格式说明 transcodetasklist 创建转码任务 transcodetask[] 创建转码作业结果 回调参数 转码任务结束后, 由转码服务发起调用, 回调地址为 callbackurl 的值, 具体调用参数 见下表 参数含义格式说明必填 transcodeid 任务 Id 创建转码任务时, 产生的唯一标识 outputfilelis 转码输出信息 transcodeout 转码完成后的输出文件列表, t putfile[] 当转码成功后有该参数 userdata 用户自定义数 当用户创建任务时传递了该参 据 数则存在该参数 是 回调请求示例 : "code": 0, "message": "", "data": "transcodetaskid": "582d8806e e321c40", "userdata": " 自定义参数 ", "outputfilelist": [ "outputfile": "fileurl": " "templateid": "57e36e01e f3d33caa", "watermarklist": [ 10

12 d33caa" ] ] "inputfile": "fileurl": "", "watermarktemplateid": "57e36e01e f 调用示例 请求示例 : 域名 ]/transcodetask/create?input="fileurl":" 4"&outputBucket=bucketName&callbackUrl= ut=["templateid":"s ","watermarks":["inputfile":"fileurl":""," watermarktemplateid":"88c6ca184c0e47098a5b665e2a126797"]]&< 公共参数 > 返回示例 : "code": 0, "message": "success", "data": "transcodetasklist": [ "id": "57e36e01e f3d33caa", "input": 11

13 "fileurl": " "outputs": outputfilelist : [ "outputfilelist": [ "outputfile": null, "templateid": "57e36e01e f3d3 3caa", "watermarklist": [ "inputfile": "fileurl": " om/a.mp4", "watermarktemplateid": "57e3 6e01e f3d33caa" ] ] ], "state": "Submitted", "sode": "", "message": "", "percent": 0, "userdata": "asf", "createtime": " T12:00:00Z", "messageresult": null ] 12

14 2.2. 取消转码任务 功能描述 根据任务 id 取消已经已提交的转码任务, 如果已经开始转码则会失败 请求参数 参数含义格式说明必填 transcodetas kid 任务 id 是 返回参数 参数含义格式说明 transcodetaskid 转码任务 Id 取消转码任务 id 调用示例 请求示例 : 域名 ]/transcodetask/cancel?transcodetaskid=57e36e01e f3d33 caa&< 公共参数 > 返回示例 : "code": 0, "message": "", 13

15 "data": "requestid": " F38-4W33-BER5-D CA58", "transcodetaskid": "57e36e01e f3d33caa" 2.3. 查询转码任务 功能描述 根据任务 id 查询转码任务详情 请求参数 参数含义格式说明必填 transcodetas kids 任务 id 转码任务 ID 列表, 逗号分隔, 一次最多 10 个 是 返回参数 参数 格式 说明 transcodetasklist TranscodeTask[] 查询到的转码任务列表 nonexisttranscodetaski ds [] 不存在的转码作业 ID 列表, 无数据时该结构不返回 调用示例 请求示例 : POST 域名 ]/transcodetask/query?transcodetaskids=57e36e01e f3d33caa&< 公共参数 > 14

16 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "transcodetasklist": [ "id": "57e36e01e f3d33caa", "input": "fileurl": " "outputs": outputfilelist : [ "outputfilelist": [ "outputfile": null, "templateid": "57e36e01e f3d3 3caa", "watermarklist": [ "inputfile": "fileurl": " om/a.mp4", "watermarktemplateid": "57e3 6e01e f3d33caa" ] ] 15

17 ] ], "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 表示所有状态,Sub mitted 表示作业已提交,Transcoding 表示转码中,TranscodeSuccess 表示转码成功,TranscodeFail 表示转码失败, TranscodeCancelled 表示转码取消, 默认是 All 16

18 返回参数 参数 格式 说明 Transco list detask[] 转码任务列表 currentpage int 当前页 pagesize int 页大小 totalcount int 总条数 pagecount int 总页数 调用示例 请求示例 : POST 域名 ]/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": " 17

19 "outputs": outputfilelist :[ "outputfilelist": [ "outputfile": null, "templateid": "57e36e01e f3d3 3caa", "watermarklist": [ "inputfile": "fileurl": " om/a.mp4", "watermarktemplateid": "57e3 6e01e f3d33caa" ] ] ], "state": "Submitted", "code": "", "message": "", "percent": 0, "userdata": "asf", "createtime": " T12:00:00Z", "messageresult": null ] 18

20 第 3 章转码模板相关接口 3.1. 查询转码模板列表 功能描述 查询系统已有转码模板 请求参数 参数格式说明必填 currentpage 当前分页, 默认是 1 pagesize 页大小,1-100 的数, 默认是 返回参数 参数 格式 说明 list TranscodeTemplate[] 模板列表 currentpage Int 当前页 pagesize Int 页大小 totalcount Int 总条数 pagecount Int 总页数 调用示例 请求示例 : 域名 ]/transcodetemplate/list?currentpage=1&pagesize=10&< 公共参 数 > 19

21 返回示例 : "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 查询转码模版详情 20

22 请求参数 参数格式说明必填 templateids 转码模版 ID, 逗号分隔, 每次最多 10 个是 返回参数 参数 格式 说明 templatelist TranscodeTemplate[] 模板列表 nonexisttemplate Ids [] 不存在模版 ID, 当查询参数中有不存在的模板 id 时在该字段返回, 无数据时该结构不返回 调用示例 请求示例 : 域名 ]/transcodetemplate/query?templateids=582d8806e e321 c40&< 公共参数 > 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "templatelist": [ "id": "582d8806e e321c40", "name": "MTS-example", "templatecontent": "video": "vcodec": "" 21

23 ], "state": "Normal" 第 4 章水印相关接口 4.1. 创建水印模板 功能描述 创建水印模板 水印模板决定水印转码后输出文件的水印位置 大小 出现时长等状态 创建水印模板后, 需要在创建转码任务时输入可访问的水印 URL 地址 水印模板相关接口目前仅支持图片 视频水印模板的设置 文字水印需在调用 创建转码任务 时设置 请求参数 参数 格式 说明 必填 name 自定义的水印模板名称, 最大长度 128 字节 是 水印模板配置,JSON 对象, 参考附录 - 参数详情水 印模版配置详情, 例如 : config "width": "10", 是 "height": "30", "dx": "10", "dy": "5", 22

24 "referpos": "TopRight", "type": "Image", "timeline": "start": "0", "duration": "10" 返回参数 参数 格式 说明 水印模板信息, 含水印模板 ID, 供调用水印 watermarktemplate WarterMarkTemplate 模板使用 调用示例 请求示例 : 域名 ]/transcodewartermark/create?name=wartermarktemplate1&confi g="width":"100","height":"50","dx":"100","dy":"100","referpos":"topright","typ e":"image","state":"normal"&< 公共参数 > 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "watermarktemplate": "id": "88c6ca184c0e47098a5b665e2a126797", "name": "example-watermark", "width": "10", "height": "30", 23

25 "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 " 是 24

26 返回参数 参数格式说明 watermarktemplate WarterMarkTemplate 更新后的模板 调用示例 请求示例 : 域名 ]/transcodewartermark/update?watermarktemplateids=582d8806 e e321c40&name=wartermarktemplate1&config="width":"100","hei ght":"50","dx":"100","dy":"100","referpos":"topright","type":"image","state":"no rmal"&< 公共参数 > 返回示例 : "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" 25

27 4.3. 查询水印模板 功能描述 根据水印模板 id 查询水印模板详情 请求参数 参数格式说明必填 watermarktemplateids 水印模板 ID 列表, 最多一次查 10 个, 逗号分隔 是 返回参数 参数格式说明 Templat 查询到的模板列表 watermarktemplatelist e[] nonexistwatermarktemplateids [] 不存在的水印模板列表, 无数据时该结构不返回 调用示例 请求示例 : 域名 ]/transcodewartermark/query?watermarktemplateids=582d8806e e321c40&< 公共参数 > 返回示例 : "code": 0, "message": "success", 26

28 "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 27

29 返回参数 参数 格式 说明 WaterM arktem 查询到的模板列表 list plate[] 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", 28

30 ] "height": "30", "dx": "10", "dy": "5", "referpos": "TopRight", "type": "Image", "state": "Normal" 4.5. 删除水印模板 功能描述 将水印模板删除 请求参数 参数含义格式说明必填 watermarkte mplateid 水印模板 id 需要删除的水印模板 id 是 返回参数 参数格式说明 watermarktemplateid 删除成功的水印模板 id 调用示例 请求示例 : 29

31 域名 ]/transcodewartermark/delete?watermarktemplateid=582d8806e e321c40&< 公共参数 > 返回示例 : " "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "watermarktemplateid": "88c6ca184c0e47098a5b665e2a

32 第 5 章存储库设置接口 5.1. 设置存储库 功能描述 创建转码任务前需要先在云平台中申请私有的对象存储服务, 用于存放转码完成后的音 视频资源 需要通过此接口设置相应的输出媒体 Bucket 只有该 bucket 上传权限的 AK(Access Key ID) 和 SK(Secret Access Key) 请求参数 参数 格式 说明 必填 name 自定义存储库名称, 最大长度 128 字节 是 存储库配置,JSON 对象, 参考附录 - 参数详情存储 库配置详情, 例如 : "endpoint": "cn-north-1", "bucket": "bucketname", config "AK": "IPNUAIMO1FH24TWUBX", 是 "SK": "U6VIJHEyPHRPJqlRoDALBwG4ZpqxMl hs0h" 注 :bucket 唯一标识一个存储, 可以根据 bucket 进 行新增或修改 调用示例 请求示例 : 域名 ]/bucket/setbucket?name=mybucket&config="endpoint":"cn-nort h-1","bucket":"bucketname", AK : 23asd, SK : sadfa &< 公共参数 > 31

33 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58" 32

34 第 6 章截图 6.1. 创建截图 功能描述 创建截图接口, 目前支持生成 jpg 格式图片 消息通知 : 创建截图时如果指定了回调地址参数则在任务完成时回调该地址 请求参数 参数格式说明必填 输入文件,JSON 对象, 参考附录 - 参数详情 - 输入详 情, 例如 : input 是 "fileurl": " 截图配置,JSON 对象, 参考附录 - 参数详情 -Snaps snapshotconfig hotconfig 详情 是 userdata 用户自定义数据 callbackurl 截图完成后回调地址 返回参数 参数格式说明 snapshotid 截图任务 id 33

35 回调参数 当截图任务结束后如果创建截图任务时传递了回调地址则将截图结果回调该地址 参数含义格式说明必填 snapshotid 截图任务 Id 创建截图任务时, 产生的唯一标识 snapshotpic 截图输出信息 SnapshotPic[] 截图完成后的输出文件列表, List 当截图成功后有该参数 userdata 用户自定义数 当用户创建任务时传递了该参 据 数则存在该参数 是 回调示例 : "code": 0, "message": "", "data": "snapshotid": "582d8806e e321c40", "userdata": " 自定义参数 ", "snapshotpiclist": [ "outputfile": "fileurl": " "pointtime": "00:00:10.000", ] 34

36 调用示例 请求示例 : 域名 ]/videosnapshot/create?input="fileurl":" a.mp4"&snapshotconfig="outputbucket":"testbucket"&< 公共参数 > 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "snapshotid": "582d8806e e321c40", 6.2. 查询截图 功能描述 根据截图查询截图详情 请求参数 参数格式说明必填 snapshotids 截图任务 id, 当查询多个截图时使用英文逗号分隔, 一次最多查询 10 个 是 35

37 返回参数 参数 格式 说明 snapshottasklist SnapshotTask[] 查询到的截图任务列表 nonexistsnapshottaskid s [] 不存在的截图作业 ID 列表, 无数据时该结构不返回 调用示例 请求示例 : 域名 ]/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:

38 ] ], "state": "Submitted", "code": "", "message": "", "percent": 0, "userdata": "asf", "createtime": " T12:00:00Z", "messageresult": null 第 7 章媒体信息 7.1. 创建媒体信息任务 功能描述 调用该接口分析文件的媒体信息, 异步返回该文件的媒体信息 请求参数 参数 格式 说明 必填 input 输入文件,JSON 对象, 参考附录 - 参数详情 - 输入详情, 例如 : 是 "fileurl": " userdata 用户自定义数据, 最大长度为 1024 字节 callbackurl 回调地址, 当分析任务结束后将结果通知该地址 37

39 返回参数 参数格式说明 mediainfotask MediaInfoTask 创建的媒体信息任务 回调参数 当分析任务结束后如果创建分析任务时传递了回调地址则将分析结果回调该地址 参数含义格式说明必填 mediainfota skid 媒体信息任务 Id 创建媒体信息任务时, 产生的唯一标识 mediainfo 媒体信息 MediaInfo 分析出的媒体信息, 当任务成 功时有该参数 userdata 用户自定义数 当用户创建任务时传递了该参 据 数则存在该参数 是 回调示例 : ", "code": 0, "message": "success", "data": "mediainfotaskid": " F38-4W33-BER5-D CA58 "userdata": "sd", "mediainfo": "general": "format": "JPEG", "size": "102400", "pic": "format": "JPEG", "width": "100", 38

40 "height": "100" 调用示例 请求示例 : 域名 ]/mediainfo/create?input= fileurl : 4 &< 公共参数 > 返回示例 : "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", 39

41 "height": "100", "state": "Submitted", "sode": "", "message": "", "percent": 0, "userdata": "asf", "createtime": " T12:00:00Z", "messageresult": null 7.2. 查询媒体信息任务 功能描述 根据媒体信息任务 ID 查询媒体信息任务详情 请求参数 参数格式说明必填 mediainfoids 媒体信息任务 ID, 当查询多个媒体信息时使用英文逗 号分隔, 一次最多查询 10 个 是 返回参数 参数 格式 说明 mediainfotasklist MediaInfoTask[] 查询到的媒体信息任务列表 nonexistmediainfotaski ds [] 不存在的媒体信息任务 ID 列表, 无数据时该结构不返回 40

42 调用示例 请求示例 : 域名 ]/mediainfo/query?mediainfoids=582d8806e e321c40&< 公 共参数 > 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "mediainfotasklist": [ "id": "57e36e01e f3d33caa", "input": "fileurl": " "mediainfo": "general": "format": "JPEG", "size": "102400", "pic": "format": "JPEG", "width": "100", "height": "100", "state": "Submitted", "code": "", "message": "", 41

43 ] "percent": 0, "userdata": "asf", "createtime": " T12:00:00Z" 42

44 第 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 转码输出文件信息 43

45 templateid 使用的转码模版 id 是 watermarklist WarterMark [] 使用的水印数组 userdata 用户自定义数据 TranscodeOutput 描述 输出信息 名称格式说明必填 Transcode outputfilelist OutputFile 转码输出文件信息列表 是 [] WarterMark 描述 水印 名称格式说明必填 inputfile File 水印输入文件是 watermarktemplateid 水印模版 ID WaterMarkTemplate 描述 水印模版 名称 格式 说明 必填 id 水印模版 ID 是 name 水印模版名称 是 width Number 宽,[8,4096] 或 (0,1], 单位 px 44

46 height Number 高,[8,4096] 或 (0,1], 单位 px dx Number 水平偏移量,[0,4096], 单位 px dy Number 垂直偏移量,[0,4096], 单位 px referpos 水印的位置,TopRight TopLef t BottomRight BottomLeft type 水印类型,Image Text 是 state 水印模板的状态,Normal Delete d 是 TranscodeTask 描述 转码任务 名称 格式 说明 必填 id 转码任务 ID 是 input TranscodeIn putfile 转码任务输入 是 outputs TranscodeO utput 转码任务输出信息 是 state 作业状态 :Submitted 表示作业已提交,Transcoding 表示转码中,T ranscodesuccess 表示转码成功, 是 TranscodeFail 表示转码失败,Tran scodecancelled 表示转码取消 code 转码失败时的错误码 message 转码失败时的消息 percent 转码进度 [0,100] userdata 用户自定义数据 createtime 创建转码任务时间 taskconsumetime 任务消耗毫秒数, 任务成功则有该字段 taskendtime 转码任务结束时间 messageresult MessageRes ult 回调结果 45

47 MessageResult 描述 回调通知结果 名称 格式 说明 必填 errorcode 失败时错误码 是 errormessage 失败时错误信息 是 messageid 回调消息 ID 是 messagecontent 回调内容 是 TranscodeTemplate 名称 格式 说明 必填 id 转码模版 id 是 name 转码模版名称 是 templatecontent TranscodeTe 参考附录 - 数据类型 -TranscodeTe mplateconte mplatecontent nt 是 state Normal 表示正常,Deleted 表示已删除 是 TranscodeTemplateContent 名称 格式 说明 必填 video Video 视频信息 audio Audio 音频信息 container Container 打包信息 46

48 Video 名称 格式 说明 必填 vcodec 视频编码格式 vbitrate 视频码率 fps 视频帧率 gop 图像组 width 图像宽 height 图像高 aspect 图像比例 pixelformat 图像格式 vprofile 视频概述 vlevel 视频级别 Audio 名称 格式 说明 必填 acodec 音频编码格式 abitrate 音频码率 channel 音频声道 samplerate 采样率 Container 名称 格式 说明 必填 format 打包格式 extrainfo 附加信息 ( 清晰度 ) 如 : 视频 :ori( 原视 ctype 频 ) shd hd sd ld, 图片 :p oster( 海报 ) thumbnail( 缩略 图 ) ttype ( 终端类型 ) 如 :pc mb ott weight ( 收录权重 ) 如 :1280 的视频填 100; 47

49 480 填 50;480 以下填 SnapshotPic 名称格式说明必填 outputfile File 截图文件是 pointtime 时间点, 毫秒数 SnapshotTask 名称 格式 说明 必填 id 截图任务 ID 是 input File 截图任务输入 是 snapshotpiclist SnapshotPic [] 截图任务输出图片列表 state 截图状态 :Submitted 表示作业已提交,Snapshoting 表示截图中, SnapshotSuccess 表示截图成功, 是 SnapshotFail 表示截图失败,Snap shotcancelled 表示截图取消 code 截图失败时的错误码 message 截图失败时的消息 percent 截图进度 [0,100] userdata 用户自定义数据 createtime 创建截图任务时间 messageresult MessageRes ult 回调结果 48

50 MediaInfoTask 名称 格式 说明 必填 id 媒体信息任务 ID 是 input File 媒体信息任务输入 是 mediainfo MediaInfo 文件媒体信息 state 媒体信息状态 :Submitted 表示已提交,Analyzing 表示正在分析 S 是 uccess 表示成功 Fail 表示失败 code 媒体信息失败时的错误码 message 媒体信息失败时的消息 percent 媒体信息进度 [0,100] userdata 用户自定义数据 createtime 创建媒体信息任务时间 MediaInfo 名称格式说明必填 general MediaInfoG eneral 文件基本信息 video MediaInfoVi deo 文件视频信息, 当存在视频信息时存在 audio MediaInfoA udio 文件音频信息, 当存在音频信息时存在 pic MediaInfoPi c 文件图片信息, 当存在图片信息时存在 MediaInfoGeneral 名称格式说明必填 format 文件格式 size 文件大小 49

51 MediaInfoVideo 名称 格式 说明 必填 format 文件格式 size 文件大小 duration 时长 width 宽 height 高 framerate 文件帧率 bitrate 文件码率 MediaInfoAudio 名称 格式 说明 必填 format 文件格式 size 文件大小 duration 时长 bitrate 文件码率 MediaInfoPic 名称 格式 说明 必填 format 文件格式 size 文件大小 width 宽 height 高 50

52 8.2. 参数详情 转码输入详情 主 文件地址是 fileurl 或 (bucket+endpoint+objectkey), 如果都有值以 fileurl 为 名称 格式 说明 必填 fileurl 文件网络访问地址 bucket 桶名称 objectkey 对象名称 endpoint 域名 转码输出详情 名称格式说明必填 templateid 转码模版 ID 是 JSON 数组, 水印列表, 音频转码模 板不支持水印, 请参照转码水印参 数详情, 水印数组大小上限为 4, 既 同一路输出最多支持 4 个水印, 示 例 : watermarks WaterMark[] [ "inputfile": fileurl :, "watermarktemplateid":"88c6ca1 84c0e47098a5b665e2a126797" ] userdata 用户自定义数据, 最大长度 1024 个字节 JSON 对象, 字幕配置, 请参照附 subtitleconfig 录 -SubtitleConfig 详情, 示例 : ExtSubtitleList :[ 51

53 Input : Bucket : example-bucket, Location : obs-cn-hangzho u, Object : example.srt, CharEnc : UTF-8 ] 如设置则覆盖指定转码模版中的对 container 应参数, 参考附录 - 参数说明 -Cont ainer 详情 JSON 对象, 视频配置, 如设置则覆 video 盖指定转码模版中的对应参数, 请 参照附录 - 参数说明 -Video 详情 JSON 对象, 音频配置, 如设置则覆 audio 盖指定转码模版中的对应参数, 请 参照附录 - 参数说明 -Audio 详情 ObjectKey 转码完成后存入改对 outputobject 象, 不填写默认生成一个 32 位 uui d+. 文件格式 转码水印参数详情 名称格式说明必填 watermarktemplateid 水印模版 ID 水印输入文件, 见 输入详情, inputfile 目前支持 png jpg jpeg bmp 是 文件作为输入 若设置, 则此值覆盖水印模板对应 width Number 水印图片宽, 值有像素 比例两种输入形式 : 像素型指水印图片宽的像素值, 范 52

54 围 [8,4096], 单位 px; 比例型指相对输出视频分辨率宽的 比例, 范围 (0,1], 支持 4 位小数, 如 , 超出部分系统自动丢弃 若设置, 则此值覆盖水印模板对应 水印图片高, 值有像素 比例两种 输入形式 : height Number 像素型指水印图片高的像素值, 范围 [8,4096], 单位 px; 比例型指相对输出视频分辨率高的 比例, 范围 (0,1], 支持 4 位小数, 如 , 超出部分系统自动丢弃 若设置, 则此值覆盖水印模板对应 参数, 水印图片相对输出视频的水 平偏移量, 默认值是 0; 值有像 素 比例两种输入形式 : dx Number 像素型代表偏移像素, 范围 [0,409 6], 单位 px; 比例型代表水平偏移量与输出分辨 率宽的比率, 需输入小数, 范围 (0, 1) 支持 4 位小数, 如 , 超 出部分系统自动丢弃 若设置, 则此值覆盖水印模板对应 参数, 水印图片相对输出视频的垂 直偏移量, 默认值是 0; 值有像 素 比例两种输入形式 : dy Number 像素型代表偏移像素, 范围 [0,409 6], 单位 px; 比例型代表垂直偏移量与输出分辨 率高的比率, 需输入小数, 范围 (0, 1) 支持 4 位小数, 如 , 超 出部分系统自动丢弃 若设置, 则此值覆盖水印模板对应 referpos 参数, 水印的位置, 值范围 TopRig ht TopLeft BottomRight Bott omleft type 若设置, 则此值覆盖水印模板对应参数, 水印类型,Image Text, 53

55 默认为 Image,Image: 图片水印, Text: 文字水印, 若填写 Text, 则必 须填写 textwatermark 字段 timeline 若设置, 则此值覆盖水印模板对应参数, 动态水印, 见 Timeline 详情 JSON 对象, 文字水印配置, 若类 型为文字水印, 则此配置项不能为 textwatermark 空, 详见文字水印参数详情, 示 例 : content : 测试, To p :2, Left : 输入详情 文件地址是 fileurl 或 (bucket+endpoint+objectkey), 如果都有值以 fileurl 为 主 名称 格式 说明 必填 fileurl 文件网络访问地址 bucket 桶名称 objectkey 对象名称 endpoint 域名 textwatermark 参数详情 名称 格式 说明 必填 Content 文字水印内容 是 FontName 默认 SimSun FontSize Int 字体大小, 默认 16, 范围 :(4, 12 0) FontColor 字体颜色 FontAlpha Int 字体透明度, 范围 :(0, 1], 默认 1. 54

56 Top Int 文本上边距, 默认 0, 范围 :[0,] Left Int 文本左边距, 默认 0, 范围 :[0,] 水印模版配置详情 名称格式说明必填 若设置, 则此值覆盖水印模板对应 水印图片宽, 值有像素 比例两种 输入形式 : width Number 像素型指水印图片宽的像素值, 范围 [8,4096], 单位 px; 比例型指相对输出视频分辨率宽的 比例, 范围 (0,1], 支持 4 位小数, 如 , 超出部分系统自动丢弃 若设置, 则此值覆盖水印模板对应 水印图片高, 值有像素 比例两种 输入形式 : height Number 像素型指水印图片高的像素值, 范围 [8,4096], 单位 px; 比例型指相对输出视频分辨率高的 比例, 范围 (0,1], 支持 4 位小数, 如 , 超出部分系统自动丢弃 若设置, 则此值覆盖水印模板对应 参数, 水印图片相对输出视频的水 平偏移量, 默认值是 0; 值有像 素 比例两种输入形式 : dx Number 像素型代表偏移像素, 范围 [0,409 6], 单位 px; 比例型代表水平偏移量与输出分辨 率宽的比率, 需输入小数, 范围 (0, 1) 支持 4 位小数, 如 , 超 出部分系统自动丢弃 若设置, 则此值覆盖水印模板对应 dy Number 参数, 水印图片相对输出视频的垂直偏移量, 默认值是 0; 值有像 素 比例两种输入形式 : 55

57 像素型代表偏移像素, 范围 [0,409 6], 单位 px; 比例型代表垂直偏移量与输出分辨 率高的比率, 需输入小数, 范围 (0, 1) 支持 4 位小数, 如 , 超 出部分系统自动丢弃 若设置, 则此值覆盖水印模板对应 referpos 参数, 水印的位置, 值范围 TopRig ht TopLeft BottomRight Bott omleft 若设置, 则此值覆盖水印模板对应 参数, 水印类型,Image Text, type 默认为 Image,Image: 图片水印, Text: 文字水印, 若填写 Text, 则必 须填写 textwatermark 字段 timeline 若设置, 则此值覆盖水印模板对应参数, 动态水印, 见 Timeline 详情 Timeline 详情 名称格式说明必填 start 单位秒, 水印开始出现时间, 取值范围数字, 默认为 0 duration 水印持续时间, 取值范围 [ 数字,T oend], 默认为 ToEND SubtitleConfig 详情 名称格式说明必填 JSON 数组, 最多 1 个, 外部字幕 列表 详见附录 - 参数说明 -ExtSub extsubtitlelist ExtSubtitle[] title 详情, 示例 : [ 56

58 Input : fileurl : /aa.mp4 ] ExtSubtitle 详情 名称格式说明必填 JSON 对象, 外部输入字幕文件, 目 前支持 srt ass 格式, 参考附录 - 输入详情, 示例 : input 是 fileurl : /a.mp Container 详情 名称格式说明必填 容器格式, 默认值为 mp4; 视频转 format 码支持 flv mp4 m3u8; 音频转 码支持 mp3 ogg flac; suffix 文件后缀, 不设置则使用 format 作为后缀 Video 详情 名称 格式 说明 必填 vcodec 视频编码格式 vbitrate 视频码率 fps 视频帧率 gop 图像组 width 图像宽 57

59 height 图像高 aspect 图像比例 pixelformat 图像格式 vprofile 视频概述 vlevel 视频级别 Audio 详情 名称 格式 说明 必填 acodec 音频编码格式 abitrate 音频码率 channel 音频声道 samplerate 采样率 存储配置详情 名称 格式 说明 必填 endpoint 域名地址, 如 obs.myhwclouds.co m 是 bucket 存储桶名称 是 AK AK( 接入键标识,Access Key I D) 是 SK SK( 安全接入键,Secret Access Key) 是 SnapshotConfig 详情 名称格式说明必填 outputbucket 截图文件存储的 bucket 是 截图时间, 单位毫秒, 若指定该参 time 数表示根据时间点截图, 若截取多 个时间点图片则用英文半角逗号隔 58

60 开, 例如 1000,2000 表示截取第 1 秒和第 2 秒的图片, 如有该值则优 先生效 截图间隔时间, 单位秒, 若指定则 interval 表示定时截图,interval 必须大于 0, 优先于 num 参数生效 截图数量, 若指定则表示定量截 num 图, 且必须大于 0, 当 time interva l num 都没有值时使用首帧截图 width 截图输出图片宽度, 单位 px, 范围 [8,4096], 默认 200, 只支持整数 height 截图输出图片高度, 单位 px, 范围 [8,4096], 默认 120, 只支持整数 截图文件输出对象 key, 在该 key 里可以定义这几个参数中的一个或 多个 ( 如果确定会生成多张图片需 要确定生成的文件名不会重复 ),t askid( 截图任务 id) index( 截图文 outputobject 件序号 ) suffix( 文件后缀 ) uuid ( 随机生成的字符串 ), 参数使用英文 包围, 如 cc/bb/uuid.jpg, 截图 服务在上传时会主动替换这些参 数, 该参数不支持首字符为 /, 如果 首字符为 / 则会被替换掉 如果不传 该参数则会随机生成一个文件名 FontColor 列表 FontColor 名称 AliceBlue AntiqueWhite Aqua Aquamarine Azure Beige Bisque Black 对应 16 进制颜色 0xF0F8FF 0xFAEBD7 0x00FFFF 0x7FFFD4 0xF0FFFF 0xF5F5DC 0xFFE4C4 0x

61 60 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 DeepPink 0xFF1493 DeepSkyBlue 0x00BFFF DimGray 0x DodgerBlue 0x1E90FF FireBrick 0xB22222 FloralWhite 0xFFFAF0

62 61 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 LightYellow 0xFFFFE0 Lime 0x00FF00 LimeGreen 0x32CD32 Linen 0xFAF0E6 Magenta 0xFF00FF

63 62 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 Purple 0x Red 0xFF0000 RosyBrown 0xBC8F8F RoyalBlue 0x4169E1

64 SaddleBrown Salmon SandyBrown SeaGreen SeaShell Sienna Silver SkyBlue SlateBlue SlateGray Snow SpringGreen SteelBlue Tan Teal Thistle Tomato Turquoise Violet Wheat White WhiteSmoke Yellow YellowGreen 0x8B4513 0xFA8072 0xF4A460 0x2E8B57 0xFFF5EE 0xA0522D 0xC0C0C0 0x87CEEB 0x6A5ACD 0x xFFFAFA 0x00FF7F 0x4682B4 0xD2B48C 0x xD8BFD8 0xFF6347 0x40E0D0 0xEE82EE 0xF5DEB3 0xFFFFFF 0xF5F5F5 0xFFFF00 0x9ACD 预置模板详情 普通转码模板 模板 ID 模板名 中文名 容器视频码率音频码率分辨率格式 (Kbps) (Kbps) - 宽 S MP4-120p MP4 120p MP

65 S M-MP4-LD 270p 手机 MP4 流畅 MP S MP4-LD 360p MP4 流畅 MP H MP4 H265 流畅 36 MP4 H265 0p 流畅 MP S MP4-SD 540p MP4 标清 MP H MP4 H265 标清 54 MP4 H265 0p 标清 MP S MP4-HD 720p MP4 高清 MP H MP4 H265 高清 72 MP4 H265 0p 高清 MP S MP4-FHD 1080p MP4 超清 MP H MP4 H265 超清 10 MP4 H265 80p 超清 MP S MP4 H264 2K 144 MP4 H264 0p 2K MP H MP4 H265 2K 144 MP4 H265 0p 2K MP S FLV-LD 360p FLV 流畅 FLV S FLV -SD 540p FLV 标清 FLV S FLV -HD 720p FLV 高清 FLV S FLV -FHD 1080p FLV 超清 FLV S FLV H264 2K 144 FLV H p K FLV S MP3-64 MP3-64 MP S m3u8-ld 360p m3u8 h264 流畅 m3u S m3u8-sd 540p m3u8 h264 标清 m3u S m3u8-hd 720p m3u8 h264 高清 m3u S m3u8-fhd 1080p m3u8 h264 超清 m3u 感知增强高清模板 模板 ID 模板名中文名 容器 格式 视频码率 (Kbps) 音频码率 (Kbps) 分辨率 - 宽 64

66 D 感知增强 M P4 h264 2K 1440p 感知增强 MP4 h2 64 2K MP D 感知增强 M P4 h264 超清 1080p 感知增强 MP4 h2 64 超清 MP D 感知增强 M P4 h264 高清 720p 感知增强 MP4 h2 64 高清 MP D 感知增强 m p4 h264 标清 540p 感知增强 mp4 h2 64 标清 MP D 感知增强 m p4 h264 流畅 320p 感知增强 mp4 h2 64 流畅 MP D 感知增强 FL V h264 2K 1440p 感知增强 FLV h26 4 2K FLV D 感知增强 FL V h264 超清 1080p 感知增强 FLV h26 4 超清 FLV D 感知增强 FL V h264 高清 720p 感知增强 FLV h26 4 高清 FLV D 感知增强 flv h264 标清 540p 感知增强 flv h264 标清 FLV D 感知增强 flv h264 流畅 360p 感知增强 flv h264 流畅 FLV 低转高模板 视频码音频码容器分辨模板 ID 模板名中文名率 (K 率 (K 格式率 - 宽 bps) bps) LTH 标清转高清 720p LowToHigh-SD_HD mp

67 LTH K 转 4K 2160p LowToHigh-2K-4K mp LTH001-F6027 转 60 帧率 720p LowToHigh-60Fps mp LTH001-F12027 转 120 帧率 720p LowToHigh-120Fps mp 音视频抽离模板 模板 ID 模板名中文名 容器 格式 视频码 率 (Kb ps) 音频码 率 (Kb ps) 分辨率 - 宽 VS 视音频抽离 - 视频视音频抽离 - 视频 mp AS 视音频抽离 - 音频视音频抽离 - 音频 mp 状态码 代码 描述 说明 0 Success 操作成功 1 Failure 执行失败 Inner Error 系统内部错误 Input Parameter Invali 输入参数不正确 d file does not found 文件无法访问 no access 没有权限 其它错误 未知错误 66