You need to enable JavaScript to run this app.
导航
添加截图配置
最近更新时间:2024.05.29 19:20:22首次发布时间:2024.01.25 17:10:14

调用 CreateSnapshotPresetV2 接口,添加截图配置,当直播流在截图配置生效范围内时,将对直播流进行截图保存。

使用说明

截图配置根据 Vhost 和 App 指定当前配置适用的直播流范围,当直播流使用的域名属于配置的 Vhost,且直播流的 AppName 字段与 App 配置符合时,将对直播流进行截图保存。

注意事项

  • 前提条件:
    • 使用截图功能前,需先为视频直播服务授权跨服务访问角色,请参见跨服务访问授权
    • 截图文件选择存放在 veImageX 中时,请先开通 veImageX 服务,并参考服务管理新建服务获取服务 ID。
    • 截图文件选择存放在 TOS 中时,请先开通 TOS 服务,并联系技术支持授权使用。
  • 计费说明:直播截图为付费功能,费用参考截图计费
  • 请求频率:单用户请求频率限制为 10 次/秒
  • 生效说明:新增、更新、删除截图配置,均需在新增、更新、删除操作后(3-5 分钟)重新进行推流才会使用变更后的配置。

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=CreateSnapshotPresetV2&Version=2023-01-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringCreateSnapshotPresetV2接口名称。当前 API 的名称为 CreateSnapshotPresetV2
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-01

Body

参数类型是否必选示例值描述
VhostStringpush.example.com域名空间,即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面,查看直播流使用的域名所属的域名空间。
AppStringlive应用名称,取值与直播流地址中 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。

Status

Integer

1

截图配置的生效状态,取值及含义如下所示。

  • 1:(默认值)生效;
  • 0:不生效。
SnapshotPresetConfigObject of SnapshotPresetConfig-截图配置的详细参数配置。

SnapshotPresetConfig

参数类型是否必选示例值描述

JpegParam

Object of CDNSnapshotParam

-

图片格式为 JPEG 时的截图参数,开启 JPEG 截图时设置。

说明

JPEG 截图和 JPG 截图必须开启且只能开启一个。

JpgParam

Object of CDNSnapshotParam

-

截图格式为 JPG 时的截图参数,开启 JPG 截图时设置。

说明

JPEG 截图和 JPG 截图必须开启且只能开启一个。

IntervalInteger10截图间隔时间,单位为秒,默认值为 10,取值范围为正整数。

CDNSnapshotParam

参数类型是否必选示例值描述

Enable

Boolean

true

当前格式的截图是否开启,取值及含义如下所示。

  • false:(默认值)不开启;
  • true:开启。

TOSParam

Object of TOSParam

-

截图存储到 TOS 时的配置。

说明

TOSParam 和 ImageXParam 配置且配置其中一个。

ImageXParam

Object of ImageXParam

-

截图存储到 veImageX 时的配置。

说明

TOSParam 和 ImageXParam 配置且配置其中一个。

TOSParam

参数类型是否必选示例值描述

Enable

Boolean

true

截图是否使用 TOS 存储,取值及含义如下所示。

  • false:(默认值)不使用;
  • true:使用。

Bucket

String

live-test-tos-example

TOS 存储对应的 Bucket。
例如,存储路径为 live-test-tos-example/live/liveapp 时,Bucket 取值为 live-test-tos-example

说明

使用 TOS 存储时 Bucket 为必填项。

StorageDir

String

live/liveapp

ToS 存储对应的 Bucket 下的存储目录,默认为空。
例如,存储位置为 live-test-tos-example/live/liveapp 时,StorageDir 取值为 live/liveapp

ExactObject

String

{Domain}/{App}/{Stream}/{UnixTimestamp}

存储方式为实时截图时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。

说明

参数 ExactObject 和 OverwriteObject 传且仅传一个。

OverwriteObject

String

{Domain}/{App}/{Stream}

存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。

说明

参数 ExactObject 和 OverwriteObject 传且仅传一个。

ImageXParam

参数类型是否必选示例值描述

Enable

Boolean

true

截图是否使用 veImageX 存储,取值及含义如下所示。

  • false:(默认值)不使用;
  • true:使用。

ServiceID

String

WMK***UX

使用 veImageX 存储截图时,对应的 veImageX 的服务 ID。

说明

使用 veImageX 存储时 ServiceID 为必填项。

OverwriteObject

String

{Domain}/{App}/{Stream}

存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。

说明

参数 ExactObject 和 OverwriteObject 传且仅传一个。

ExactObject

String

{Domain}/{App}/{Stream}/{UnixTimestamp}

存储方式为实时截图时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。

说明

参数 ExactObject 和 OverwriteObject 传且仅传一个。

返回参数

本接口无特有的返回参数。更多信息请见返回结构

请求示例

POST https://live.volcengineapi.com?Action=CreateSnapshotPresetV2&Version=2023-01-01
{
    "Vhost": "push.example.com",
    "App": "live",
    "Status": 1,
    "SnapshotPresetConfig": {
        "JpegParam": {
            "Enable": true,
            "TOSParam": {
                "Enable": true,
                "Bucket": "live-test-tos-example",
                "StorageDir": " live/liveapp",
                "ExactObject": "{Domain}/{App}/{Stream}/{UnixTimestamp}"
            }
        },
        "Interval": 10
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "CreateSnapshotPresetV2",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试,如果仍返回该错误码,请联系技术支持
400InvalidParam-输入的参数无效或不符合要求,请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验,请检查参数类型是否正确。
403RequestForbidden-请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费,造成账单不可用,请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持
429RequestLimitExceeded.Exist%s already exist请求创建的资源(域名空间、域名、应用、配置模版、证书)已存在。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误,请联系技术支持
500InternalError.Presetan internal error related to preset occurred, please contact the administrator.出现与功能配置相关的内部错误,请联系技术支持
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时,请联系技术支持

服务端 SDK

视频直播提供了配套的开发工具集 SDK,支持多种编程语言,帮助您更方便的调用 API。