媒资库接口
创建媒资
VOD不提供直接创建媒资的API接口,而是用申请上传、媒资上传、完成上传三步创建法完成创建:1) 通过申请媒资获取sessionKey、上传链接;2) 通过上传链接上传媒资;3) 通过处理媒资方法通知VOD服务文件上传完毕,VOD开始生成并处理媒资。
申请上传
申请上传接口用于生成媒资上传时的唯一标识sessionKey、sessionKey会在完成上传时用于校验文件。
注意:成功申请媒资后,请参考媒资三步创建法于24小时内完成媒资上传及媒资处理,否则相应的sessionKey将逾期失效。
请求语法
POST /v2/medias/upload HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: <utc-string-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>
请求参数
参数 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
name | string | 是 | 名称 | |
container | string | 是 | 音视频封装格式 | 文件封装格式:mp4、flv、mov、m3u8、3gp、avi、mpg、asf、wmv、mkv、ts、webm、mxf、mp3、m4a、flac、ogg、wav、ra、aac、amr |
isMultipartUpload | boolean | 是 | 是否需要分片上传 | 不需要分片上传为false,分片上传为true |
numParts | int | 否 | 分片数 | isMultipartUpload为true是必须指定 |
请求头域
无特殊请求头域。
请求示例
POST /v2/medias/upload HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: 2024-08-03T09:28:13Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: c82c903b-f513-4990-b020-637bc866ee75
content-type: application/json
authorization: <bce-authorization-string>
{
"name": "demo",
"needMultiPartUpload": "false",
"container": "mp4"
}
响应头域
无特殊响应头域。
响应参数
参数 | 类型 | 中文名 | 说明 |
---|---|---|---|
sessionKey | string | 临时上传key | |
urls | List | 上传预签名链接,使用 HTTP PUT 上传文件到此 |
响应示例
HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: c82c903b-f513-4990-b020-637bc866ee75
Cache-Control: no-cache
Server: BWS
string: Tue, 24 Mar 2024 13:34:07 GMT
Content-Type: application/json;charset=UTF-8
{
"urls": [
"http://bj-bos.baidu-int.com/v1/vod-egyrrahca3f80ev6/tmp/egyrfpkuyz52k8jakmb3/ehws7pu6637u1nk8j5nm.mp4?authorization=bce-auth-v1%2F213ee4f72b944fdba2e3326af256b781%2F2024-08-21T08%3A50%3A09Z%2F86400%2Fhost%2Ff4b3729dbbf56c9bc0297281907ff2c59b0d0028ed8453f0daeac11a820b06cc"
],
"sessionKey": "ZEcxd0wyVm5lWEptY0d0MWVYbzFNbXM0YW1GcmJXSXpMMlZvZDNNM2NIVTJOak0zZFRGdWF6aHFOVzV0TG0xd05BPT1fX1pHVnRidz09"
}
媒资上传
媒资上传使用的url为申请上传接口响应的urls,如果是分片上传请自行调用Bos SDK对媒资进行切分。
注意:成功申请媒资后,请在24小时内完成上传,逾期上传链接将会失效。上传请求类型为PUT
完成上传
用于对已完成申请上传视频进行校验,生成媒资id(mediaId为媒资的唯一标识)
请求语法
POST /v2/medias/complete_upload HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: <utc-string-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>
请求头域
无特殊请求头域。
请求参数
参数 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
sessionKey | string | 是 | 临时上传key | |
isMultipartUpload | string | 是 | 是否是分片上传 | |
etags | list | 否 | 文件的版本标识,在上传分片文件到BOS时可从相应头获取 | isMultipartUpload为true是必须指定 |
请求示例
POST /v2/medias/complete_upload HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: 2024-07-03T09:28:13Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 012b9747-f13a-4a2c-a488-02b221844dca
content-type: application/json
authorization: <bce-authorization-string>
{
"sessionKey": "ZWh2a3VkMXFpcjV1cjJ3dXpqdGYvZGVtby9tcDQ=",
"isMultipartUpload": false
}
如果是分片上传请求示例如下:
POST /v2/medias/complete_upload HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: 2024-07-03T09:28:13Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 012b9747-f13a-4a2c-a488-02b221844dca
content-type: application/json
authorization: <bce-authorization-string>
{
"sessionKey": "ZWh2a3VkMXFpcjV1cjJ3dXpqdGYvZGVtby9tcDQ=",
"isMultipartUpload": true,
"etags": [
"srw4rsdlkjf23",
"srw4rsdlkjf24"
]
}
响应头域
无特殊响应头域。
响应参数
参数 | 类型 | 中文名 | 说明 |
---|---|---|---|
mediaId | string | 媒资id | 媒资的唯一标识,开发者可通过 mediaId 查询指定媒资的详细信息 |
响应示例
HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 012b9747-f13a-4a2c-a488-02b221844dca
Cache-Control: no-cache
Server: BWS
string: Tue, 24 Mar 2024 13:34:07 GMT
Content-Type: application/json;charset=UTF-8
{
"mediaId":"mda-gaefib8idcyi36q8"
}
媒资处理
用于对已完成上传的媒资进行处理
请求语法
POST /v2/medias/process HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: <utc-string-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>
请求头域
无特殊请求头域。
请求参数
参数 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
mediaId | string | 是 | 媒资id | |
workflowId | string | 是 | 工作流id |
请求示例
POST /v2/medias/process HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: 2024-07-03T09:28:13Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 012b9747-f13a-4a2c-a488-02b221844dca
content-type: application/json
authorization: <bce-authorization-string>
{
"mediaId": "mda-egksbi1hn2psgn36",
"workflowId": "eg1qd6y8esmkjepd"
}
响应头域
无特殊响应头域。
响应参数
参数 | 类型 | 中文名 | 说明 |
---|---|---|---|
mediaId | string | 媒资id | 媒资的唯一标识,开发者可通过 mediaId 查询指定媒资的详细信息 |
taskId | string | 任务id,该媒资在任务中心的唯一标识 | 任务id,该媒资在任务中心的唯一标识 |
响应示例
HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 012b9747-f13a-4a2c-a488-02b221844dca
Cache-Control: no-cache
Server: BWS
string: Tue, 24 Mar 2024 13:34:07 GMT
Content-Type: application/json;charset=UTF-8
{
"mediaId":"mda-gaefib8idcyi36q8",
"taskId":"tsk-abcfib8idcyi36q8",
}
查询指定媒资
通过媒资的唯一标识 mediaId 查询指定媒资的详细信息。
请求语法
GET /v2/medias/{mediaId} HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: <utc-string-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>
请求头域
无特殊请求头域。
请求参数
参数 | 类型 | 中文名 | 是否必须 | 说明 |
---|---|---|---|---|
mediaId | string | 媒资id | 是 | 媒资的唯一标识,开发者可通过 mediaId 查询指定媒资的详细信息 |
请求示例
GET /v1/media/mda-fhepatsnpn4rk9zk HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: 2024-03-24T13:08:44Z
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: d97c57d0-ca44-4d1c-bfeb-941a92440968
content-type: application/json
authorization: <bce-authorization-string>
响应头域
无特殊响应头域。
响应参数
响应参数参考:MediaDetail
响应示例
HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: d97c57d0-ca44-4d1c-bfeb-941a92440968
Cache-Control: no-cache
Server: BWS
string: Tue, 24 Mar 2024 13:34:07 GMT
Content-Type: application/json;charset=UTF-8
{
"mediaId":"mda-fhepatsnpn4rk9zk",
"status":"success",
"attributes":{
"title":"my_media",
"description":"my_media_description"
},
"meta":{
"sourceSizeInBytes":80000,
"sizeInBytes":102400,
"durationInSeconds":60
},
"publishTime":"2024-03-25T13:37:10Z",
"createTime":"2024-03-24T13:37:10Z",
"transcodingPresetGroupName": "presetgroup_name",
"playableUrlList": [
{
"transcodingPresetName": "mp4_1920x1080_3660kbps",
"url": "http://test.exp.bcevod.com/mda-fhepatsnpn4rk9zk/sdf92ejsjowdgww230l/mda-fhepatsnpn4rk9zk.m3u8"
"meta": {
"sizeInBytes": 102400,
"durationInSeconds": 60,
"bitRateInBps": 120,
"frameRate": 30,
"widthInPixel": 120,
"heightInPixel": 360
}
},
{
"transcodingPresetName": "hls_640x360_520kbps",
"url": "http://test.exp.bcevod.com/mda-fhepatsnpn4rk9zk/0jx92ekmxdwdgwwsi34/mda-fhepatsnpn4rk9zk.mp4"
"meta": {
"sizeInBytes": 102400,
"durationInSeconds": 60,
"bitRateInBps": 120,
"frameRate": 30,
"widthInPixel": 120,
"heightInPixel": 360
}
}
],
"thumbnailList": [
"http://test.exp.bcevod.com/mda-fhepatsnpn4rk9zk/mda-fhepatsnpn4rk9zk.jpg",
]
}
媒资分页接口
对用户的所有媒资进行条件筛选并用marker机制显示。
请求语法
GET /v2/medias?marker={marker}&maxSize={maxSize}&banStatus={banStatus}&publishStatus={publishStatus}&beginTime={beginTime}&endTime={endTime}&mediaId={mediaId}&name={name} HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: <utc-string-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>
请求头域
无特殊请求头域。
请求参数
参数 | 类型 | 说明 | 是否必须 |
---|---|---|---|
marker | string | 本次请求的marker,标记查询的起始位置,是上次marker机制查询返回的nextMarker,首次查询不提供本字段 | 否 |
maxSize | int | 本次请求返回的任务列表的最大元素个数,有效值:[1-1000],默认值:10 | 否 |
banStatus | string | 封禁状态可选NORMAL(正常),BAN(封禁) | 否 |
publishStatus | string | 发布状态可选UPLOADED(上传完毕),PROCESSING(处理中),PROCESSING_FAILED(处理失败),PUBLISH(已发布) | 否 |
beginTime | string | 媒资创建时间(createTime)上限,用于筛选创建时间等于或晚于beginTime的媒资 | 否 |
endTime | string | 媒资更新时间(createTime)下限,用于筛选创建时间等于或早于endTime的媒资 | 否 |
mediaId | string | 媒资id,用于筛选标题以title开头的媒资 | 否 |
name | string | 媒资名称,用于筛选含name的媒资 | 否 |
请求示例
GET /v1/media?marker=mda-fhepatsnpn4rk9zk&maxSize=2&publishStatus=PUBLISH&begin=2024-09-11T12:18:30Z&end=2024-09-13T12:18:30Z HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: 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-string/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9
响应头域
无特殊响应头域。
响应参数
参数 | 类型 | 中文名 | 说明 |
---|---|---|---|
isTruncated | boolean | 下一页是否还有数据 | |
marker | string | ||
nextMarker | string | 查询下一页的marker | |
data | [MediaOverview] | 此页数据 | |
+ mediaId | string | 媒资id | |
+ name | string | 媒资名称 | |
+ publishStatus | string | 发布状态 | UPLOADED("已上传"),PROCESSING("处理中"),PROCESSING_FAILED("处理失败"),PUBLISH("已发布") |
+ banStatus | string | 封禁状态 | NORMAL("正常"),BAN("封禁") |
+ createTime | string | 创建时间 | |
+ source | MediaSource | 媒资源信息 | |
++ sourceType | string | 媒资来源 | UPLOAD("上传") |
++ sourceUrl | string | 源文件链接 | |
++ coverUrl | string | 封面图链接 | |
+ metadata | MediaMetadata | 媒资源文件元信息 | |
++ fileSizeInByte | int | 音视频文件的大小 | |
++ durationInSecond | string | 音视频媒体时长 | |
++ container | string | 音视频文件的容器类型 | |
++ etag | string | 文件的版本标识(详见BOS接口公共返回头) | |
++ type | string | 文件类型 | video,视频; audio,音频 |
++ video | VideoCodec | ||
+++ codec | string | 视频文件的编码规格 | |
+++ heightInPixel | int | ||
+++ widthInPixel | int | ||
+++ bitRateInBps | int | ||
+++ frameRate | number | ||
+++ rotate | int | ||
+++ dar | string | ||
++ audio | AudioCodec | ||
+++ codec | string | 音频文件的编码规格 | |
+++ channels | int | 音频文件的声道信息 | |
+++ sampleRateInHz | int | 音频文件的采样率 | |
+++ bitRateInBps | int | 音频文件的码率 |
响应示例
HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
string: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8
{
"data": [
{
"mediaId": "mda-fhepatsnpn4rk9zk",
"name": "vod1.mp4",
"publishStatus": "PUBLISH",
"banStatus": "NORMAL",
"createTime": "2024-08-21T09:44:41Z",
"source": {
"sourceType": "UPLOAD",
"sourceUrl": "https://bj-bos.baidu-int.com/v1/vod-egyrrahca3f80ev6/mda-fhepatsnpn4rk9zk/_src/mda-ehwth0gvkaj8c53z.mp4?authorization=bce-auth-v1%2F213ee4f72b944fdba2e3326af256b781%2F2024-08-21T12%3A20%3A28Z%2F3600%2F%2Fd575aaebfe4e164b94e3146bc245f594dedccd1b8f467d816cc35039e3f9c980",
"coverUrl": "https://bj-bos.baidu-int.com/v1/vod-egyrrahca3f80ev6/mda-fhepatsnpn4rk9zk/ehwty5yu7pn7nxqc7rde/ehwttwiu8p6eyas1e7aj/mda-ehwth0gvkaj8c53z.jpg?authorization=bce-auth-v1%2F213ee4f72b944fdba2e3326af256b781%2F2024-08-21T12%3A20%3A28Z%2F3600%2F%2Fee70350a7d12e56ba9efd9ad9c0ece4009e72aa7b28eeb3595fae433beb09caf"
},
"metadata": {
"fileSizeInByte": 2443128,
"type": "video",
"container": "mov,mp4,m4a,3gp,3g2,mj2",
"durationInSecond": 4,
"durationInMillisecond": 4410,
"video": {
"codec": "h264",
"heightInPixel": 720,
"widthInPixel": 1280,
"bitRateInBps": 4388595,
"frameRate": 24.0,
"dar": "16:9"
},
"audio": {
"codec": "aac",
"channels": 1,
"sampleRateInHz": 44100,
"bitRateInBps": 69574
},
"etag": "ba7247de26535e57f0fff4c2a80fe08e"
}
},
{
"mediaId": "mda-ehwkurnbbirnxfrr",
"name": "vod.mp4",
"publishStatus": "PROCESSING",
"banStatus": "NORMAL",
"createTime": "2024-08-21T02:13:11Z",
"source": {
"sourceType": "UPLOAD",
"sourceUrl": "https://bj-bos.baidu-int.com/v1/vod-egyrrahca3f80ev6/mda-ehwkurnbbirnxfrr/_src/mda-ehwkurnbbirnxfrr.mp4?authorization=bce-auth-v1%2F213ee4f72b944fdba2e3326af256b781%2F2024-08-21T12%3A20%3A28Z%2F3600%2F%2F75d21aee4ff0a92b22fa1da58b5f7721501666e56ac0994c3a138f197d0d0436"
}
}
],
"marker": "mda-fhepatsnpn4rk9zk",
"nextMarker": "mda-ehgr5pdgv6fsedqj",
"isTruncated": true
}
封禁媒资
通过媒资的唯一标识 mediaId 封禁媒资,仅对封禁状态为NORMAL的媒资有效
请求语法
PUT /v2/medias/ban HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: <utc-string-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>
请求头域
无特殊请求头域。
请求参数
参数 | 类型 | 中文名 | 描述 | 是否必须 |
---|---|---|---|---|
mediaId | string | 媒资id | 媒资的唯一标识,开发者可通过 mediaId 封禁媒资达到不分发的效果 | 是 |
请求示例
PUT /v2/medias/ban HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: 2024-07-03T09:28:13Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 8776558c-81d9-4f97-8e2c-f977a286095d
content-type: application/json
authorization: <bce-authorization-string>
{
"mediaId": "mda-FhJS1e75PrdXMyQ"
}
响应头域
无特殊响应头域。
响应参数
无。
响应示例
HTTP/1.1 200 OK
x-bce-request-id: 6d0b0a36-2ffe-49d4-9d81-333a9ab9417e
string: Tue, 24 Mar 2024 13:06:02 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache
解禁媒资
通过媒资的唯一标识 mediaId 解禁媒资,仅对封禁状态为BAN的媒资有效。
请求语法
PUT /v2/medias/unban HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: <utc-string-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>
请求头域
无特殊请求头域。
请求参数
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
mediaId | string | 媒资的唯一标识,开发者可通过 mediaId 查询指定媒资的详细信息 | 是 |
请求示例
PUT /v2/medias/unban HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: 2024-03-24T13:06:02Z
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: 6d0b0a36-2ffe-49d4-9d81-333a9ab9417e
content-type: application/json
authorization: <bce-authorization-string>
{
"mediaId": "mda-FhJS1e75PrdXMyQ"
}
响应头域
无特殊响应头域。
响应参数
无。
响应示例
PUT /v2/medias/unban HTTP/1.1 200 OK
x-bce-request-id: 6d0b0a36-2ffe-49d4-9d81-333a9ab9417e
string: Tue, 24 Mar 2024 13:06:02 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache
删除媒资
通过媒资的唯一标识 mediaId 删除指定媒资
请求语法
DELETE /v2/medias/{mediaId} HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: <utc-string-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>
请求头域
无特殊请求头域。
请求参数
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
mediaId | string | 媒资的唯一标识,开发者可通过 mediaId 查询指定媒资的详细信息 | 是 |
请求示例
DELETE /v2/medias/mda-fhepatsnpn4rk9zk HTTP/1.1
accept-encoding: gzip, deflate
x-bce-string: 2024-03-24T13:06:02Z
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: 6d0b0a36-2ffe-49d4-9d81-333a9ab9417e
content-type: application/json
authorization: <bce-authorization-string>
响应头域
无特殊响应头域。
响应参数
无。
响应示例
HTTP/1.1 200 OK
x-bce-request-id: 6d0b0a36-2ffe-49d4-9d81-333a9ab9417e
string: Tue, 24 Mar 2024 13:06:02 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache
附录
MediaDetail
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
mediaId | string | true | 媒资id | |
name | string | true | 媒资名称 | |
publishStatus | string | true | 发布状态 | NOT_UPLOADED("未上传"), UPLOADED("已上传"), PROCESSING("处理中"), PROCESSING_FAILED("处理失败"), PUBLISH("已发布") |
banStatus | string | true | 封禁状态 | NORMAL("正常"), BAN("封禁") |
createTime | string | true | 创建时间 | |
source | MediaSource | true | 媒资源信息 | |
metadata | MediaMetadata | true | 媒资源文件元信息 | |
transcodeOutputs | [TranscodeOutput] | true | 转码结果信息 | |
thumbnailOutputs | [ThumbnailOutput] | true | 缩略图结果信息 | |
subtitleOutputs | [SubtitleOutput] | true | 字幕提取结果信息 | |
vcaOutputs | [VcaOutput] | true | 智能分析结果信息 | |
vcrOutputs | [VcrOutput] | true | 智能审核结果信息 |
VcrOutput
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
id | string | true | output id | |
workflowNode | string | true | 处理的工作流名称 | |
vcrNodeName | string | true | vcr节点名称 | |
label | string | true | vcr审核结果 | NORMAL,正常; REVIEW,疑似违规; REJECT,确认违规; |
results | [object] | false | 审核结果map | |
+ type | string | true | ||
+ items | [object] | true | ||
++ subType | string | true | ||
++ timeInSeconds | int | true | ||
++ startTimeInSeconds | int | false | ||
++ endTimeInSeconds | int | false | ||
++ confidence | number(double) | true | ||
++ label | string | true | ||
++ extra | string | false | ||
++ evidence | object | false | ||
+++ location | object | true | ||
++++ leftOffsetInPixel | int | true | ||
++++ topOffsetInPixel | int | true | ||
++++ widthInPixel | int | true | ||
++++ heightInPixel | int | true |
VcaOutput
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
id | string | true | output id | |
workflowName | string | true | 处理的工作流名称 | |
vcaNodeName | string | true | vca节点名称 | |
results | [object] | false | 分析结果标签 | |
+ type | string | true | 标签 | |
+ result | [object] | true | 结果 | |
++ attributes | string | true | ||
++ source | string | true |
SubtitleOutput
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
id | string | true | output id | |
urls | [string] | true | 字幕文件链接 | |
workflowName | string | true | 处理的工作流名称 | |
subtitleNodeName | string | true | 字幕节点名称 | |
formats | [string] | true | 字幕文件格式 | json,srt |
ThumbnailOutput
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
id | string | true | output id | |
urls | [string] | true | 缩略图列表 | |
workflowName | string | true | 处理的工作流名称 | |
thumbnailNodeName | string | true | 缩略图节点名称 |
TranscodeOutput
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
id | string | true | output id | |
url | string | true | 播放链接 | |
workflowName | string | true | 处理的工作流名称 | |
transcodeNodeName | string | true | 转码节点名称 | |
meta | object | true | 元信息 | |
+ video | object | true | ||
++ durationInSeconds | string | true | ||
++ durationInMilliSeconds | int | true | ||
++ sizeInKiloByte | int | true | ||
++ widthInPixel | int | true | ||
++ heightInPixel | number | true | ||
++ frameRate | int | true | ||
++ gopAlign | string | true | ||
++ mp4MoovSize | string | true | ||
+ audio | object | true | ||
++ sampleRateInHz | int | true | 音频文件的采样率 | |
++ channels | string | true |
MediaMetadata
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
fileSizeInByte | int | true | 音视频文件的大小 | |
durationInSecond | string | true | 音视频媒体时长 | |
container | string | true | 音视频文件的容器类型 | |
etag | string | true | 文件的版本标识(详见BOS接口公共返回头) | |
type | string | true | 文件类型 | video,视频; audio,音频 |
video | VideoCodec | true | ||
audio | AudioCodec | true |
AudioCodec
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
codec | string | true | 音频文件的编码规格 | |
channels | int | true | 音频文件的声道信息 | |
sampleRateInHz | int | true | 音频文件的采样率 | |
bitRateInBps | int | true | 音频文件的码率 |
VideoCodec
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
codec | string | true | 视频文件的编码规格 | |
heightInPixel | int | true | ||
widthInPixel | int | true | ||
bitRateInBps | int | true | ||
frameRate | number | true | ||
rotate | int | true | ||
dar | string | true |
MediaSource
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
sourceType | string | true | 媒资来源 | UPLOAD("上传") |
sourceUrl | string | true | 源文件链接 | |
coverUrl | string | true | 封面图链接 |
MediaOverview
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
mediaId | string | true | 媒资id | |
name | string | true | 媒资名称 | |
publishStatus | string | true | 发布状态 | NOT_UPLOADED("未上传"),UPLOADED("已上传"),PROCESSING("处理中"),PROCESSING_FAILED("处理失败"),PUBLISH("已发布") |
banStatus | string | true | 封禁状态 | NORMAL("正常"),BAN("封禁") |
createTime | string | true | 创建时间 | |
source | MediaSource | true | 媒资源信息 | |
metadata | MediaMetadata | true | 媒资源文件元信息 |