API 文档

填写文档满意度调查问卷,赢取缤纷好礼> HOT

发起媒体处理

最近更新时间:2022-08-12 09:12:02

我的收藏

1. 接口描述

接口请求域名: mps.tencentcloudapi.com 。

对 COS 中的媒体文件发起处理任务,功能包括:

  1. 视频转码(带水印);
  2. 视频转动图;
  3. 对视频按指定时间点截图;
  4. 对视频采样截图;
  5. 对视频截图雪碧图;
  6. 对视频转自适应码流;
  7. 智能内容审核(鉴黄、敏感信息检测);
  8. 智能内容分析(标签、分类、封面、按帧标签);
  9. 智能内容识别(人脸、文本全文、文本关键词、语音全文、语音关键词)。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ProcessMedia。
Version String 公共参数,本接口取值:2019-06-12。
Region String 公共参数,本接口不需要传递此参数。
InputInfo MediaInputInfo 媒体处理的文件输入信息。
OutputStorage TaskOutputStorage 媒体处理输出文件的目标存储。不填则继承 InputInfo 中的存储位置。
OutputDir String 媒体处理生成的文件输出的目标目录,如/movie/201907/。如果不填,表示与 InputInfo 中文件所在的目录一致。
MediaProcessTask MediaProcessTaskInput 媒体处理类型任务参数。
AiContentReviewTask AiContentReviewTaskInput 视频内容审核类型任务参数。
AiAnalysisTask AiAnalysisTaskInput 视频内容分析类型任务参数。
AiRecognitionTask AiRecognitionTaskInput 视频内容识别类型任务参数。
TaskNotifyConfig TaskNotifyConfig 任务的事件通知信息,不填代表不获取事件通知。
TasksPriority Integer 任务流的优先级,数值越大优先级越高,取值范围是-10到 10,不填代表0。
SessionId String 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
SessionContext String 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
ScheduleId Integer 编排ID。
注意1:对于OutputStorage、OutputDir,如果编排任务里没有配置,将采用请求里对应参数。
注意2:对于TaskNotifyConfig,如果编排任务里没有配置,将采用请求里对应的参数。
注意3:编排的 Trigger 只是用来自动化触发场景,在手动发起的请求中已经配置的 Trigger 无意义。

3. 输出参数

参数名称 类型 描述
TaskId String 任务 ID。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 发起转码任务

对指定 COS 地址的视频发起转码任务,转出20,30,40三种格式。

输入示例

POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessMedia
<公共请求参数>

{
    "MediaProcessTask": {
        "TranscodeTaskSet": [
            {
                "Definition": "30"
            },
            {
                "Definition": "20"
            },
            {
                "Definition": "40"
            }
        ]
    },
    "InputInfo": {
        "Type": "COS",
        "CosInputInfo": {
            "Region": "ap-chongqing",
            "Object": "/movie/201907/WildAnimal.mov",
            "Bucket": "TopRankVideo-125xxx88"
        }
    }
}

输出示例

{
    "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
        "TaskId": "125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.InvalidMpsUser 操作失败:非法 mps 用户。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue.SessionContextTooLong SessionContext 过长。
InvalidParameterValue.SessionId 去重识别码重复,请求被去重。
InvalidParameterValue.SessionIdTooLong SessionId 过长。
目录