1. 接口描述
接口请求域名: mps.tencentcloudapi.com 。
发起视频评测任务,功能包括:
- 对一个原视频和多个转码后的视频进行评分。
- 计算不同转码方式的 BD-Rate。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateMediaEvaluation。 |
Version | 是 | String | 公共参数,本接口取值:2019-06-12。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
InputInfo | 是 | MediaInputInfo | 评测的原文件输入信息。目前输入对象的类型有 COS 和 URL。 |
EvaluationTask | 是 | EvaluationTaskInput | 评测任务参数。 |
OutputStorage | 否 | TaskOutputStorage | 评测的输出文件的目标存储。不填则继承 InputInfo 中的存储位置。目前输出对象存储位置的类型有COS。 |
OutputDir | 否 | String | 评测生成文件的输出目录,必选以 / 开头和结尾,如/movie/201907/。 如果不填,表示与 InputInfo 中文件所在的目录一致。 |
TaskNotifyConfig | 否 | TaskNotifyConfig | 任务的事件通知信息,不填代表不获取事件通知。 |
TasksPriority | 否 | Integer | 任务优先级,数值越大优先级越高,取值范围是-10到 10,不填代表0。 |
SessionId | 否 | String | 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。 |
SessionContext | 否 | String | 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务 ID。 示例值:125xxx65-EvaluationTask-bffb15f07530b57 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 发起评测任务
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMediaEvaluation
<公共请求参数>
{
"InputInfo": {
"Type": "URL",
"UrlInputInfo": {
"Url": "http://abc/reference.mp4"
}
},
"OutputStorage": {
"Type": "COS",
"CosOutputStorage": {
"Bucket": "mybucket",
"Region": "ap-guangzhou"
}
},
"OutputDir": "/output/",
"EvaluationTask": {
"TaskType": "NORMAL",
"EvaluationTypeSet": [
"PSNR",
"VMAF"
],
"EvaluationRangeType": "FRAME",
"ContrastMediaSet": [
{
"InputInfo": {
"Type": "URL",
"UrlInputInfo": {
"Url": "http://abc/reference_transcode.mp4"
}
}
}
],
"StartFrameIndex": 1,
"EndFrameIndex": 100
}
}
输出示例
{
"Response": {
"TaskId": "24000006-EvaluationTask-366dd19ff7159ba06e24467b4212c41ett12",
"RequestId": "df1b9015-1f90-4ed1-820a-380cd78cbe5e"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.GenerateResource | 生成资源失败。 |
FailedOperation.InvalidMpsUser | 操作失败:非法 mps 用户。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.SessionContextTooLong | SessionContext 过长。 |
InvalidParameterValue.SessionId | 去重识别码重复,请求被去重。 |
InvalidParameterValue.SessionIdTooLong | SessionId 过长。 |