创建截图任务

最近更新时间:2024-04-24 01:15:38

我的收藏

1. 接口描述

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

创建一个在指定时间启动、结束的截图任务,并使用指定截图模板ID对应的配置进行截图。

  • 注意事项
  • 断流会结束当前截图。在结束时间到达之前任务仍然有效,期间只要正常推流都会正常截图,与是否多次推、断流无关。
  • 使用上避免创建时间段相互重叠的截图任务。若同一条流当前存在多个时段重叠的任务,为避免重复系统将启动最多3个截图任务。
  • 创建的截图任务记录在平台侧只保留3个月。
  • 当前截图任务管理API(CreateScreenshotTask/StopScreenshotTask/DeleteScreenshotTask)与旧API(CreateLiveInstantSnapshot/StopLiveInstantSnapshot)不兼容,两套接口不能混用。
  • 避免 创建截图任务 与 推流 操作同时进行,可能导致因截图任务未生效而引起任务延迟启动问题,两者操作间隔建议大于3秒。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateScreenshotTask。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou 。
StreamName String 流名称。
示例值:livetest
DomainName String 推流域名。
示例值:5000.live.push.com
AppName String 推流路径。
示例值:live
EndTime Integer 截图任务结束时间,Unix时间戳。设置时间必须大于StartTime及当前时间,且小于当前时间+7天。
示例值:1589904000
TemplateId Integer 截图模板ID,CreateLiveSnapshotTemplate 返回值。如果传入错误ID,则不拉起截图。
示例值:0
StartTime Integer 截图任务开始时间,Unix时间戳。如果不填表示立即启动截图。EndTime - StartTime不能超过24小时。
示例值:1589889600
StreamType Integer 推流类型,默认0。取值:
0-直播推流。
1-合成流,即 A+B=C 类型混流。
示例值:0
Extension String 扩展字段,暂无定义。默认为空。
示例值:""

3. 输出参数

参数名称 类型 描述
TaskId String 任务ID,全局唯一标识截图任务。返回TaskId字段说明截图任务创建成功。
示例值:UpTbk5RSVhRQFkAAfHwQCCjcRD0lRFcZ0xTSlNTQltlRVRLU1JAWW9EUb
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

输入示例

https://live.tencentcloudapi.com/?Action=CreateScreenshotTask
&AppName=live
&DomainName=5000.live.push.com
&StreamName=livetest
&StartTime=1589889600
&EndTime=1589904000
&TemplateId=0
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
        "TaskId": "UpTbk5RSVhRQFkAAfHwQCCjcRD0lRFcZ0xTSlNTQltlRVRLU1JAWW9EUb"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.GetConfigError 获取配置错误。
InternalError.NetworkError 内部网络错误。
InvalidParameter 参数错误。
LimitExceeded.MaximumRunningTask 当前并发任务数超限制。
ResourceNotFound.ForbidService 用户被禁用。
ResourceNotFound.FreezeService 用户服务被冻结。
ResourceNotFound.StopService 账号停服,请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService 用户主动停服。
UnsupportedOperation 操作不支持。