更新时间:2024-07-26 GMT+08:00
分享

媒资处理

功能介绍

实现视频转码、截图、加密等处理。既可以同时启动多种操作,也可以只启动一种操作。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1.0/{project_id}/asset/process

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

表3 请求Body参数

参数

是否必选

参数类型

描述

asset_id

String

VOD分配的媒资ID,仅支持查询,不支持修改。

template_group_name

String

转码模板组名称。

说明:

若不为空,则使用指定的转码模板对上传的音视频进行转码,您可以在视频点播控制台配置转码模板,具体请参见《点播服务用户指南》中的“转码设置”。

auto_encrypt

Integer

是否自动加密。

取值如下:

  • 0:表示不加密。

  • 1:表示需要加密。

默认值:0。

加密与转码必须要一起进行,当需要加密时,转码参数不能为空,且转码输出格式必须要为HLS。

thumbnail

Thumbnail object

截图参数

subtitle_id

Array of integers

字幕文件ID。

说明:
  • 仅调用接口创建媒资:上传方式视频更新,且设置请求参数“subtitles”时,该参数设置才生效。

  • 如果参数取值为空,默认选择最后一次上传的字幕压制至视频流中。

  • 视频流压制的字幕文件仅支持SRT格式。

表4 Thumbnail

参数

是否必选

参数类型

描述

type

String

截图类型。

取值如下:

  • time:每次进行截图的间隔时间。

  • dots: 按照指定的时间点截图。

  • quantity: 按照指定张数,根据视频时长等分视频截图。

quantity

Integer

type取值为quantity时必填。 按照指定张数,根据视频时长等分视频截图。

取值范围:[1,10]之间的整数。

quantity_time

Integer

type取值为quantity时选填。 按照指定时间间隔取指定张数截图。

取值范围:[0,2147483647]之间的整数。

time

Integer

根据时间间隔采样时的时间间隔值。单位:秒。

type取值为time时。

默认值:12

取值范围:[0,100]之间的整数。

dots

Array of integers

type取值为dots时必填。指定时间截图时的时间点数组。

cover_position

Integer

该值表示指定第几张截图作为封面。

默认值:1。

format

Integer

截图文件格式。

取值如下:

  • 1:jpg。

默认值:1 。

aspect_ratio

Integer

纵横比,图像缩放方式。

取值如下:

  • 0:自适应(保持原有宽高比)。

  • 1:16:9。

默认值:0。

max_length

Integer

截图最长边的尺寸。

单位:像素。

宽边尺寸按照该尺寸与原始视频像素等比缩放计算。

默认值:480。

响应参数

状态码: 202

表5 响应Body参数

参数

参数类型

描述

asset_id

String

VOD分配的媒资ID,仅支持查询,不支持修改。

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

媒资转码处理

POST https://{endpoint}/v1.0/{project_id}/asset/process

Content-Type: application/json
{
  "asset_id": "b4f39691d66cc0ef75d62ee567146e11",
  "template_group_name": "test",
  "auto_encrypt": 0,
  "thumbnail": {
    "type": "time",
    "time": 12
  },
  "subtitle_id": [
    1
  ]
}

响应示例

状态码: 202

处理成功返回。

{
  "asset_id" : "b4f39691d66cc0ef75d62ee567146e11"
}

状态码: 403

处理失败返回。

{
  "error_code" : "VOD.10062",
  "error_msg" : "Media asset or resource does not exist, please check."
}

状态码

状态码

描述

202

处理成功返回。

403

处理失败返回。

错误码

请参见错误码

相关文档