添加点播抽帧接口

范晓春
1 parent 2bca50c8
Showing 2 changed files with 84 additions and 2 deletions
01.点播云/3.2 点播转码接口.md
01.点播云/3.3 点播抽帧接口.md
@@ -23,7 +23,7 @@
 | plat | int | false   | 转码平台,根据当前业务所应用的存储平台对应, 0:金山;1:七牛 默认为0|  
 | path| string | true   | 源文件的相对路径 格式：/{bucket}/{object_name} |
 | dstBucket| string | false   | 转码存储bucket,默认同源视频同bucket |
-| dstDir| string | true   | 输出文件key的路径、不允许以/开头 注:type=avsample 时 系统会在最后面加一级目录 目录名长度32位。|
+| dstDir| string | true   | 输出文件key的路径、不允许以/开头 |
 | type| string | true   | 转码类型，针对该视频转码固定取值,type:avop|
 | rates| string | false   | 码率集合、单位K，多个码率以逗号分隔。根据该参数返回指定的码率视频信息。取值范围:(流畅:400;标清:800;高清:1500;超清:3000)|
 | attach| json | false   | type相关附带参数 非必填 格式:json|
@@ -41,7 +41,7 @@
 -----
-#### attach(转码加水印任务必填)参数说明:
+#### extParam参数说明:
 | 参数名 | 参数类型 | 必选 | 参数说明 |  
 | :----------- | :------: | :------: | :------: |  
+### 点播视频抽帧URL接口
+-----
+#### URL: http://transcode.cnlive.com/api/request
+-----
+#### 接口说明: 针对视讯云平台上传内容的视频抽帧服务
+-----
+#### 请求方式: HTTP POST  
+-----
+#### 返回格式: JSON
+-----
+#### 请求参数说明:  
+| 参数名 | 参数类型 | 必选 | 参数说明 |  
+| :----------- | :------: | :------: | :------: |  
+| appId | string | true   | 应用ID   |  
+| params| json | true   | 请求json数据 |
+|sign| String | true | 签名规则见 [签名详情] (http://help.open.cnlive.com/common.html)  |
+
+-----
+
+#### params参数说明:
+| 参数名 | 参数类型 | 必选 | 参数说明 |  
+| :----------- | :------: | :------: | :------: |  
+| plat | int | false   | 转码平台,根据当前业务所应用的存储平台对应, 0:金山;1:七牛 默认为0|  
+| path| string | true   | 源文件的相对路径 格式：/{bucket}/{object_name} |
+| dstBucket| string | false   | 转码存储bucket,默认同源视频同bucket |
+| dstDir| string | true   | 输出文件key的路径、不允许以/开头  系统会在最后面加一级目录 目录名长度32位。|
+| type| string | true   | 转码类型，针对该视频转码固定取值,type:avsample|
+| attach| json | false   | type相关附带参数 非必填 格式:json|
+| cbUrl| string | true   | 回调用户地址,回调请求采用post body形式|
+
+-----
+
+#### attach参数说明:
+
+| 参数名 | 参数类型 | 必选 | 参数说明 |  
+| :----------- | :------: | :------: | :------: |  
+| width | int | false   | 如果只指定任一，会按指定到值按原比例缩放| 
+| height | int | false   | 如果只指定任一，会按指定到值按原比例缩放| 
+| interval | int | false   | 	间隔 单位s 不填采用自动算法进行抽帧，保证8张|
+| num | int | false   |  抽帧图片张数,默认为8|
+| strategy | int | false   | 	是否从头抽到尾（1：是，优先级大于num） 默认非1
+|
+-----
+
+#### extParam参数说明:
+
+| 参数名 | 参数类型 | 必选 | 参数说明 |  
+| :----------- | :------: | :------: | :------: |  
+| domain | string | false   | 音视频源文件外链域名，plat=1时必填|
+
+-----
+
+#### 请求示例:
+```
+{
+    "appId":"82_XXX",
+    "params":{
+	    "plat":1,
+	    "dstBucket":"mam-ffyl-223",
+	    "path":"/mam-ffyl-223/223/raw/2018/0104/223_53274c16c9504dc18c1aa2d04dc50783.mpg",
+	    "dstDir":"223/img/2018/0104",
+	    "cbUrl":"XXXX",
+	    "type":"avsample",
+	    "attach":{
+	        interval:8
+	    }
+	    "extParam":{
+	        "domain":"http://ffyl.vods2.cnlive.com"
+	    }
+    }
+}
+```
+-----
+
+#### 请求任务返回数据结构:
+```
+{
+ code:0, //状态码 0：成功 1：失败
+ desc:"success",
+ taskId:"07e589adf3da4512acaf7864a388e8f6"
+}
+```
 \ No newline at end of file