1. 接口描述
接口请求域名: vod.tencentcloudapi.com 。
视频深度估计接口。输入视频,输出灰度深度视频,白色为近、黑色为远。深度值为单视频内归一化的相对深度。输出存储由 OutputConfig 控制,默认临时存储 7 天后过期。任务提交成功后返回任务 ID,可通过 DescribeTaskDetail 查询结果
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:VideoDepthEstimation。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-17。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| SubAppId | 否 | Integer | 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。 示例值:1500000001 |
| Url | 否 | String | 输入视频地址,必填。支持三种形态,按前缀自动识别: vod://{FileId} —— 引用当前账号下的 VOD 媒资。要求媒资存在且未处于禁用状态,否则将报参数错误。源文件不受影响。 http(s)://... —— 公网可下载的视频地址,长度不超过 8182 字符。 data:{mime};base64,{payload} —— Base64 内联媒体,适合小体积素材。解码后大小上限 20 MB,mime 须为视频容器类型(如 video/mp4、video/quicktime)。 示例值:https://example.com/video.mp4 |
| OutputConfig | 否 | VideoDepthEstimationOutputConfig | 输出存储配置。不传时为临时存储。 |
| SessionId | 否 | String | 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。 示例值:SessionId |
| SessionContext | 否 | String | 来源上下文,用于透传用户请求信息,任务完成回调将返回该字段值,最长 1000 个字符。 示例值:SessionContext |
| TasksPriority | 否 | Integer | 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。 示例值:0 |
| ExtInfo | 否 | String | 保留字段,特殊用途时使用。 示例值:{"ExtParameters": ""} |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务 ID。 示例值:125xxx65-VideoDepthEstimation-bffb15f07530b57bc1aabb01fac74bcat |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 视频深度估计示例(临时存储)
对公网视频做深度估计,产物临时存储 7 天。
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VideoDepthEstimation
<公共请求参数>
{
"SubAppId": 1490012345,
"Url": "https://example.com/video.mp4"
}
输出示例
{
"Response": {
"RequestId": "6d8e9a03-5c01-4a2b-8f3d-7e6c5b4a3d2e",
"TaskId": "1490012345-VideoDepthEstimation-bffb15f07530b57bc1aabb01fac74bcat"
}
}
示例2 视频深度估计示例(永久存储)
对已有媒资做深度估计,产物写入媒资库并指定名称与过期时间。
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VideoDepthEstimation
<公共请求参数>
{
"SubAppId": 1490012345,
"Url": "vod://5285890799710678156",
"OutputConfig": {
"StorageMode": "Permanent",
"MediaName": "my-depth-video",
"ExpireTime": "2026-12-31T00:00:00+08:00"
},
"SessionId": "SessionId",
"SessionContext": "SessionContext",
"TasksPriority": 0
}
输出示例
{
"Response": {
"RequestId": "6d8e9a03-5c01-4a2b-8f3d-7e6c5b4a3d2e",
"TaskId": "1490012345-VideoDepthEstimation-bffb15f07530b57bc1aabb01fac74bcat"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.ExpireTime | 参数值错误:ExpireTime 格式错误。 |
| InvalidParameterValue.FileId | FileId 不存在。 |
| InvalidParameterValue.SessionContextTooLong | SessionContext 过长。 |
| InvalidParameterValue.SessionId | 去重识别码重复,请求被去重。 |
| InvalidParameterValue.SessionIdTooLong | SessionId 过长。 |
| InvalidParameterValue.Url | 参数错误:无效的Url。 |
| ResourceNotFound.UserNotExist | 用户不存在。 |