使用任务流模板进行视频处理

最近更新时间:2024-03-12 02:01:16

我的收藏

1. 接口描述

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

使用任务流模板,对点播中的视频发起处理任务。
有两种方式创建任务流模板:

  1. 在控制台上创建和修改任务流模板;
  2. 通过任务流模板接口创建任务流模板。

如使用事件通知,除音视频审核任务外的事件通知的类型为 任务流状态变更;音视频审核任务事件通知的类型为 音视频审核完成

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ProcessMediaByProcedure。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
FileId String 媒体文件 ID。
示例值:5285485487985271487
ProcedureName String 任务流模板名字。
示例值:TranscodeAndSnapshot
SubAppId Integer 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
示例值:123
TasksPriority Integer 任务流的优先级,数值越大优先级越高,取值范围是-10到10,不填代表0。
示例值:0
TasksNotifyMode String 任务流状态变更通知模式,可取值有 Finish,Change 和 None,不填代表 Finish。
示例值:Finish
SessionContext String 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
示例值:""
SessionId String 用于去重的识别码,如果 7 天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
示例值:""
ExtInfo String 保留字段,特殊用途时使用。
示例值:""

3. 输出参数

参数名称 类型 描述
TaskId String 任务类型为 Procedure 的任务 ID,当入参 ProcedureName 对应的任务流模板指定了 MediaProcessTask、AiAnalysisTask、AiRecognitionTask 中的一个或多个时发起该任务。
示例值:125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca
ReviewAudioVideoTaskId String 任务类型为 ReviewAudioVideo 的任务 ID,当入参 ProcedureName 对应的任务流模板指定了 ReviewAudioVideoTask 时,发起该任务。
示例值:""
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 以任务流模板名的方式发起任务

对 fileId 为 5285485487985271487 的发起任务,使用的任务流模板名为 TranscodeAndSnapshot。

输入示例

https://vod.tencentcloudapi.com/?Action=ProcessMediaByProcedure
&FileId=5285485487985271487
&ProcedureName=TranscodeAndSnapshot
&<公共请求参数>

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.InvalidVodUser 没有开通点播业务。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.FileId FileId 不存在。
InvalidParameterValue.ProcedureName 任务流模板名无效。
InvalidParameterValue.SessionContextTooLong SessionContext 过长。
InvalidParameterValue.SessionId 去重识别码重复,请求被去重。
InvalidParameterValue.SessionIdTooLong SessionId 过长。
InvalidParameterValue.SubAppId 参数值错误:子应用 ID。
InvalidParameterValue.UniqueIdentifier 去重识别码一天内重复,请求被去重。
UnauthorizedOperation 未授权操作。