文档中心

截图审核

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

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

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

说明

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

调用说明

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

前提条件

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

调用示例

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

添加截图审核配置

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

接口调用示例如下所示。

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.CreateSnapshotAuditPresetBody{}
     
  //域名空间名称。
  // note：
  // 参数 `Domain` 和 `Vhost` 传且仅传一个。
  var bodyVhost *string 

  var bodyVhostValue string = "push.example.com" 

  bodyVhost = &bodyVhostValue 

  body.Vhost = bodyVhost 
    
  //推流域名。
  // note：
  // 参数 `Domain` 和 `Vhost` 传且仅传一个。
  var bodyDomain *string 

  var bodyDomainValue string = "push.example.com" 

  bodyDomain = &bodyDomainValue 

  body.Domain = bodyDomain 
    
  //应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。
  body.App = "live"
    
  //截图间隔时间，单位为秒，取值范围为 [0.1,10]，支持保留两位小数。
  body.Interval = 2
    
  //TOS 存储对应的 Bucket。
  // 例如，存储路径为 live-test-tos-example/live/liveapp 时，Bucket 取值为 live-test-tos-example。
  // note：
  // 参数 `Bucket` 和 `ServiceID` 传且仅传一个。
  var bodyBucket *string 

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

  bodyBucket = &bodyBucketValue 

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

  var bodyStorageDirValue string = "live/liveapp" 

  bodyStorageDir = &bodyStorageDirValue 

  body.StorageDir = bodyStorageDir 
    
  //veImageX 的服务 ID。
  // note：
  // 参数 `Bucket` 和 `ServiceID` 传且仅传一个。
  var bodyServiceID *string 

  var bodyServiceIDValue string = "WMK***UXe" 

  bodyServiceID = &bodyServiceIDValue 

  body.ServiceID = bodyServiceID 
    
  //截图审核配置的描述。
  var bodyDescription *string 

  var bodyDescriptionValue string = "常用审核配置" 

  bodyDescription = &bodyDescriptionValue 

  body.Description = bodyDescription 
    
  //存储策略，支持的取值及含义如下。
  // <li> 0：触发存储，只存储有风险图片； </li>
  // <li> 1：全部存储，存储所有图片。 </li>
  body.StorageStrategy = 0
    
  //审核标签，缺省情况下取值为 301、302、303、305 和 306，支持的取值及含义如下。
  // <li> 301：涉黄； </li>
  // <li> 302：涉敏1； </li>
  // <li> 303：涉敏2； </li>
  // <li> 304：广告； </li>
  // <li> 305：引人不适； </li>
  // <li> 306：违禁； </li>
  // <li> 307：二维码； </li>
  // <li> 308：诈骗； </li>
  // <li> 309：不良画面； </li>
  // <li> 310：未成年相关； </li>
  // <li> 320：文字违规。 </li>
  bodyLabel := []*string{}

  var bodyLabel0 *string 

  var bodyLabel0Value string  = "301" 

  bodyLabel0 = &bodyLabel0Value 

  bodyLabel = append(bodyLabel, bodyLabel0)    

   var bodyLabel1 *string 

  var bodyLabel1Value string  = "302" 

  bodyLabel1 = &bodyLabel1Value 

  bodyLabel = append(bodyLabel, bodyLabel1)    

  body.Label = bodyLabel
    
  //截图存储规则，支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符，最大长度为 180 个字符，默认值为 {audit}/{PushDomain}/{App}/{Stream}/{UnixTimestamp}。
  var bodySnapshotObject *string 

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

  bodySnapshotObject = &bodySnapshotObjectValue 

  body.SnapshotObject = bodySnapshotObject
  
  resp, err := service.CreateSnapshotAuditPreset(context.Background(), body)

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

删除截图审核配置

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

接口调用示例如下所示。

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.DeleteSnapshotAuditPresetBody{}
     
  //域名空间名称。
  body.Vhost = "push.example.com"
    
  //应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。
  body.App = "live"
    
  //截图审核配置的名称。
  body.PresetName = "preset-123"
  
  resp, err := service.DeleteSnapshotAuditPreset(context.Background(), body)

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

更新截图审核配置

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

接口调用示例如下所示。

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.UpdateSnapshotAuditPresetBody{}
     
  //域名空间名称。
  // note：
  // 参数 `Domain` 和 `Vhost` 传且仅传一个。
  var bodyVhost *string 

  var bodyVhostValue string = "push.example.com" 

  bodyVhost = &bodyVhostValue 

  body.Vhost = bodyVhost 
    
  //推流域名。
  // note：
  // 参数 `Domain` 和 `Vhost` 传且仅传一个。
  var bodyDomain *string 

  var bodyDomainValue string = "push.example.com" 

  bodyDomain = &bodyDomainValue 

  body.Domain = bodyDomain 
    
  //应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。
  body.App = "live"
    
  //截图间隔时间，单位秒，取值范围为[0.1,10]，支持保留两位小数。
  var bodyInterval *float32 

  var bodyIntervalValue float32 = 10 

  bodyInterval = &bodyIntervalValue 

  body.Interval = bodyInterval 
    
  //截图审核配置的名称，您可以通过调用[查询截图审核配置列表](https://www.volcengine.com/docs/6469/1126870)接口获取。
  body.PresetName = "preset-123"
    
  //ToS 存储对应的 Bucket。
  // note：
  // 参数 `Bucket` 和 `ServiceID` 传且仅传一个。
  var bodyBucket *string 

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

  bodyBucket = &bodyBucketValue 

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

  var bodyStorageDirValue string = "live/liveapp" 

  bodyStorageDir = &bodyStorageDirValue 

  body.StorageDir = bodyStorageDir 
    
  //veimageX 的服务 ID。
  // note：
  // 参数 `Bucket` 和 `ServiceID` 传且仅传一个。
  var bodyServiceID *string 

  var bodyServiceIDValue string = "WMK***UXe" 

  bodyServiceID = &bodyServiceIDValue 

  body.ServiceID = bodyServiceID 
    
  //截图审核配置的描述。
  var bodyDescription *string 

  var bodyDescriptionValue string = "常用审核模版" 

  bodyDescription = &bodyDescriptionValue 

  body.Description = bodyDescription 
    
  //存储策略。支持以下取值。
  // <li> 0：触发存储，只存储有风险图片； </li>
  // <li> 1：全部存储，存储全部图片。 </li>
  var bodyStorageStrategy *int32 

  var bodyStorageStrategyValue int32 = 0 

  bodyStorageStrategy = &bodyStorageStrategyValue 

  body.StorageStrategy = bodyStorageStrategy 
    
  //审核标签，缺省情况下取值为 301、302、302、305 和 306，支持的取值及含义如下。
  // <li> 301：涉黄； </li>
  // <li> 302：涉敏1； </li>
  // <li> 303：涉敏2； </li>
  // <li> 304：广告； </li>
  // <li> 305：引人不适； </li>
  // <li> 306：违禁； </li>
  // <li> 307：二维码； </li>
  // <li> 308：诈骗； </li>
  // <li> 309：不良画面； </li>
  // <li> 310：未成年相关； </li>
  // <li> 320：文字违规。 </li>
  bodyLabel := []*string{}

  var bodyLabel0 *string 

  var bodyLabel0Value string  = "301" 

  bodyLabel0 = &bodyLabel0Value 

  bodyLabel = append(bodyLabel, bodyLabel0)    

   var bodyLabel1 *string 

  var bodyLabel1Value string  = "302" 

  bodyLabel1 = &bodyLabel1Value 

  bodyLabel = append(bodyLabel, bodyLabel1)    

  body.Label = bodyLabel
    
  //截图存储规则，支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则，支持输入字母、数字、-、!、_、.、* 及占位符，最大长度为 180 个字符。
  var bodySnapshotObject *string 

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

  bodySnapshotObject = &bodySnapshotObjectValue 

  body.SnapshotObject = bodySnapshotObject
  
  resp, err := service.UpdateSnapshotAuditPreset(context.Background(), body)

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

查询截图审核配置列表

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

接口调用示例如下所示。

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.ListVhostSnapshotAuditPresetBody{}
     
  //域名空间名称。
  body.Vhost = "push.example.com"
  
  resp, err := service.ListVhostSnapshotAuditPreset(context.Background(), body)

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

调用说明

前提条件

调用示例

添加截图审核配置

删除截图审核配置

更新截图审核配置

查询截图审核配置列表

视频直播

截图审核

调用说明

前提条件

调用示例

添加截图审核配置

删除截图审核配置

更新截图审核配置

查询截图审核配置列表