处理设置接口
更新时间:2024-08-30
创建工作流
工作流创建接口参数较多,通过api创建难度较大,建议通过console进行创建。
查询工作流详情
按照工作流id(workfolwId)查询工作流详情
请求语法
GET /v2/workflows/{workflowId} HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>
请求头域
无特殊请求头域。
请求参数
参数 | 位置 | 描述 | 是否必须 |
---|---|---|---|
presetName | path | 模板名称 | 是 |
请求示例
GET /v2/workflows/ehwty5yu7pn7nxqc7rde HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9
响应头域
无特殊响应头域。
响应参数
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
name | string | true | 工作流名称 | |
description | string | true | 工作流描述 | |
dag | object | true | 工作流Dag描述信息 | 参考控制台返回 |
响应示例
GET /v2/workflows/ehwty5yu7pn7nxqc7rde HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8
{
"name": "zm_slt_hb",
"dag": {
"nodes": {
"输入": {
"nodeId": "ehwt9eyge3p3vq19xihg",
"name": "输入",
"nodeConfig": {
"input": "{}"
},
"type": "START"
},
"转码": {
"nodeId": "ehwtjx45wftjhq4eqqf6",
"name": "转码",
"nodeConfig": {
"input": "{\"adjustOrientation\":\"ALL\",\"job\":{\"target\":{\"presetName\":\"vod.video_hls_h264_360p\",\"crop\":null,\"delogoArea\":null,\"watermarkIds\":[]}},\"needDetectBlackBoard\":false}"
},
"type": "TRANSCODING"
},
"发布": {
"nodeId": "ehwt5dhue4m8fzx8b312",
"name": "发布",
"nodeConfig": {
"input": "{}"
},
"type": "PUBLISH"
},
"缩略图": {
"nodeId": "ehwttwiu8p6eyas1e7aj",
"name": "缩略图",
"nodeConfig": {
"input": "{\"job\":{\"presetName\":\"vod.thumbnail_cover\"}}"
},
"type": "THUMBNAIL"
},
"黑边检测": {
"nodeId": "ehwtqxdek02byu6c5t9w",
"name": "黑边检测",
"nodeConfig": {
"input": "{}"
},
"type": "BLACK_BORDER_DETECT"
}
},
"dependencies": {
"输入": [
"转码",
"缩略图",
"黑边检测"
],
"发布": [],
"转码": [
"发布"
],
"缩略图": [
"发布"
],
"黑边检测": [
"发布"
]
}
},
"description": "description"
}
工作流分页接口
对用户以及系统工作流进行分页展示
请求语法
GET /v2/workflows?pageNo={pageNo}&pageSize={pageSize}&nameHTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>
请求头域
无特殊请求头域。
请求参数
名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|---|
pageNo | query | int | 否 | 页面编号 | 页面编号默认1 |
pageSize | query | int | 否 | 页面大小 | 页面大小默认10 |
name | query | string | 否 | 工作流名称 | 模糊查询 |
type | query | string | 否 | 工作流类型 | 工作流类型,USER,SYSTEM |
beginTime | query | string | 否 | 创建时间 | 创建时间下限 |
endTime | query | string | 否 | 创建时间 | 创建时间上限 |
请求示例
GET /v2/workflows?pageNo=1&pageSize=2 HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9
响应头域
无特殊响应头域。
响应参数
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
data | [object] | true | |||
+ name | string | true | 工作流名称 | ||
+ node | [string] | true | 工作流节点集合list | ||
+ status | string | true | 工作流状态 | READY,RUNNING,STOP | |
+ workflowId | string | true | 工作流id | ||
pageNo | int | true | 页面编号 | ||
pageSize | int | true | 页面大小 | ||
totalCount | int | true | 总数 |
响应示例
HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8
{
"data": [
{
"workflowId": "ehwty5yu7pn7nxqc7rde",
"name": "zm_slt_hb",
"node": [
"PUBLISH",
"START",
"TRANSCODING",
"THUMBNAIL",
"BLACK_BORDER_DETECT"
],
"createTime": "2024-08-21T09:44:07Z",
"type": "USER"
},
{
"workflowId": "ehwkcu5mj0nvhkk4khxn",
"name": "watertmp",
"node": [
"PUBLISH",
"START",
"TRANSCODING"
],
"createTime": "2024-08-21T02:34:23Z",
"type": "USER"
}
],
"pageNo": 1,
"pageSize": 2,
"totalCount": 46
}
修改工作流
修改工作流参数较多,通过接口操作难度较大,建议通过console进行操作。
复制工作流
若创建工作流后,对同类型工作流还有需求,可调用此接口复制一个全新工作流进行使用
请求语法
POST /v2/workflows/copy HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>
请求头域
无特殊请求头域。
请求参数
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
workflowId | string | 是 | 工作流id | 要被复制的工作流id |
name | string | 是 | 工作流名称 | 复制后工作流名称 |
请求示例
POST /v2/workflows/copy HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9
{
"workflowId": "nksndkjjfo",
"name": "新工作流名称"
}
响应头域
无特殊响应头域。
响应参数
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
name | string | true | 新工作流名称 | |
workflowId | string | true | 新工作流id |
响应示例
HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8
{
"workflowId": "sdfljlfsuijoj",
"name": "新工作流名称"
}
删除工作流
按照工作流id删除工作流,注意:无法删除系统模板
请求语法
POST /v2/workflows/delete HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>
请求头域
无特殊请求头域。
请求参数
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
workflowId | string | 是 | 工作流id | 必需 |
请求示例
POST /v2/workflows/delete HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9
{
"workflowId": "skdjfksd"
}
响应头域
无特殊响应头域。
响应参数
无
响应示例
HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8
创建模板
转码模板参数较多,通过api创建难度较大,建议通过console进行创建,模板分为转码模板、水印模板、抽帧模板、智能审核模板、智能分析模板。
查询模板详情
按照模板名称查询模板详情
请求语法
GET /v2/presets/{presetName} HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>
请求头域
无特殊请求头域。
请求参数
参数 | 位置 | 描述 | 是否必须 |
---|---|---|---|
presetName | path | 模板名称 | 是 |
请求示例
GET /v2/presets/vod.video_dash HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9
响应头域
无特殊响应头域。
响应参数
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
appId | string | False | 当前模板所属app | |
vodPresetName | string | true | VOD模板名 | |
description | string | false | 描述信息 | |
serviceType | string | true | 外部模板类型(枚举): TRANSCODING("转码"), ADAPTIVE_TRANSCODING("自适应码流转码"), THUMBNAIL("缩略图"), DEFECT_DETECT("质检"), WATERMARK("水印"), DIGITAL_WATERMARK("数字水印"), DIGITAL_WATERMARK_SECRET("数字水印加密"), ANALYSIS("视频分析"), REGULATION("视频审核"); |
|
type | string | true | 模板类型(枚举):SYSTEM,USER | |
status | string | true | 当前可用状态(枚举):INACITVE,ACITVE | |
serviceConfig | PresetServiceConfig | false | 外部模板的详细配置信息,例如MCP转码模板。 MCP转码模板参考https://cloud.baidu.com/doc/MCT/s/Sjwvz5hey MCP抽帧模板参考https://cloud.baidu.com/doc/MCT/s/tkb8t1775 MCP明水印模板https://cloud.baidu.com/doc/MCT/s/Sjwvz5isl MCP质检模板https://cloud.baidu.com/doc/MCT/s/vkwuoloam MCP视频数字水印模板https://cloud.baidu.com/doc/MCT/s/olpm8u4ba MCP数字水印密钥模板https://cloud.baidu.com/doc/MCT/s/Qlpmdbmip 【注意】: 【1】对于任意外部模板,description 字段将被忽略,请使用最外层的description字段。 【2】对于水印模板,bucket、key将被忽略,取而代之的是最外层的uploadKey字段,具体查看uplaodKey说明。 【3】对于水印模板,水印id(即watermarkId)字段不支持用户自定义,只能由服务端自动生成。 【4】对于需要水印id的模板,包括转码模板,watermarks字段下的水印id请使用已存在模板的serviceConfig中的水印id(可以参考对应的水印模板文档获取到),而不是vodPresetName。 |
|
serviceExtraConfig | PresetServiceExtraConfig | false | ||
+ transcodingConfig | object | false | ||
++ container | string | false | 容器格式:mp4, flv, hls, mp3, m4a, a-hls, pcm, dash, ts |
响应示例
HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8
{
"appId": "system",
"vodPresetName": "vod.video_dash",
"description": "dash自适应码流转码",
"serviceConfig": {
"container": "dash",
"segmentDurationInSecond": 5,
"segmentUrlDisplay": "useSingleFile"
},
"serviceExtraConfig": {},
"serviceType": "ADAPTIVE_TRANSCODING",
"type": "SYSTEM",
"status": "ACTIVE",
"createTime": "2024-08-17T10:42:21Z",
"updateTime": "2024-08-17T10:42:21Z"
}
模板分页接口
对用户指定的任务进行重试
请求语法
GET /v2/presets?pageNo={pageNo}&pageSize={pageSize}&type={type}HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>
请求头域
无特殊请求头域。
请求参数
名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|---|
pageNo | query | int | 否 | 当前页码 | 当前页码 |
pageSize | query | int | 否 | 每页数量 | |
sortBy | query | string | 否 | 排序字段 | 取值:CREATE_TIME,TYPE,STATUS,UPDATE_TIME;取值前加上减号则代表逆序。多个字段之间用逗号隔开 |
vodPresetName | query | string | 否 | 模板名称 | 模糊搜索模板名 |
serviceType | query | string | 否 | 模板类型 | 模板类型:TRANSCODING,THUMBNAIL,DEFECT_DETECT,WATERMARK,DIGITAL_WATERMARK,DIGITAL_WATERMARK_SECRET,ANALYSIS,REGULATION |
type | query | string | 否 | 模板来源 | 模板来源类型:SYSTEM表示系统模板,USER表示用户自定义模板 |
请求示例
GET /v2/presets?pageNo=1&pageSize=2&type=SYSTEM HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9
响应头域
无特殊响应头域。
响应参数
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
data | [object] | true | 当前页数据 | ||
+ appId | string | true | 当前模板所属app | ||
+ vodPresetName | string | true | VOD模板名 | ||
+ description | string | false | 描述信息 | ||
+ serviceType | string | true | 外部模板类型(枚举): TRANSCODING("转码"), ADAPTIVE_TRANSCODING("自适应码流转码"), THUMBNAIL("缩略图"), DEFECT_DETECT("质检"), WATERMARK("水印"), DIGITAL_WATERMARK("数字水印"), DIGITAL_WATERMARK_SECRET("数字水印加密"), ANALYSIS("视频分析"), REGULATION("视频审核"); |
||
+ type | string | true | 模板类型(枚举):SYSTEM,USER | ||
+ status | string | true | 当前可用状态(枚举):INACITVE,ACITVE | ||
+ serviceExtraConfig | PresetServiceExtraConfig | false | |||
»+ transcodingConfig | object | false | |||
»»+ container | string | false | 容器格式:mp4, flv, hls, mp3, m4a, a-hls, pcm, dash, ts | ||
+ serviceConfig | PresetServiceConfig | false | |||
pageNo | int | true | 当前页码 | ||
pageSize | int | true | 页面大小 | ||
totalCount | int | true | 总数据量 |
响应示例
HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8
{
"data": [
{
"appId": "system",
"vodPresetName": "vod.video_dash",
"description": "dash自适应码流转码",
"serviceConfig": {
"container": "dash",
"segmentDurationInSecond": 5,
"segmentUrlDisplay": "useSingleFile"
},
"serviceExtraConfig": {},
"serviceType": "ADAPTIVE_TRANSCODING",
"type": "SYSTEM",
"status": "ACTIVE",
"createTime": "2024-08-17T10:42:21Z",
"updateTime": "2024-08-17T10:42:21Z"
},
{
"appId": "system",
"vodPresetName": "vod.video_a-hls",
"description": "a-hls自适应转码",
"serviceConfig": {
"container": "a-hls",
"transmux": false,
"audio": {
"bitRateInBps": 64000,
"codec": "aac"
},
"video": {
"codec": "h264",
"codecOptions": {
"profile": "baseline"
},
"rateControl": "crf",
"crf": 23,
"sizingPolicy": "keep",
"autoAdjustResolution": true
}
},
"serviceExtraConfig": {},
"serviceType": "TRANSCODING",
"type": "SYSTEM",
"status": "ACTIVE",
"createTime": "2024-08-17T10:05:09Z",
"updateTime": "2024-08-17T10:05:09Z"
}
],
"pageNo": 1,
"pageSize": 2,
"totalCount": 31
}
修改模板
按照模板名称修改模板属性,注意无法修改系统模板
请求语法
PUT /v2/presets/{presetName} HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>
请求头域
无特殊请求头域。
请求参数
名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|---|
presetName | path | string | 是 | ||
appId | query | string | 否 | ||
body | body | object | 否 | ||
vodPresetName | body | string | 是 | ||
serviceConfig | body | string | 是 | 模板具体参数。 | |
serviceExtraConfig | body | string | 否 | 额外参数(若有) |
请求示例
PUT /v2/presets/oldName HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9
{
"vodPresetName": "newName",
"serviceConfig": {
"description": "随便描述一下-新修改",
"container": "mp4",
"video": {
"codec": "h264",
"codecOptions": {
"profile": "baseline"
},
"bitRateInBps": 1024000,
"crf": 20,
"maxFrameRate": 30,
"maxWidthInPixel": 4096,
"maxHeightInPixel": 3072,
"sizingPolicy": "keep",
"autoAdjustResolution": true,
"playbackSpeed": 1.5
}
}
}
响应头域
无特殊响应头域。
响应参数
无
响应示例
PUT /v2/presets/oldName HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8
{
"appId": "system",
"vodPresetName": "vod.video_dash",
"description": "dash自适应码流转码",
"serviceConfig": {
"container": "dash",
"segmentDurationInSecond": 5,
"segmentUrlDisplay": "useSingleFile"
},
"serviceExtraConfig": {},
"serviceType": "ADAPTIVE_TRANSCODING",
"type": "SYSTEM",
"status": "ACTIVE",
"createTime": "2024-08-17T10:42:21Z",
"updateTime": "2024-08-17T10:42:21Z"
}
删除模板
按照模板名称查询删除模板,注意:无法删除系统模板;正在被使用的模板也无法被删除,请先删除工作流后再删除模板
请求语法
DELETE /v2/presets/{vodPresetName} HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>
请求头域
无特殊请求头域。
请求参数
参数 | 位置 | 描述 | 是否必须 |
---|---|---|---|
presetName | path | 模板名称 | 是 |
请求示例
DELETE /v2/presets/test HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9
响应头域
无特殊响应头域。
响应参数
无
响应示例
DELETE /v2/presets/test HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8
附录
PresetServiceExtraConfig
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
transcodingConfig | object | false | none | none | |
+ container | string | false | none | 容器格式:mp4, flv, hls, mp3, m4a, a-hls, pcm, dash, ts |
PresetServiceConfig
- 转码类型模板返回字段
字段名称 | 字段类型 | 字段描述 | 取值 |
---|---|---|---|
container | string | 音视频文件的容器 | mp4, flv, hls, mp3, m4a, webm, a-hls, pcm, dash, ts |
transmux | bool | 是否仅执行容器格式转换 | true, false |
clip | object | 是否截取音视频片段 | - |
+ startTimeInSecond | int | 视频片段的起始时间 | - |
+ durationInSecond | int | 视频片段的持续时间 | - |
audio | object | 音频输出信息的集合,不设置audio相关参数则转码输出不包含音频流,如果保留音频流则必须设置此对象 | - |
+ codec | string | 音频编码格式 | aac, mp3, ac3, pcm, opus |
+ bitRateInBps | int | 音频目标码率(输出为pcm格式时不可选,设置静音mute时可不填,否则必选) | 大于0 |
+ sampleRateInHz | int | 音频采样率 | 22050, 32000, 44100, 48000, 96000 |
+ channels | int | 音频声道数目 | 1, 2 |
+ pcmFormat | string | PCM音频格式,仅当container=pcm时有效 | s16le |
+ volumeAdjust | object | 音量相关参数设置 | - |
++ mute | bool | 是否进行静音操作,当设置了mute时,Job中不允许有audio类型的insert。mute和其它audio参数同时设置时,优先进行静音(mute)操作 | true, false |
++ norm | bool | 是否进行音频归一化操作 | true, false |
++ gain | int | 音量调节的大小,单位db,值为正则增大音量 | -60 ~ 60 |
video | object | 视频输出信息的集合,不设置video相关参数则转码输出不包含视频流,如果保留视频流则必须设置此对象 | - |
+ codec | string | 视频编码格式 | h264, h265(搭配选择profile字段为main), h265_bd265, svt_av1, vp8, vp9 |
+ codecOptions | object | 视频编码的配置选项 | - |
++ profile | string | 档次 | baseline, main, high |
++ bFrames | int | B帧数 | 0-7 |
++ bPyramid | string | 使用B帧作为参考帧(ps:当选择codec为h264才可以设置此参数。)none:禁用; strict:严格分层的金字塔结构; normal:非严格分层的金字塔结构; hieb:多层级的参考B帧(当bFrames=7且profile=main/high时才能开启多层级的参考B帧)。 | none, normal, hieb |
+ rateControl | string | 码率控制方式,crf模式通过调整码率来实现最优质量;相较于vbr,cbr生成的视频码率在目标码率上下浮动范围小,更接近目标码率。感知编码由cae模式控制码率实现。 | crf,vbr,cbr,cae |
+ codecEnhance | boolean | ROI增强,是感知编码核心参数:针对人脸区域提升画质、显著性增强。 | true,false |
+ crf | int | 恒定质量因子,若设置了crf值,bitRateInBps可表示最大目标码率 | 1 ~ 51 |
+ bitRateInBps | int | 视频目标码率 | 32000bps ~ 500Mbps |
+ maxRateInBps | int | 视频最大码率 。若选择码率控制方式为crf/cae,需要设置最大码率,在保证视频质量最优的同时,最终码率不超过设置的最大码率上限。 | 32000bps ~ 500Mbps |
+ maxFrameRate | int | 目标视频最大帧率 | 10,15, 23.97, 24, 25, 29.97, 30, 50, 60 |
+ maxWidthInPixel | int | 目标视频的最大宽度 | 128 ~ 8192 |
+ maxHeightInPixel | int | 目标视频的最大高度 | 96 ~ 7680 |
+ sizingPolicy | string | 尺寸伸缩策略 | keep、shrinkToFit、stretch、shrinkToFitBlur,keep表示保持原始视频宽高比,shrinkToFit表示保持原始视频宽高比并加黑边,stretch表示拉伸原始视频,shrinkToFitBlur同shrinkToFit除了黑边替换为高斯模糊 |
+ autoAdjustResolution | bool | 当原视频为竖形时,自动调整模板的宽小于高,保证缩放比最小,反之亦然(仅当sizingPolicy为keep时可以设置) | true,false |
+ playbackSpeed | int | 回放速度,值低于1.0时为减速视频,高于1.0时为加速视频(不可同时指定音频设置) | 0.05 ~ 20.0 |
encryption | object | HLS加解密信息的集合 | - |
+ strategy | string | 视频加密策略 | Fixed: 表示固定密钥加密,使用用户指定的密钥对视频进行加密,此时需要aesKey; Open:开放密钥,系统自动生成加密密钥,密钥公开,不设访问控制; PlayerBinding:绑定播放器,系统自动生成加密密钥,密钥设有访问控制; PlayerBinding模式下密钥设有访问控制,安全性比较高,推荐使用PlayerBinding模式。 |
+ aesKey | string | AES128加密密钥 | - |
watermarkId | string | 水印id(当transmux=true时不允许添加水印) | - |
watermarks | object | 多水印设置,不可同时指定watermarkId和watermarks | - |
+ image | array | 多水印watermarkId数组 | size最大为5 |
digitalWmId | string | 需嵌入的数字水印模板ID | 需从用户已创建的数字水印模板选择 |
digitalWmSecretKeyId | string | 数字水印密钥模板ID,密钥用于对水印加密嵌入,提取水印需提供正确密钥 | 需从用户已创建的数字水印密钥模板选择,生效优先级高于转码模板中的密钥 |
digitalWmAlgVersion | int | 算法版本号 | 0 ~ 2 |
digitalWmStrength | double | (算法1、2有效)数字水印嵌入强度,对同一算法,强度越高则抗攻击能力越强,隐蔽性越差 | 0 ~ 1 |
transCfg | object | 转码配置信息 | - |
+ transMode | string | 转码模式 | normal, twopass, cae, cae_enhanced, cae_external, cae_external_sr,cae_external_sr_vis super_resolution,super_resolution_vis。当转码模式为twopass, cae, cae_enhanced时,video不能为空;cae_external_sr cae带主观增强,cae_external_sr_vis cae带主观增强vis模型。super_resolution 超分辨率。super_resolution_vis vis模型超分辨率 |
extraCfg | object | 转码额外配置/视频处理类 | |
+ watermarkDisableWhitelist | string | 设置不加水印的条件 | 当前可设置 portrait,表示竖屏视频不加水印 |
+ segmentDurationInSecond | int | 设置分片时长(仅当container为hls,a-hls,dash时可以设置) | 取值范围 1.0 ~ 60.0,浮点数精度为小数点后三位以内 |
+ gopLength | int | 设置gop长度(仅当配置了video参数时可以设置;当segmentDurationInSecond和gopLength参数共存时,建议保证 segmentDurationInSecond*原视频帧率 为gopLength的整数倍) | [0, 500],其中0表示结果视频只包含i帧 |
+ skipBlackFrame | bool | 智能检测并裁剪片头黑帧,最长截取前5s黑帧 | true,false |
+ horiToVeri | bool | 视频横转竖 | true, false |
+ stabilization | bool | 视频去抖动 | true, false |
+ autoDesubtitle | int | 智能去字幕 | 1: 字幕区域填充背景;2: 裁剪掉字幕区域 |
+ autoDelogo | bool | 是否自动去水印。默认手动去水印(位置大小参数需在转码任务参数内配置) | true,false |
+ delogoMode | string | 去水印模式 | Normal:高斯模糊;Inpainting:背景填充 |
+ colorEnhance | bool | 色彩增强 | true,false |
+ aiVideoEnhance | bool | 视频细节增强,不改变分辨率 | true,false |
+ enhanceStrength | Float | 细节增强强度,越大越锐利 | 0-1 |
+ faceEnhanceModel | string | 人脸增强 | 根据人脸增强时的细节生成水平,可选strong_generative,ultra_generative |
+ aiSdrToHdr | bool | 智能HDR | true,false;ps:智能hdr必须选择h265编码,main10编码规格 |
+ superResolution | bool | 超分辨率,ps:最多可超分3-5倍 | true,false |
+ superResolutionVersion | int | 超分模型选择 | -1:仅缩放 ;0: 模型0,速度较快,适合互联网UGC内容;1:模型1,速度慢,适合影视剧;2:模型2,速度慢,适合较老的影视剧;3:模型3,速度快,适合UGC和影视剧,细节生成能力较弱;4:模型4,速度快,适合UGC和影视剧,细节生成能力强 |
+ frameInterpolate | bool | 智能插帧 | true, false |
+ aiVideoScratchRemove | Float | 老片修复_去划痕 | 0~1 数字越大,去划痕灵敏度越高 |
+ aiVideoDenoise | Float | 老片修复_去噪 | 0~1 数字越大,去噪强度越大 |
+ aiVideoColorization | bool | 老片修复_上色 | true,false |
+ preserveMetadata | bool | 保留源视频的metadata | true, false |
- 抽帧模板类型返回字段
字段名称 | 字段类型 | 字段描述 | 取值范围 |
---|---|---|---|
target | object | 目标缩略图信息的集合 | - |
+ format | string | 目标缩略图的格式 | jpg、png、mp4、gif、webp |
+ sizingPolicy | string | 目标缩略图的尺寸伸缩策略 | keep、shrinkToFit、stretch,keep表示保持原始视频宽高比,shrinkToFit表示保持原始视频宽高比并加黑边,stretch表示拉伸原始视频 |
+ widthInPixel | int | 目标缩略图的宽,如果视频实际分辨率低于目标分辨率则按照实际分辨率输出 | 10 ~ 2000 |
+ heightInPixel | int | 目标缩略图的高,如果视频实际分辨率低于目标分辨率则按照实际分辨率输出 | 10 ~ 2000 |
+ frameRate | int | 动图的帧率,仅当format为mp4、gif、webp且mode为manual、split时可选 | 0.01 ~ 30.0 |
+ gifQuality | string | gif的质量,仅当format为gif且mode为manual、split时可选 | high, medium |
+ spriteOutputCfg | object | 雪碧图输出参数设置,仅当抽取多图(即mode=manual/split),且输出为非动图(即format=jpg/png)时可选 | - |
++ rows | int | 雪碧图拼接行数 | 1 ~ 100 |
++ columns | int | 雪碧图拼接列数 | 1 ~ 100 |
++ margin | int | 外框宽度,单位:px | 1 ~ 1000 |
++ padding | int | 外框宽度,单位:px | 1 ~ 1000 |
++ keepCellPic | bool | 是否保留子图原图 | true, false |
++ spriteKeyTag | string | 上传BOS的雪碧图的key中用于标记为雪碧图的tag,最终文件名为 {keyPrefix}+{spriteKeyTag}+{雪碧图序号%05d},雪碧图中子图按照原视频中的顺序排列 | 字符串长度范围为1 ~ 100 |
capture | object | 生成缩略图的规则 | - |
+ mode | string | 生成缩略图的模式 | auto、manual、split、shot、idl、highlight,auto模式是系统自动截取熵值较高的一帧作为缩略图,manual模式是根据指定的起止时间和间隔时间截取缩略图,split模式是根据指定的起止时间和张数截取缩略图,shot模式根据场景切换自动截取画面(不支持输出视频格式),idl模式时使用百度IDL(Institute of Deep Learning)智能缩略图算法截取缩略图(仅支持输出jpg格式),highlight模式自动生成一个0.5s的精彩片段(目前仅适用于竖屏小视频,只支持输出视频格式,默认为正播反播合并效果) |
+ frameint | int | 生成缩略图的张数,仅当mode=split时可选 | 大于等于1 |
+ startTimeInSecond | int | 生成缩略图的开始时间,当mode=manual或split时可选 | 大于等于0 |
+ endTimeInSecond | int | 生成缩略图的结束时间,当mode=manual或split时可选,且不得小于start time | 大于等于0 |
+ intervalInSecond | int | 生成缩略图的间隔时间,仅当mode=manual时可选 | 大于0 |
+ minIntervalInSecond | int | 生成缩略图的最小间隔时间,仅当mode=split时可选 | 大于0 |
+ skipBlackFrame | boolean | 是否跳过黑帧,仅当mode=manual或split时可选 | true/false |
+ highlightOutputCfg | object | highlight 模式下输出控制参数,仅当mode=highlight时可选 | - |
++ durationInSecond | int | 截取片段时长,单位:秒 | 0.1 ~ 7200.0 |
++ playbackSpeed | int | 回放速度,值低于1.0时为减速视频,高于1.0时为加速视频 | 0.05 ~ 20.0 |
++ frameRate | int | 输出视频帧率,单位:fps | 0.1 ~ 60.0 |
++ reverseConcat | bool | 正播反播合并效果 | true, false |
- 明水印模板类型返回字段
字段名称 | 字段类型 | 字段描述 | 取值范围 |
---|---|---|---|
verticalAlignment | string | 垂直对齐方式 | top, center, bottom |
horizontalAlignment | string | 水平对齐方式 | left, center, right |
verticalOffsetInPixel | int | 垂直偏移,该参数仅在verticalAlignment设置为top或bottom时有效,单位:像素 | 0 ~ 3072 |
horizontalOffsetInPixel | int | 水平偏移,该参数仅在horizontalAlignment设置为left或right时有效,单位:像素 | 0 ~ 4096 |
timeline | object | 水印有效显示起止时间(仅当watermarkId被设置到Preset.watermarks.image多水印参数中时该字段可生效) | - |
+ startTimeInMillisecond | int | 水印显示起始时间,单位:毫秒 | 大于等于0 |
+ durationInMillisecond | int | 水印显示持续时间,单位:毫秒 | 大于等于0 |
repeated | int | (动态)水印重复显示次数,为0表示无限循环(仅当watermarkId被设置到Preset.watermarks.image多水印参数中时该字段可生效) | 大于等于0 |
allowScaling | bool | 是否允许自动进行缩放(仅当watermarkId被设置到Preset.watermarks.image多水印参数中时该字段可生效) | true、false |