创建 MPS 任务模板

最近更新时间:2025-09-12 04:15:29

我的收藏

1. 接口描述

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

该接口用于创建自定义模板,模板用于 ProcessMediaByMPS 接口的部分功能。
创建模板时,需要将 MPS 相关参数以 JSON 格式填入 MPSCreateTemplateParams 参数中。关于具体的任务参数配置方法,请参考 MPS 任务模板相关文档说明。
当前支持创建自定义模板的 MPS 功能:

  1. 音视频增强

以该种方式创建的任务模板:

  1. 模板的管理仍在点播平台中完成。
  2. 该功能目前仍在内测中,如需测试体验,您可以联系我们获得支持。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateMPSTemplate。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
SubAppId Integer 点播应用 ID。
示例值:1500000001
TemplateType String 需要创建的 MPS 模板的类型。取值:
  • Transcode: 创建转码模板,目前仅支持创建增强模板。

  • 示例值:Transcode
    MPSCreateTemplateParams String MPS 创建模板参数。该参数用于透传至媒体处理服务(MPS),从云点播侧创建用户自定义的 MPS 任务模板。
    目前仅支持通过此方式创建以下任务类型的模板:
    1. 音视频增强:仅支持填写“创建转码模板”接口中的 Container 、Name、Comment、RemoveVideo、RemoveAudio、VideoTemplate、AudioTemplate 和 EnhanceConfig 几个参数。其中 EnhanceConfig 此处必填,且 Container 目前暂不支持 hls。

    目前模板中仅支持配置以上参数,其他参数无需填写。若包含其它参数,系统将自动忽略。以上透传参数以JSON形式表示。

    示例值:{"Container":"mp4","Name":"test","RemoveAudio":1,"VideoTemplate":{"Codec":"h264","Fps":0,"Bitrate":0},"EnhanceConfig":{"VideoEnhance":{"FrameRate":{"Switch":"ON","Fps":50}}}}

    3. 输出参数

    参数名称 类型 描述
    Definition Integer MPS 任务模板唯一标识。该模板独立于直接在 MPS 服务中创建的模板。
    示例值:30
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 创建 MPS 音视频增强任务模板

    输入示例

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateMPSTemplate
    <公共请求参数>
    
    {
        "SubAppId": 1500000001,
        "TemplateType": "Transcode",
        "MPSCreateTemplateParams": "{\"Container\":\"mp4\",\"Name\":\"test\",\"RemoveAudio\":1,\"VideoTemplate\":{\"Codec\":\"h264\",\"Fps\":0,\"Bitrate\":0},\"EnhanceConfig\":{\"VideoEnhance\":{\"FrameRate\":{\"Switch\":\"ON\",\"Fps\":50}}}}"
    }

    输出示例

    {
        "Response": {
            "Definition": 22143,
            "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameterValue 参数取值错误。
    LimitExceeded.TooMuchTemplate 超过限制值:模板数超过上限 100 个,如需更多请提交工单