You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

截图配置

最近更新时间：2024.04.15 11:37:01

首次发布时间：2023.12.28 21:21:52

我的收藏

阅读本文，您可以获取 Go SDK 截图配置的接口调用示例，实现快速开发。

说明

本文的调用示例包含接口的全部参数。由于参数间可能存在互斥关系，在调用时，请您参考注释，进行调整。

调用说明

  • 本文提供的接口调用示例均通过 AK 和 SK 初始化实例。
  • 接口的参数说明和错误码等信息可通过接口文档或打开 API Explorer 的文档说明页签查看。

前提条件

调用接口前，请先完成 Go SDK 的安装及初始化操作

调用示例

本节为您介绍截图配置相关接口的功能和调用示例。

添加截图配置

您可以调用 CreateSnapshotPresetV2 接口添加截图配置。详细的参数说明可参见 CreateSnapshotPresetV2 接口文档。

接口调用示例如下所示。

package main

import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
   	"github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live_v20230101.NewInstance()

  service.SetCredential(base.Credentials{
    AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
    SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live_v20230101.CreateSnapshotPresetV2Body{}
     
  //域名空间名称。
  body.Vhost = "push.example.com"
    
  //应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。
  body.App = "live"
    
  //截图配置生效状态，默认为生效。
  // <li> 1：生效； </li>
  // <li> 0：不生效。 </li>
  var bodyStatus *int32 

  var bodyStatusValue int32 = 1 

  bodyStatus = &bodyStatusValue 

  body.Status = bodyStatus 
    
  //截图配置的详细参数配置。
  bodySnapshotPresetConfig := live_v20230101.CreateSnapshotPresetV2BodySnapshotPresetConfig{}

  //图片格式为 JPEG 时的截图参数，开启 JPEG 截图时设置。
  // note：
  // JPEG 截图和 JPG 截图必须开启且只能开启一个。
  bodySnapshotPresetConfigJPEGParam := live_v20230101.CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParam{}

  //当前格式的截图是否开启，默认为 false，取值及含义如下所示。
  // <li> false：不开启； </li>
  // <li> true：开启。 </li>
  var bodySnapshotPresetConfigJPEGParamEnable *bool 

  var bodySnapshotPresetConfigJPEGParamEnableValue bool = true 

  bodySnapshotPresetConfigJPEGParamEnable = &bodySnapshotPresetConfigJPEGParamEnableValue 

  bodySnapshotPresetConfigJPEGParam.Enable = bodySnapshotPresetConfigJPEGParamEnable 
    
  //截图存储到 TOS 时的配置。
  // note：
  // TOSParam 和 ImageXParam 配置且配置其中一个。
  bodySnapshotPresetConfigJPEGParamTOSParam := live_v20230101.CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam{}

  //截图是否使用 TOS 存储，默认为 false，取值及含义如下所示。
  // <li> false：不使用； </li>
  // <li> true：使用。 </li>
  var bodySnapshotPresetConfigJPEGParamTOSParamEnable *bool 

  var bodySnapshotPresetConfigJPEGParamTOSParamEnableValue bool = true 

  bodySnapshotPresetConfigJPEGParamTOSParamEnable = &bodySnapshotPresetConfigJPEGParamTOSParamEnableValue 

  bodySnapshotPresetConfigJPEGParamTOSParam.Enable = bodySnapshotPresetConfigJPEGParamTOSParamEnable 
    
  //TOS 存储对应的 Bucket。
  // 例如，存储路径为 live-test-tos-example/live/liveapp 时，Bucket 取值为 live-test-tos-example。
  // note：
  // 使用 TOS 存储时 Bucket 为必填项。
  var bodySnapshotPresetConfigJPEGParamTOSParamBucket *string 

  var bodySnapshotPresetConfigJPEGParamTOSParamBucketValue string = "live-test-tos-example" 

  bodySnapshotPresetConfigJPEGParamTOSParamBucket = &bodySnapshotPresetConfigJPEGParamTOSParamBucketValue 

  bodySnapshotPresetConfigJPEGParamTOSParam.Bucket = bodySnapshotPresetConfigJPEGParamTOSParamBucket 
    
  //ToS 存储对应的 bucket 下的存储目录，默认为空。
  // 例如，存储位置为 live-test-tos-example/live/liveapp 时，StorageDir 取值为 live/liveapp。
  var bodySnapshotPresetConfigJPEGParamTOSParamStorageDir *string 

  var bodySnapshotPresetConfigJPEGParamTOSParamStorageDirValue string = "live/liveapp" 

  bodySnapshotPresetConfigJPEGParamTOSParamStorageDir = &bodySnapshotPresetConfigJPEGParamTOSParamStorageDirValue 

  bodySnapshotPresetConfigJPEGParamTOSParam.StorageDir = bodySnapshotPresetConfigJPEGParamTOSParamStorageDir 
    
  //存储方式为实时截图时的存储规则，支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。
  // note：
  // 参数 ExactObject 和 OverwriteObject 传且仅传一个。
  var bodySnapshotPresetConfigJPEGParamTOSParamExactObject *string 

  var bodySnapshotPresetConfigJPEGParamTOSParamExactObjectValue string = "{Domain}/{App}/{Stream}/{UnixTimestamp}" 

  bodySnapshotPresetConfigJPEGParamTOSParamExactObject = &bodySnapshotPresetConfigJPEGParamTOSParamExactObjectValue 

  bodySnapshotPresetConfigJPEGParamTOSParam.ExactObject = bodySnapshotPresetConfigJPEGParamTOSParamExactObject 
    
  //存储方式为覆盖截图时的存储规则，支持以 {Domain}/{App}/{Stream} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。
  // note：
  // 参数 ExactObject 和 OverwriteObject 传且仅传一个。
  var bodySnapshotPresetConfigJPEGParamTOSParamOverwriteObject *string 

  var bodySnapshotPresetConfigJPEGParamTOSParamOverwriteObjectValue string = "{Domain}/{App}/{Stream}" 

  bodySnapshotPresetConfigJPEGParamTOSParamOverwriteObject = &bodySnapshotPresetConfigJPEGParamTOSParamOverwriteObjectValue 

  bodySnapshotPresetConfigJPEGParamTOSParam.OverwriteObject = bodySnapshotPresetConfigJPEGParamTOSParamOverwriteObject 
    
  
  bodySnapshotPresetConfigJPEGParam.TOSParam = &bodySnapshotPresetConfigJPEGParamTOSParam
     
    
  //截图存储到 veImageX 时的配置。
  // note：
  // TOSParam 和 ImageXParam 配置且配置其中一个。
  bodySnapshotPresetConfigJPEGParamImageXParam := live_v20230101.CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam{}

  //截图是否使用 veImageX 存储，默认为 false，取值及含义如下所示。
  // <li> false：不使用； </li>
  // <li> true：使用。 </li>
  var bodySnapshotPresetConfigJPEGParamImageXParamEnable *bool 

  var bodySnapshotPresetConfigJPEGParamImageXParamEnableValue bool = true 

  bodySnapshotPresetConfigJPEGParamImageXParamEnable = &bodySnapshotPresetConfigJPEGParamImageXParamEnableValue 

  bodySnapshotPresetConfigJPEGParamImageXParam.Enable = bodySnapshotPresetConfigJPEGParamImageXParamEnable 
    
  //使用 veImageX 存储截图时，对应的 veImageX 的服务 ID。
  // note：
  // 使用 veImageX 存储时 ServiceID 为必填项。
  var bodySnapshotPresetConfigJPEGParamImageXParamServiceID *string 

  var bodySnapshotPresetConfigJPEGParamImageXParamServiceIDValue string = "WMK***UX" 

  bodySnapshotPresetConfigJPEGParamImageXParamServiceID = &bodySnapshotPresetConfigJPEGParamImageXParamServiceIDValue 

  bodySnapshotPresetConfigJPEGParamImageXParam.ServiceID = bodySnapshotPresetConfigJPEGParamImageXParamServiceID 
    
  //存储方式为覆盖截图时的存储规则，支持以 {Domain}/{App}/{Stream} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。
  // note：
  // 参数 ExactObject 和 OverwriteObject 传且仅传一个。
  var bodySnapshotPresetConfigJPEGParamImageXParamOverwriteObject *string 

  var bodySnapshotPresetConfigJPEGParamImageXParamOverwriteObjectValue string = "{Domain}/{App}/{Stream}" 

  bodySnapshotPresetConfigJPEGParamImageXParamOverwriteObject = &bodySnapshotPresetConfigJPEGParamImageXParamOverwriteObjectValue 

  bodySnapshotPresetConfigJPEGParamImageXParam.OverwriteObject = bodySnapshotPresetConfigJPEGParamImageXParamOverwriteObject 
    
  //存储方式为实时截图时的存储规则，支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。
  // note：
  // 参数 ExactObject 和 OverwriteObject 传且仅传一个。
  var bodySnapshotPresetConfigJPEGParamImageXParamExactObject *string 

  var bodySnapshotPresetConfigJPEGParamImageXParamExactObjectValue string = "{Domain}/{App}/{Stream}/{UnixTimestamp}" 

  bodySnapshotPresetConfigJPEGParamImageXParamExactObject = &bodySnapshotPresetConfigJPEGParamImageXParamExactObjectValue 

  bodySnapshotPresetConfigJPEGParamImageXParam.ExactObject = bodySnapshotPresetConfigJPEGParamImageXParamExactObject 
    
  
  bodySnapshotPresetConfigJPEGParam.ImageXParam = &bodySnapshotPresetConfigJPEGParamImageXParam
     
    
  
  bodySnapshotPresetConfig.JPEGParam = &bodySnapshotPresetConfigJPEGParam
     
    
  //截图间隔时间，单位为秒，默认值为 10，取值范围为正整数。
  var bodySnapshotPresetConfigInterval *int32 

  var bodySnapshotPresetConfigIntervalValue int32 = 10 

  bodySnapshotPresetConfigInterval = &bodySnapshotPresetConfigIntervalValue 

  bodySnapshotPresetConfig.Interval = bodySnapshotPresetConfigInterval 
    
  //截图格式为 JPG 时的截图参数，开启 JPG 截图时设置。
  // note：
  // JPEG 截图和 JPG 截图必须开启且只能开启一个。
  bodySnapshotPresetConfigJpgParam := live_v20230101.CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParam{}

  //当前格式的截图是否开启，默认为 false，取值及含义如下所示。
  // <li> false：不开启； </li>
  // <li> true：开启。 </li>
  var bodySnapshotPresetConfigJpgParamEnable *bool 

  var bodySnapshotPresetConfigJpgParamEnableValue bool = true 

  bodySnapshotPresetConfigJpgParamEnable = &bodySnapshotPresetConfigJpgParamEnableValue 

  bodySnapshotPresetConfigJpgParam.Enable = bodySnapshotPresetConfigJpgParamEnable 
    
  //截图存储到 TOS 时的配置。
  // note：
  // TOSParam 和 ImageXParam 配置且配置其中一个。
  bodySnapshotPresetConfigJpgParamTOSParam := live_v20230101.CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam{}

  //截图是否使用 TOS 存储，默认为 false，取值及含义如下所示。
  // <li> false：不使用； </li>
  // <li> true：使用。 </li>
  var bodySnapshotPresetConfigJpgParamTOSParamEnable *bool 

  var bodySnapshotPresetConfigJpgParamTOSParamEnableValue bool = true 

  bodySnapshotPresetConfigJpgParamTOSParamEnable = &bodySnapshotPresetConfigJpgParamTOSParamEnableValue 

  bodySnapshotPresetConfigJpgParamTOSParam.Enable = bodySnapshotPresetConfigJpgParamTOSParamEnable 
    
  //TOS 存储对应的 Bucket。
  // 例如，存储路径为 live-test-tos-example/live/liveapp 时，Bucket 取值为 live-test-tos-example。
  // note：
  // 使用 TOS 存储时 Bucket 为必填项。
  var bodySnapshotPresetConfigJpgParamTOSParamBucket *string 

  var bodySnapshotPresetConfigJpgParamTOSParamBucketValue string = "live-test-tos-example" 

  bodySnapshotPresetConfigJpgParamTOSParamBucket = &bodySnapshotPresetConfigJpgParamTOSParamBucketValue 

  bodySnapshotPresetConfigJpgParamTOSParam.Bucket = bodySnapshotPresetConfigJpgParamTOSParamBucket 
    
  //ToS 存储对应的 bucket 下的存储目录，默认为空。
  // 例如，存储位置为 live-test-tos-example/live/liveapp 时，StorageDir 取值为 live/liveapp。
  var bodySnapshotPresetConfigJpgParamTOSParamStorageDir *string 

  var bodySnapshotPresetConfigJpgParamTOSParamStorageDirValue string = "live/liveapp" 

  bodySnapshotPresetConfigJpgParamTOSParamStorageDir = &bodySnapshotPresetConfigJpgParamTOSParamStorageDirValue 

  bodySnapshotPresetConfigJpgParamTOSParam.StorageDir = bodySnapshotPresetConfigJpgParamTOSParamStorageDir 
    
  //存储方式为实时截图时的存储规则，支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。
  // note：
  // 参数 ExactObject 和 OverwriteObject 传且仅传一个。
  var bodySnapshotPresetConfigJpgParamTOSParamExactObject *string 

  var bodySnapshotPresetConfigJpgParamTOSParamExactObjectValue string = "{Domain}/{App}/{Stream}/{UnixTimestamp}" 

  bodySnapshotPresetConfigJpgParamTOSParamExactObject = &bodySnapshotPresetConfigJpgParamTOSParamExactObjectValue 

  bodySnapshotPresetConfigJpgParamTOSParam.ExactObject = bodySnapshotPresetConfigJpgParamTOSParamExactObject 
    
  //存储方式为覆盖截图时的存储规则，支持以 {Domain}/{App}/{Stream} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。
  // note：
  // 参数 ExactObject 和 OverwriteObject 传且仅传一个。
  var bodySnapshotPresetConfigJpgParamTOSParamOverwriteObject *string 

  var bodySnapshotPresetConfigJpgParamTOSParamOverwriteObjectValue string = "{Domain}/{App}/{Stream}" 

  bodySnapshotPresetConfigJpgParamTOSParamOverwriteObject = &bodySnapshotPresetConfigJpgParamTOSParamOverwriteObjectValue 

  bodySnapshotPresetConfigJpgParamTOSParam.OverwriteObject = bodySnapshotPresetConfigJpgParamTOSParamOverwriteObject 
    
  
  bodySnapshotPresetConfigJpgParam.TOSParam = &bodySnapshotPresetConfigJpgParamTOSParam
     
    
  //截图存储到 veImageX 时的配置。
  // note：
  // TOSParam 和 ImageXParam 配置且配置其中一个。
  bodySnapshotPresetConfigJpgParamImageXParam := live_v20230101.CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam{}

  //截图是否使用 veImageX 存储，默认为 false，取值及含义如下所示。
  // <li> false：不使用； </li>
  // <li> true：使用。 </li>
  var bodySnapshotPresetConfigJpgParamImageXParamEnable *bool 

  var bodySnapshotPresetConfigJpgParamImageXParamEnableValue bool = true 

  bodySnapshotPresetConfigJpgParamImageXParamEnable = &bodySnapshotPresetConfigJpgParamImageXParamEnableValue 

  bodySnapshotPresetConfigJpgParamImageXParam.Enable = bodySnapshotPresetConfigJpgParamImageXParamEnable 
    
  //使用 veImageX 存储截图时，对应的 veImageX 的服务 ID。
  // note：
  // 使用 veImageX 存储时 ServiceID 为必填项。
  var bodySnapshotPresetConfigJpgParamImageXParamServiceID *string 

  var bodySnapshotPresetConfigJpgParamImageXParamServiceIDValue string = "WMK***UX" 

  bodySnapshotPresetConfigJpgParamImageXParamServiceID = &bodySnapshotPresetConfigJpgParamImageXParamServiceIDValue 

  bodySnapshotPresetConfigJpgParamImageXParam.ServiceID = bodySnapshotPresetConfigJpgParamImageXParamServiceID 
    
  //存储方式为覆盖截图时的存储规则，支持以 {Domain}/{App}/{Stream} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。
  // note：
  // 参数 ExactObject 和 OverwriteObject 传且仅传一个。
  var bodySnapshotPresetConfigJpgParamImageXParamOverwriteObject *string 

  var bodySnapshotPresetConfigJpgParamImageXParamOverwriteObjectValue string = "{Domain}/{App}/{Stream}" 

  bodySnapshotPresetConfigJpgParamImageXParamOverwriteObject = &bodySnapshotPresetConfigJpgParamImageXParamOverwriteObjectValue 

  bodySnapshotPresetConfigJpgParamImageXParam.OverwriteObject = bodySnapshotPresetConfigJpgParamImageXParamOverwriteObject 
    
  //存储方式为实时截图时的存储规则，支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。
  // note：
  // 参数 ExactObject 和 OverwriteObject 传且仅传一个。
  var bodySnapshotPresetConfigJpgParamImageXParamExactObject *string 

  var bodySnapshotPresetConfigJpgParamImageXParamExactObjectValue string = "{Domain}/{App}/{Stream}/{UnixTimestamp}" 

  bodySnapshotPresetConfigJpgParamImageXParamExactObject = &bodySnapshotPresetConfigJpgParamImageXParamExactObjectValue 

  bodySnapshotPresetConfigJpgParamImageXParam.ExactObject = bodySnapshotPresetConfigJpgParamImageXParamExactObject 
    
  
  bodySnapshotPresetConfigJpgParam.ImageXParam = &bodySnapshotPresetConfigJpgParamImageXParam
     
    
  
  bodySnapshotPresetConfig.JpgParam = &bodySnapshotPresetConfigJpgParam
     
    
  
  body.SnapshotPresetConfig = bodySnapshotPresetConfig
  
  resp, err := service.CreateSnapshotPresetV2(context.Background(), body)

  if err != nil {
    fmt.Printf("error %v", err)
  } else {
    fmt.Printf("success %+v", resp)
  }
}

更新截图配置

您可以调用 UpdateSnapshotPresetV2 接口更新截图配置。详细的参数说明可参见 UpdateSnapshotPresetV2 接口文档。

接口调用示例如下所示。

package main

import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
   	"github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live_v20230101.NewInstance()

  service.SetCredential(base.Credentials{
    AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
    SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live_v20230101.UpdateSnapshotPresetV2Body{}
     
  //域名空间名称。
  body.Vhost = "push.example.com"
    
  //截图配置的名称。
  body.Preset = "preset-123"
    
  //应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。
  body.App = "live"
    
  //截图配置生效状态，默认为生效。
  // <li> 1：生效； </li>
  // <li> 0：不生效。 </li>
  var bodyStatus *int32 

  var bodyStatusValue int32 = 1 

  bodyStatus = &bodyStatusValue 

  body.Status = bodyStatus 
    
  //截图配置的详细参数配置。
  bodySnapshotPresetConfig := live_v20230101.UpdateSnapshotPresetV2BodySnapshotPresetConfig{}

  //图片格式为 JPEG 时的截图参数，开启 JPEG 截图时设置。
  // note：
  // JPEG 截图和 JPG 截图必须开启且只能开启一个。
  bodySnapshotPresetConfigJPEGParam := live_v20230101.UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParam{}

  //当前格式的截图配置是否开启，默认为 false，取值及含义如下所示。
  // <li> false：不开启； </li>
  // <li> true：开启。 </li>
  var bodySnapshotPresetConfigJPEGParamEnable *bool 

  var bodySnapshotPresetConfigJPEGParamEnableValue bool = true 

  bodySnapshotPresetConfigJPEGParamEnable = &bodySnapshotPresetConfigJPEGParamEnableValue 

  bodySnapshotPresetConfigJPEGParam.Enable = bodySnapshotPresetConfigJPEGParamEnable 
    
  //截图存储到 TOS 时的配置。
  // note：
  // TOSParam 和 ImageXParam 配置且配置其中一个。
  bodySnapshotPresetConfigJPEGParamTOSParam := live_v20230101.UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam{}

  //截图是否使用 TOS 存储，默认为 false，取值及含义如下所示。
  // <li> false：不使用； </li>
  // <li> true：使用。 </li>
  var bodySnapshotPresetConfigJPEGParamTOSParamEnable *bool 

  var bodySnapshotPresetConfigJPEGParamTOSParamEnableValue bool = true 

  bodySnapshotPresetConfigJPEGParamTOSParamEnable = &bodySnapshotPresetConfigJPEGParamTOSParamEnableValue 

  bodySnapshotPresetConfigJPEGParamTOSParam.Enable = bodySnapshotPresetConfigJPEGParamTOSParamEnable 
    
  //TOS 存储对应的 Bucket。
  // 例如，存储路径为 live-test-tos-example/live/liveapp 时，Bucket 取值为 live-test-tos-example。
  // note：
  // 使用 TOS 存储时 Bucket 为必填项。
  var bodySnapshotPresetConfigJPEGParamTOSParamBucket *string 

  var bodySnapshotPresetConfigJPEGParamTOSParamBucketValue string = "live-test-tos-example" 

  bodySnapshotPresetConfigJPEGParamTOSParamBucket = &bodySnapshotPresetConfigJPEGParamTOSParamBucketValue 

  bodySnapshotPresetConfigJPEGParamTOSParam.Bucket = bodySnapshotPresetConfigJPEGParamTOSParamBucket 
    
  //Bucket 目录，默认为空。
  // 例如，存储路径为 live-test-tos-example/live/liveapp 时，StorageDir 取值为 live/liveapp。
  var bodySnapshotPresetConfigJPEGParamTOSParamStorageDir *string 

  var bodySnapshotPresetConfigJPEGParamTOSParamStorageDirValue string = "live/liveapp" 

  bodySnapshotPresetConfigJPEGParamTOSParamStorageDir = &bodySnapshotPresetConfigJPEGParamTOSParamStorageDirValue 

  bodySnapshotPresetConfigJPEGParamTOSParam.StorageDir = bodySnapshotPresetConfigJPEGParamTOSParamStorageDir 
    
  //存储方式为实时存储时的存储规则，支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。
  // note：
  // 参数 ExactObject 和 OverwriteObject 传且仅传一个。
  var bodySnapshotPresetConfigJPEGParamTOSParamExactObject *string 

  var bodySnapshotPresetConfigJPEGParamTOSParamExactObjectValue string = "{Domain}/{App}/{Stream}/{UnixTimestamp}" 

  bodySnapshotPresetConfigJPEGParamTOSParamExactObject = &bodySnapshotPresetConfigJPEGParamTOSParamExactObjectValue 

  bodySnapshotPresetConfigJPEGParamTOSParam.ExactObject = bodySnapshotPresetConfigJPEGParamTOSParamExactObject 
    
  //存储方式为覆盖截图时的存储规则，支持以 {Domain}/{App}/{Stream} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。
  // note：
  // 参数 ExactObject 和 OverwriteObject 传且仅传一个。
  var bodySnapshotPresetConfigJPEGParamTOSParamOverwriteObject *string 

  var bodySnapshotPresetConfigJPEGParamTOSParamOverwriteObjectValue string = "{Domain}/{App}/{Stream}" 

  bodySnapshotPresetConfigJPEGParamTOSParamOverwriteObject = &bodySnapshotPresetConfigJPEGParamTOSParamOverwriteObjectValue 

  bodySnapshotPresetConfigJPEGParamTOSParam.OverwriteObject = bodySnapshotPresetConfigJPEGParamTOSParamOverwriteObject 
    
  
  bodySnapshotPresetConfigJPEGParam.TOSParam = &bodySnapshotPresetConfigJPEGParamTOSParam
     
    
  //截图存储到 veImageX 时的配置。
  // note：
  // TOSParam 和 ImageXParam 配置且配置其中一个。
  bodySnapshotPresetConfigJPEGParamImageXParam := live_v20230101.UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam{}

  //截图是否使用 veImageX 存储，默认为 false，取值及含义如下所示。
  // <li> false：不使用； </li>
  // <li> true：使用。 </li>
  var bodySnapshotPresetConfigJPEGParamImageXParamEnable *bool 

  var bodySnapshotPresetConfigJPEGParamImageXParamEnableValue bool = true 

  bodySnapshotPresetConfigJPEGParamImageXParamEnable = &bodySnapshotPresetConfigJPEGParamImageXParamEnableValue 

  bodySnapshotPresetConfigJPEGParamImageXParam.Enable = bodySnapshotPresetConfigJPEGParamImageXParamEnable 
    
  //使用 veImageX 存储截图时，对应的 veImageX 的服务 ID。
  // note：
  // 使用 veImageX 存储时 ServiceID 为必填项。
  var bodySnapshotPresetConfigJPEGParamImageXParamServiceID *string 

  var bodySnapshotPresetConfigJPEGParamImageXParamServiceIDValue string = "WMK***UX" 

  bodySnapshotPresetConfigJPEGParamImageXParamServiceID = &bodySnapshotPresetConfigJPEGParamImageXParamServiceIDValue 

  bodySnapshotPresetConfigJPEGParamImageXParam.ServiceID = bodySnapshotPresetConfigJPEGParamImageXParamServiceID 
    
  //存储方式为覆盖截图时的存储规则，支持以 {Domain}/{App}/{Stream} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。
  // note：
  // 参数 ExactObject 和 OverwriteObject 传且仅传一个。
  var bodySnapshotPresetConfigJPEGParamImageXParamOverwriteObject *string 

  var bodySnapshotPresetConfigJPEGParamImageXParamOverwriteObjectValue string = "{Domain}/{App}/{Stream}" 

  bodySnapshotPresetConfigJPEGParamImageXParamOverwriteObject = &bodySnapshotPresetConfigJPEGParamImageXParamOverwriteObjectValue 

  bodySnapshotPresetConfigJPEGParamImageXParam.OverwriteObject = bodySnapshotPresetConfigJPEGParamImageXParamOverwriteObject 
    
  //存储方式为实时存储时的存储规则，支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则，支持输入字母、数字、-、!、_、.、*" 及占位符。
  // note：
  // 参数 ExactObject 和 OverwriteObject 传且仅传一个。
  var bodySnapshotPresetConfigJPEGParamImageXParamExactObject *string 

  var bodySnapshotPresetConfigJPEGParamImageXParamExactObjectValue string = "{Domain}/{App}/{Stream}/{UnixTimestamp}" 

  bodySnapshotPresetConfigJPEGParamImageXParamExactObject = &bodySnapshotPresetConfigJPEGParamImageXParamExactObjectValue 

  bodySnapshotPresetConfigJPEGParamImageXParam.ExactObject = bodySnapshotPresetConfigJPEGParamImageXParamExactObject 
    
  
  bodySnapshotPresetConfigJPEGParam.ImageXParam = &bodySnapshotPresetConfigJPEGParamImageXParam
     
    
  
  bodySnapshotPresetConfig.JPEGParam = &bodySnapshotPresetConfigJPEGParam
     
    
  //截图间隔时间，单位为秒，默认值为 10，取值范围为正整数。
  var bodySnapshotPresetConfigInterval *int32 

  var bodySnapshotPresetConfigIntervalValue int32 = 10 

  bodySnapshotPresetConfigInterval = &bodySnapshotPresetConfigIntervalValue 

  bodySnapshotPresetConfig.Interval = bodySnapshotPresetConfigInterval 
    
  //截图格式为 JPG 时的截图参数，开启 JPG 截图时设置。
  // note：
  // JPEG 截图和 JPG 截图必须开启且只能开启一个。
  bodySnapshotPresetConfigJpgParam := live_v20230101.UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParam{}

  //当前格式的截图配置是否开启，默认为 false，取值及含义如下所示。
  // <li> false：不开启； </li>
  // <li> true：开启。 </li>
  var bodySnapshotPresetConfigJpgParamEnable *bool 

  var bodySnapshotPresetConfigJpgParamEnableValue bool = true 

  bodySnapshotPresetConfigJpgParamEnable = &bodySnapshotPresetConfigJpgParamEnableValue 

  bodySnapshotPresetConfigJpgParam.Enable = bodySnapshotPresetConfigJpgParamEnable 
    
  //截图存储到 TOS 时的配置。
  // note：
  // TOSParam 和 ImageXParam 配置且配置其中一个。
  bodySnapshotPresetConfigJpgParamTOSParam := live_v20230101.UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam{}

  //截图是否使用 TOS 存储，默认为 false，取值及含义如下所示。
  // <li> false：不使用； </li>
  // <li> true：使用。 </li>
  var bodySnapshotPresetConfigJpgParamTOSParamEnable *bool 

  var bodySnapshotPresetConfigJpgParamTOSParamEnableValue bool = true 

  bodySnapshotPresetConfigJpgParamTOSParamEnable = &bodySnapshotPresetConfigJpgParamTOSParamEnableValue 

  bodySnapshotPresetConfigJpgParamTOSParam.Enable = bodySnapshotPresetConfigJpgParamTOSParamEnable 
    
  //TOS 存储对应的 Bucket。
  // 例如，存储路径为 live-test-tos-example/live/liveapp 时，Bucket 取值为 live-test-tos-example。
  // note：
  // 使用 TOS 存储时 Bucket 为必填项。
  var bodySnapshotPresetConfigJpgParamTOSParamBucket *string 

  var bodySnapshotPresetConfigJpgParamTOSParamBucketValue string = "live-test-tos-example" 

  bodySnapshotPresetConfigJpgParamTOSParamBucket = &bodySnapshotPresetConfigJpgParamTOSParamBucketValue 

  bodySnapshotPresetConfigJpgParamTOSParam.Bucket = bodySnapshotPresetConfigJpgParamTOSParamBucket 
    
  //Bucket 目录，默认为空。
  // 例如，存储路径为 live-test-tos-example/live/liveapp 时，StorageDir 取值为 live/liveapp。
  var bodySnapshotPresetConfigJpgParamTOSParamStorageDir *string 

  var bodySnapshotPresetConfigJpgParamTOSParamStorageDirValue string = "live/liveapp" 

  bodySnapshotPresetConfigJpgParamTOSParamStorageDir = &bodySnapshotPresetConfigJpgParamTOSParamStorageDirValue 

  bodySnapshotPresetConfigJpgParamTOSParam.StorageDir = bodySnapshotPresetConfigJpgParamTOSParamStorageDir 
    
  //存储方式为实时存储时的存储规则，支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。
  // note：
  // 参数 ExactObject 和 OverwriteObject 传且仅传一个。
  var bodySnapshotPresetConfigJpgParamTOSParamExactObject *string 

  var bodySnapshotPresetConfigJpgParamTOSParamExactObjectValue string = "{Domain}/{App}/{Stream}/{UnixTimestamp}" 

  bodySnapshotPresetConfigJpgParamTOSParamExactObject = &bodySnapshotPresetConfigJpgParamTOSParamExactObjectValue 

  bodySnapshotPresetConfigJpgParamTOSParam.ExactObject = bodySnapshotPresetConfigJpgParamTOSParamExactObject 
    
  //存储方式为覆盖截图时的存储规则，支持以 {Domain}/{App}/{Stream} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。
  // note：
  // 参数 ExactObject 和 OverwriteObject 传且仅传一个。
  var bodySnapshotPresetConfigJpgParamTOSParamOverwriteObject *string 

  var bodySnapshotPresetConfigJpgParamTOSParamOverwriteObjectValue string = "{Domain}/{App}/{Stream}" 

  bodySnapshotPresetConfigJpgParamTOSParamOverwriteObject = &bodySnapshotPresetConfigJpgParamTOSParamOverwriteObjectValue 

  bodySnapshotPresetConfigJpgParamTOSParam.OverwriteObject = bodySnapshotPresetConfigJpgParamTOSParamOverwriteObject 
    
  
  bodySnapshotPresetConfigJpgParam.TOSParam = &bodySnapshotPresetConfigJpgParamTOSParam
     
    
  //截图存储到 veImageX 时的配置。
  // note：
  // TOSParam 和 ImageXParam 配置且配置其中一个。
  bodySnapshotPresetConfigJpgParamImageXParam := live_v20230101.UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam{}

  //截图是否使用 veImageX 存储，默认为 false，取值及含义如下所示。
  // <li> false：不使用； </li>
  // <li> true：使用。 </li>
  var bodySnapshotPresetConfigJpgParamImageXParamEnable *bool 

  var bodySnapshotPresetConfigJpgParamImageXParamEnableValue bool = true 

  bodySnapshotPresetConfigJpgParamImageXParamEnable = &bodySnapshotPresetConfigJpgParamImageXParamEnableValue 

  bodySnapshotPresetConfigJpgParamImageXParam.Enable = bodySnapshotPresetConfigJpgParamImageXParamEnable 
    
  //使用 veImageX 存储截图时，对应的 veImageX 的服务 ID。
  // note：
  // 使用 veImageX 存储时 ServiceID 为必填项。
  var bodySnapshotPresetConfigJpgParamImageXParamServiceID *string 

  var bodySnapshotPresetConfigJpgParamImageXParamServiceIDValue string = "WMK***UX" 

  bodySnapshotPresetConfigJpgParamImageXParamServiceID = &bodySnapshotPresetConfigJpgParamImageXParamServiceIDValue 

  bodySnapshotPresetConfigJpgParamImageXParam.ServiceID = bodySnapshotPresetConfigJpgParamImageXParamServiceID 
    
  //存储方式为覆盖截图时的存储规则，支持以 {Domain}/{App}/{Stream} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符。
  // note：
  // 参数 ExactObject 和 OverwriteObject 传且仅传一个。
  var bodySnapshotPresetConfigJpgParamImageXParamOverwriteObject *string 

  var bodySnapshotPresetConfigJpgParamImageXParamOverwriteObjectValue string = "{Domain}/{App}/{Stream}" 

  bodySnapshotPresetConfigJpgParamImageXParamOverwriteObject = &bodySnapshotPresetConfigJpgParamImageXParamOverwriteObjectValue 

  bodySnapshotPresetConfigJpgParamImageXParam.OverwriteObject = bodySnapshotPresetConfigJpgParamImageXParamOverwriteObject 
    
  //存储方式为实时存储时的存储规则，支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则，支持输入字母、数字、-、!、_、.、*" 及占位符。
  // note：
  // 参数 ExactObject 和 OverwriteObject 传且仅传一个。
  var bodySnapshotPresetConfigJpgParamImageXParamExactObject *string 

  var bodySnapshotPresetConfigJpgParamImageXParamExactObjectValue string = "{Domain}/{App}/{Stream}/{UnixTimestamp}" 

  bodySnapshotPresetConfigJpgParamImageXParamExactObject = &bodySnapshotPresetConfigJpgParamImageXParamExactObjectValue 

  bodySnapshotPresetConfigJpgParamImageXParam.ExactObject = bodySnapshotPresetConfigJpgParamImageXParamExactObject 
    
  
  bodySnapshotPresetConfigJpgParam.ImageXParam = &bodySnapshotPresetConfigJpgParamImageXParam
     
    
  
  bodySnapshotPresetConfig.JpgParam = &bodySnapshotPresetConfigJpgParam
     
    
  
  body.SnapshotPresetConfig = bodySnapshotPresetConfig
  
  resp, err := service.UpdateSnapshotPresetV2(context.Background(), body)

  if err != nil {
    fmt.Printf("error %v", err)
  } else {
    fmt.Printf("success %+v", resp)
  }
}

查询截图配置列表

您可以调用 ListVhostSnapshotPresetV2 接口查询截图配置列表。详细的参数说明可参见 ListVhostSnapshotPresetV2 接口文档。

接口调用示例如下所示。

package main

import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
   	"github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live_v20230101.NewInstance()

  service.SetCredential(base.Credentials{
    AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
    SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live_v20230101.ListVhostSnapshotPresetV2Body{}
     
  //域名空间名称。
  body.Vhost = "push.example.com"
    
  //截图配置中截图文件的存储位置，缺省情况下表示不对存储位置进行过滤，取值及含义如下所示。
  // <li> tos：TOS 对象存储服务； </li>
  // <li> imageX：veImageX 图片服务。 </li>
  var bodyType *string 

  var bodyTypeValue string = "tos" 

  bodyType = &bodyTypeValue 

  body.Type = bodyType
  
  resp, err := service.ListVhostSnapshotPresetV2(context.Background(), body)

  if err != nil {
    fmt.Printf("error %v", err)
  } else {
    fmt.Printf("success %+v", resp)
  }
}

删除截图配置

您可以调用 DeleteSnapshotPreset 接口删除截图配置。详细的参数说明可参见 DeleteSnapshotPreset 接口文档。

接口调用示例如下所示。

package main

import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
   	"github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live_v20230101.NewInstance()

  service.SetCredential(base.Credentials{
    AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
    SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live_v20230101.DeleteSnapshotPresetBody{}
     
  //应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。
  var bodyApp *string 

  var bodyAppValue string = "live" 

  bodyApp = &bodyAppValue 

  body.App = bodyApp 
    
  //截图配置名称。
  body.Preset = "preset-123"
    
  //域名空间名称。
  var bodyVhost *string 

  var bodyVhostValue string = "push.example.com" 

  bodyVhost = &bodyVhostValue 

  body.Vhost = bodyVhost
  
  resp, err := service.DeleteSnapshotPreset(context.Background(), body)

  if err != nil {
    fmt.Printf("error %v", err)
  } else {
    fmt.Printf("success %+v", resp)
  }
}

查询截图历史详情

您可以调用 DescribeCDNSnapshotHistory 接口查询截图历史详情。详细的参数说明可参见 DescribeCDNSnapshotHistory 接口文档。

接口调用示例如下所示。

package main

import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
   	"github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live_v20230101.NewInstance()

  service.SetCredential(base.Credentials{
    AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
    SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live_v20230101.DescribeCDNSnapshotHistoryBody{}
     
  //域名空间名称，由 1 到 60 位数字、字母、下划线及"-"和"."组成。
  body.Vhost = "push.example.com"
    
  //应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。
  body.App = "live"
    
  //流名称，由 1 到 100 位数字、字母、下划线及"-"和"."组成。
  body.Stream = "stream-123"
    
  //查询的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
  // note：
  // <li> 当您查询指定截图任务详情时，DateFrom 应设置为推流开始时间之前的任意时间。 </li>
  // <li> 查询的最大时间跨度为 7 天。 </li>
  body.DateFrom = "2022-04-01T00:00:00+08:00"
    
  //查询的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
  body.DateTo = "2022-04-02T00:00:00+08:00"
    
  //查询数据的页码，默认为 1，表示查询第一页的数据。
  var bodyPageNum *int32 

  var bodyPageNumValue int32 = 1 

  bodyPageNum = &bodyPageNumValue 

  body.PageNum = bodyPageNum 
    
  //每页显示的数据条数，默认为 10，最大值为 1000。
  var bodyPageSize *int32 

  var bodyPageSizeValue int32 = 30 

  bodyPageSize = &bodyPageSizeValue 

  body.PageSize = bodyPageSize 
    
  //截图文件保存位置，默认取值为 tos。
  // * tos：TOS 对象存储服务；
  // * imageX：veImageX 图片服务。
  var bodyType *string 

  var bodyTypeValue string = "tos" 

  bodyType = &bodyTypeValue 

  body.Type = bodyType
  
  resp, err := service.DescribeCDNSnapshotHistory(context.Background(), body)

  if err != nil {
    fmt.Printf("error %v", err)
  } else {
    fmt.Printf("success %+v", resp)
  }
}