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

Size: px

Start display at page:

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

骏郜
5 years ago
Views:

1 视频云普通转码 API 使用手册 (V0.11) 时间 :2017 年 11 月北京新奥特云视科技有限公司

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

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

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

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

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

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

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("+",

9 "%20").replace("*", "%2A").replace("%7E", "~") 公共参数属性含义类型说明必填 timestamp 时间戳 long 北京时间 1970 年 01 月 01 日 08 时 00 是分 00 秒起至现在的总秒数地址示例第一部分 timestamp= 第二部分第一部分是具体接口服务的接口地址, 由接口服务根据一定规则 ( 按照不同功能进行命名上的区分 ) 自定义, 第二部分为公共参数, 是每个接口调用的必填项 1.3 返回结果 "code": 0, # 状态码, 参照附录 "message": "success", # 描述信息 "data": "requestid": " F38-4W33-BER5-D CA58" # 结果数据第 2 章转码服务相关接口转码服务可以支持不同格式的视音频转码, 支持一入多出模板方式等快捷的转码

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

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

12 "57e36e01e f3d33caa" ] ] 调用示例请求示例 : 域名 ]/transcodetask/create?input="fileurl":" utbucket=bucketname&callbackurl= mplateid":"s ","watermarks":["inputfile":"fileurl":"","waterm arktemplateid":"88c6ca184c0e47098a5b665e2a126797"]]&< 公共参数 > 返回示例 : "code": 0, "message": "success", "data": "transcodetasklist": [ "id": "57e36e01e f3d33caa", "input": "fileurl": " "outputs": outputfilelist : [ "outputfilelist": [ "outputfile": null, "templateid": "57e36e01e f3d33caa", "watermarklist": [ "inputfile":

13 "fileurl": " "watermarktemplateid": "57e36e01e f3d33caa" ] ] ], "state": "Submitted", "sode": "", "message": "", "percent": 0, "userdata": "asf", "createtime": " T12:00:00Z", "messageresult": null ] 2.2 取消转码任务功能描述根据任务 id 取消已经已提交的转码任务, 如果已经开始转码则会失败请求参数参数含义格式说明必填 transcodetas kid 任务 id 是返回参数参数含义格式说明 transcodetaskid 转码任务 Id 取消转码任务 id

14 2.2.4 调用示例请求示例 : 域名 ]/transcodetask/cancel?transcodetaskid=57e36e01e f3d33caa&< 公共参数 > 返回示例 : "code": 0, "message": "", "data": "requestid": " F38-4W33-BER5-D CA58", "transcodetaskid": "57e36e01e f3d33caa" 2.3 查询转码任务功能描述根据任务 id 查询转码任务详情请求参数参数含义格式说明必填 transcodetas kids 任务 id 转码任务 ID 列表, 逗号分隔, 一次最多 10 个是

15 2.3.3 返回参数参数格式说明 transcodetasklist TranscodeTask[] 查询到的转码任务列表 nonexisttranscodetaski ds [] 不存在的转码作业 ID 列表, 无数据时该结构不返回调用示例请求示例 : POST 域名 ]/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": "

16 "watermarktemplateid": "57e36e01e f3d33caa" ] ] ], "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 表示转码中, TranscodeSuccess 表示转码成功, TranscodeFail 表示转码失败, TranscodeCancelled 表示转码取消, 默认是 All

17 startofjobcreated Time endofjobcreatedti me 转码任务创建时间开始时间点转码任务创建时间结束时间点返回参数参数格式说明 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": "

18 "outputs": outputfilelist :[ "outputfilelist": [ "outputfile": null, "templateid": "57e36e01e f3d33caa", "watermarklist": [ "inputfile": "fileurl": " "watermarktemplateid": "57e36e01e f3d33caa" ] ] ], "state": "Submitted", "code": "", "message": "", "percent": 0, "userdata": "asf", "createtime": " T12:00:00Z", "messageresult": null ]

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

20 返回示例 : "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 个是

21 3.2.3 返回参数参数格式说明 templatelist TranscodeTemplate[] 模板列表 nonexisttemplate Ids [] 不存在模版 ID, 当查询参数中有不存在的模板 id 时在该字段返回, 无数据时该结构不返回调用示例请求示例 : 域名 ]/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" ]

22 第 4 章水印相关接口 4.1 创建水印功能描述创建水印模板请求参数参数格式说明必填 name 模板名称, 最大长度 128 字节是 config 水印模板配置,JSON 对象, 参考附录 - 参数详情水印模版配置详情, 例如 : "width": "10", "height": "30", "dx": "10", "dy": "5", "referpos": "TopRight", "type": "Image", "timeline": "start": "0", "duration": "10" 是返回参数参数格式说明 watermarktemplate WarterMarkTemplate 模板

23 4.1.4 调用示例请求示例 : 域名 ]/transcodewartermark/create?name=wartermarktemplate1&config="widt h":"100","height":"50","dx":"100","dy":"100","referpos":"topright","type":"imag e","state":"normal"&< 公共参数 > 返回示例 : "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.2 水印更新功能描述更新已创建的水印模板

24 4.2.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 e321c40&name=warterMarkTemplate1&config="width":"100","height":"50", "dx":"100","dy":"100","referpos":"topright","type":"image","state":"normal"&< 公共参数 > 返回示例 :

25 "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 个, 逗号分隔是返回参数参数格式说明 Templat 查询到的模板列表 watermarktemplatelist e[] nonexistwatermarktemplateids [] 不存在的水印模板列表, 无数据时该结构不返回

26 4.3.4 调用示例请求示例 : 域名 ]/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 水印列表功能描述获取创建的水印列表

27 4.4.2 请求参数参数格式说明必填 currentpage 当前页, 默认是 1 pagesize 页大小,1-100 的数, 默认是 10 state 水印模板状态 :All 表示所有,Normal 表示正常,Deleted 表示已删除的, 默认是 All 返回参数参数格式说明 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",

28 "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 删除水印模板功能描述将水印模板删除请求参数参数含义格式说明必填 watermarkte mplateid 水印模板 id 需要删除的水印模板 id 是返回参数参数格式说明 watermarktemplateid 删除成功的水印模板 id

29 4.5.4 调用示例请求示例 : 域名 ]/transcodewartermark/delete?watermarktemplateid=582d8806e e321c40&< 公共参数 > 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "watermarktemplateid": "88c6ca184c0e47098a5b665e2a126799" 第 5 章存储库设置接口 5.1 设置存储库功能描述创建转码任务前需要先在云平台中申请私有的对象存储服务, 用于存放转码完成后的音视频资源需要通过此接口设置相应的输出媒体 Bucket 只有该 bucket 上传权限的 AK(Access Key ID) 和 SK(Secret Access Key) 请求参数参数格式说明必填 name 自定义存储库名称, 最大长度 128 字节是 config 存储库配置,JSON 对象, 参考附录 - 参数详情存储是

30 库配置详情, 例如 : "endpoint": "cn-north-1", "bucket": "bucketname", "AK": "IPNUAIMO1FH24TWUBX", "SK": "U6VIJHEyPHRPJqlRoDALBwG4ZpqxMlhs0H" 注 :bucket 唯一标识一个存储, 可以根据 bucket 进行新增或修改调用示例请求示例 : 域名 ]/bucket/setbucket?name=mybucket&config="endpoint":"cn-north-1","buc ket":"bucketname", AK : 23asd, SK : sadfa &< 公共参数 > 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58"

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

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

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

34 6.2.3 返回参数参数格式说明 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: ], "state": "Submitted", "code": "", "message": "", "percent": 0, "userdata": "asf",

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

36 参数格式说明 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", "height": "100"

37 7.1.5 调用示例请求示例 : 域名 ]/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", "sode": "", "message": "", "percent": 0, "userdata": "asf", "createtime": " T12:00:00Z", "messageresult": null

38 7.2 查询媒体信息任务功能描述根据媒体信息任务 ID 查询媒体信息任务详情请求参数参数格式说明必填 mediainfoids 媒体信息任务 ID, 当查询多个媒体信息时使用英文逗号分隔, 一次最多查询 10 个是返回参数参数格式说明 mediainfotasklist MediaInfoTask[] 查询到的媒体信息任务列表 nonexistmediainfotaski ds [] 不存在的媒体信息任务 ID 列表, 无数据时该结构不返回调用示例请求示例 : 域名 ]/mediainfo/query?mediainfoids=582d8806e e321c40&< 公共参数 > 返回示例 : "code": 0, "message": "success", "data": "requestid": " F38-4W33-BER5-D CA58", "mediainfotasklist": [

39 ] "id": "57e36e01e f3d33caa", "input": "fileurl": " "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" 第 8 章附录 8.1 数据类型 File 描述文件文件地址是 fileurl 或 (bucket+endpoint+objectkey), 如果都有值以 fileurl 为主名称格式说明必填 fileurl 文件网络访问地址, 必须是对象存储访问地址

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

41 8.1.5 WarterMark 描述水印名称格式说明必填 inputfile File 水印输入文件是 watermarktemplateid 水印模版 ID WaterMarkTemplate 描述水印模版名称格式说明必填 id 水印模版 ID 是 name 水印模版名称是 width Number 宽,[8,4096], 单位 px height Number 高,[8,4096], 单位 px dx Number 水平偏移量,[-4096,4096], 单位 px dy Number 垂直偏移量,[-4096,4096], 单位 px referpos 水印的位置,TopRight TopLeft BottomRight BottomLeft type 水印类型,Image Text, 目前仅支持 Image 是 state 水印模板的状态,Normal Deleted 是

42 8.1.7 TranscodeTask 描述转码任务名称格式说明必填 id 转码任务 ID 是 input TranscodeIn putfile 转码任务输入是 outputs TranscodeO utput 转码任务输出信息是 state 作业状态 :Submitted 表示作业已提交,Transcoding 表示转码中, TranscodeSuccess 表示转码成功, 是 TranscodeFail 表示转码失败, TranscodeCancelled 表示转码取消 code 转码失败时的错误码 message 转码失败时的消息 percent 转码进度 [0,100] userdata 用户自定义数据 createtime 创建转码任务时间 taskconsumetime 任务消耗毫秒数, 任务成功则有该字段 taskendtime 转码任务结束时间 messageresult MessageRes ult 回调结果 MessageResult 描述回调通知结果名称格式说明必填 errorcode 失败时错误码是 errormessage 失败时错误信息是 messageid 回调消息 ID 是

43 messagecontent 回调内容是 TranscodeTemplate 名称格式说明必填 id 转码模版 id 是 name 转码模版名称是 templatecontent TranscodeTe 参考附录 - 数据类型 mplateconte -TranscodeTemplateContent nt 是 state Normal 表示正常,Deleted 表示已删除是 TranscodeTemplateContent 名称格式说明必填 video Video 视频信息 audio Audio 音频信息 container Container 打包信息 Video 名称格式说明必填 vcodec 视频编码格式 vbitrate 视频码率 fps 视频帧率 gop 图像组 width 图像宽 height 图像高 aspect 图像比例 pixelformat 图像格式 vprofile 视频概述

44 vlevel 视频级别 Audio 名称格式说明必填 acodec 音频编码格式 abitrate 音频码率 channel 音频声道 samplerate 采样率 Container 名称格式说明必填 format 打包格式 extrainfo 附加信息 ctype ( 清晰度 ) 如 : 视频 :ori( 原视频 ) shd hd sd ld, 图片 :poster ( 海报 ) thumbnail( 缩略图 ) ttype ( 终端类型 ) 如 :pc mb ott weight ( 收录权重 ) 如 :1280 的视频填 100;480 填 50;480 以下填 SnapshotPic 名称格式说明必填 outputfile File 截图文件是 pointtime 时间点, 毫秒数

45 SnapshotTask 名称格式说明必填 id 截图任务 ID 是 input File 截图任务输入是 snapshotpiclist SnapshotPic[ ] 截图任务输出图片列表 state 截图状态 :Submitted 表示作业已提交,Snapshoting 表示截图中, SnapshotSuccess 表示截图成功, 是 SnapshotFail 表示截图失败, SnapshotCancelled 表示截图取消 code 截图失败时的错误码 message 截图失败时的消息 percent 截图进度 [0,100] userdata 用户自定义数据 createtime 创建截图任务时间 messageresult MessageRes ult 回调结果 MediaInfoTask 名称格式说明必填 id 媒体信息任务 ID 是 input File 媒体信息任务输入是 mediainfo MediaInfo 文件媒体信息 state 媒体信息状态 :Submitted 表示已提交,Analyzing 表示正在分析是 Success 表示成功 Fail 表示失败 code 媒体信息失败时的错误码 message 媒体信息失败时的消息 percent 媒体信息进度 [0,100] userdata 用户自定义数据

46 createtime 创建媒体信息任务时间 MediaInfo 名称格式说明必填 general MediaInfoG eneral 文件基本信息 video MediaInfoVi deo 文件视频信息, 当存在视频信息时存在 audio MediaInfoA udio 文件音频信息, 当存在音频信息时存在 pic MediaInfoPi c 文件图片信息, 当存在图片信息时存在 MediaInfoGeneral 名称格式说明必填 format 文件格式 size 文件大小 MediaInfoVideo 名称格式说明必填 format 文件格式 size 文件大小 duration 时长 width 宽 height 高 MediaInfoAudio 名称格式说明必填

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

48 同一路输出最多支持 4 个水印, 示例 : [ "inputfile": fileurl :, "watermarktemplateid":"88c6ca1 84c0e47098a5b665e2a126797" ] userdata 用户自定义数据, 最大长度 1024 个字节 JSON 对象, 字幕配置, 请参照附录 -SubtitleConfig 详情, 示例 : ExtSubtitleList :[ Input : subtitleconfig Bucket : example-bucket, Location : oss-cn-hangzhou, Object : example.srt, CharEnc : UTF-8 ] 如设置则覆盖指定转码模版中的对 container 应参数, 参考附录 - 参数说明 -Container 详情 JSON 对象, 视频配置, 如设置则覆 video 盖指定转码模版中的对应参数, 请参照附录 - 参数说明 -Video 详情 JSON 对象, 音频配置, 如设置则覆 audio 盖指定转码模版中的对应参数, 请参照附录 - 参数说明 -Audio 详情 ObjectKey 转码完成后存入改对象, outputobject 不填写默认生成一个 32 位 uuid+. 文件格式

49 8.2.3 转码水印参数详情名称格式说明必填 watermarktemplateid 水印模版 ID inputfile 水印输入文件, 见输入详情, 目前支持 png jpg jpeg bmp 是文件作为输入 width Number 若设置, 则此值覆盖水印模板对应水印图片宽, 值有两种形式 : 整数型代水印图片宽的像素值, 范围 [8,4096], 单位 px; 小数型代表相对输出视频分辨率宽的比率, 范围 (0,1], 支持 4 位小数, 如 , 超出部分系统自动丢弃 height Number 若设置, 则此值覆盖水印模板对应水印图片高, 值有两种形式 : 整数型代表水印图片高的像素值, 范围 [8,4096], 单位 px; 小数型代表相对输出视频分辨率高的比率, 范围 (0,1], 支持 4 位小数, 如 , 超出部分系统自动丢弃 dx Number 若设置, 则此值覆盖水印模板对应参数, 水印图片相对输出视频的水平偏移量, 默认值是 0; 值有两种形式 : 整数型代表偏移像素, 范围 [0,4096], 单位 px; 小数型代表水平偏移量与输出分辨率宽的比率, 范围 (0,1), 支持 4 位小数, 如 , 超出部分系统自动丢弃 dy Number 若设置, 则此值覆盖水印模板对应参数, 水印图片相对输出视频的垂直偏移量, 默认值是 0; 值有两种形式 : 整数型代表偏移像素, 范围 [0,4096], 单位 px; 小数型代表垂直偏移量与输出分辨率高的比率, 范围 (0,1), 支持 4 位小数, 如 , 超出部分系统自动丢弃 referpos 若设置, 则此值覆盖水印模板对应参

50 数, 水印的位置, 值范围 TopRight TopLeft BottomRight BottomLeft 若设置, 则此值覆盖水印模板对应参数, 水印类型,Image Text, 默认 type 为 Image,Image: 图片水印,Text: 文字水印, 若填写 Text, 则必须填写 textwatermark 字段 timeline 若设置, 则此值覆盖水印模板对应参数, 动态水印, 见 Timeline 详情 JSON 对象, 文字水印配置, 若类型为文字水印, 则此配置项不能为空, textwatermark 详见文字水印参数详情, 示例 : content : 5rWL6K+V5paH5a2X5rC05Y2w, Top :2, Left : 输入详情文件地址是 fileurl 或 (bucket+endpoint+objectkey), 如果都有值以 fileurl 为主名称格式说明必填 fileurl 文件网络访问地址 bucket 桶名称 objectkey 对象名称 endpoint 域名文字水印参数详情名称格式说明必填文字水印内容, 内容需做 Base64 编 content 码, 示例 : 若想添加文字水印测试文字水印, 那么 content 的值为 : 是 5rWL6K+V5paH5a2X5rC05Y2w

51 fontname 默认 SimSun fontsize Int 字体大小, 默认 16, 范围 :(4, 120) fontcolor 字体颜色 fontalpha Int 字体透明度, 范围 :(0, 1], 默认 1.0 top Int 文本上边距, 默认 0, 范围 :[0,] left Int 文本左边距, 默认 0, 范围 :[0,] borderwidth Int 描边宽度, 默认 0, 范围 :[0,] bordercolor 描边颜色, 默认 :Black, 取值 BorderColor 水印模版配置详情名称格式说明必填若设置, 则此值覆盖水印模板对应水印图片宽, 值有两种形式 : 整数型代水印图片宽的像素值, 范围 width Number [8,4096], 单位 px; 小数型代表相对输出视频分辨率宽的比率, 范围 (0,1], 支持 4 位小数, 如 , 超出部分系统自动丢弃若设置, 则此值覆盖水印模板对应水印图片高, 值有两种形式 : 整数型代表水印图片高的像素值, 范围 height Number [8,4096], 单位 px; 小数型代表相对输出视频分辨率高的比率, 范围 (0,1], 支持 4 位小数, 如 , 超出部分系统自动丢弃若设置, 则此值覆盖水印模板对应参数, 水印图片相对输出视频的水平偏移量, 默认值是 0; 值有两种形式 : dx Number 整数型代表偏移像素, 范围 [0,4096], 单位 px; 小数型代表水平偏移量与输出分辨率宽的比率, 范围 (0,1), 支持 4 位小数, 如 , 超出部分系统自动丢弃 dy Number 若设置, 则此值覆盖水印模板对应参数, 水印图片相对输出视频的垂直偏

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

53 fileurl : ] ExtSubtitle 详情名称格式说明必填 JSON 对象, 外部输入字幕文件, 目前支持 srt ass 格式, 参考附录 - 输入详情, 示例 : input 是 fileurl : Container 详情名称格式说明必填容器格式, 默认值为 mp4; 视频转码支持 flv mp4 ts m3u8 gif; 音频转码支持 mp3 mp4 ogg format flac; 容器格式为 gif 时,video vcodec 设置只能设置为 GIF; 容器格式为 flv 时,video vcodec 不能设置为 H.265 suffix 文件后缀, 不设置则使用 format 作为后缀 Video 详情名称格式说明必填 vcodec 视频编码格式

54 width 图像宽 height 图像高 aspect 图像比例 Audio 详情名称格式说明必填 acodec 音频编码格式 channel 音频声道存储配置详情名称格式说明必填 endpoint 域名地址, 如 obs.myhwclouds.com 是 bucket 存储桶名称是 AK AK( 接入键标识,Access Key ID) 是 SK SK( 安全接入键,Secret Access Key) 是 SnapshotConfig 详情名称格式说明必填 outputbucket 截图文件存储的 bucket 是截图时间, 单位毫秒, 若指定该参数表示根据时间点截图, 若截取多个时 time 间点图片则用英文半角逗号隔开, 例如 1000,2000 表示截取第 1 秒和第 2 秒的图片, 如有该值则优先生效截图间隔时间, 单位秒, 若指定则表 interval 示定时截图,interval 必须大于 0, 优先于 num 参数生效 num 截图数量, 若指定则表示定量截图, 且必须大于 0, 当 time interval

55 num 都没有值时使用首帧截图 width 截图输出图片宽度, 单位 px, 范围 [8,4096], 默认 200, 只支持整数 height 截图输出图片高度, 单位 px, 范围 [8,4096], 默认 120, 只支持整数 8.3 状态码代码描述说明 0 Success 操作成功 1 Failure 执行失败 Inner Error 系统内部错误 Input Parameter Invalid 输入参数不正确 file does not found 文件无法访问 no access 没有权限其它错误未知错误

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

江苏台荔枝云总体技术方案V1.0 音视频转码 API 使用手册 (V0.11) 时间 :2017 年 11 月北京新奥特云视科技有限公司修订历史版本修订说明修订日期修订人审核时间审核人 V0.09 新建文档 2017/12/14 冉宏陈 V0.10 修改文档 2017/12/15 张春祯 V0.11 修改文档 2017/12/15 冉宏陈目录第 1 章调用说明... 9 1.1 概述... 9 1.2 请求结构说明...