You need to enable JavaScript to run this app.
导航

截图审核

最近更新时间2024.04.15 11:36:59

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

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

说明

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

调用说明

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

前提条件

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

调用示例

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

添加截图审核配置

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

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.CreateSnapshotAuditPresetBody;
import com.volcengine.model.live.v20230101.CreateSnapshotAuditPresetRes;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 

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

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    CreateSnapshotAuditPresetBody body = new CreateSnapshotAuditPresetBody();
     
    // 域名空间名称。
    // note:
    // 参数 `Domain` 和 `Vhost` 传且仅传一个。
    body.setVhost("push.example.com");
    
    // 推流域名。
    // note:
    // 参数 `Domain` 和 `Vhost` 传且仅传一个。
    body.setDomain("push.example.com");
    
    // 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。
    body.setApp("live");
    
    // 截图间隔时间,单位为秒,取值范围为 [0.1,10],支持保留两位小数。
    Float bodyInterval = (float)2;

    body.setInterval(bodyInterval);
    
    // TOS 存储对应的 Bucket。
    // 例如,存储路径为 live-test-tos-example/live/liveapp 时,Bucket 取值为 live-test-tos-example。
    // note:
    // 参数 `Bucket` 和 `ServiceID` 传且仅传一个。
    body.setBucket("live-test-tos-example");
    
    // ToS 存储对应的 bucket 下的存储目录,默认为空。
    // 例如,存储位置为 live-test-tos-example/live/liveapp 时,StorageDir 取值为 live/liveapp。
    body.setStorageDir("live/liveapp");
    
    // veImageX 的服务 ID。
    // note:
    // 参数 `Bucket` 和 `ServiceID` 传且仅传一个。
    body.setServiceID("WMK***UXe");
    
    // 截图审核配置的描述。
    body.setDescription("常用审核配置");
    
    // 存储策略,支持的取值及含义如下。
    // <li> 0:触发存储,只存储有风险图片; </li>
    // <li> 1:全部存储,存储所有图片。 </li>
    body.setStorageStrategy(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>
    List<String> CreateSnapshotAuditPresetBodyLabel = new ArrayList<>(); 

    CreateSnapshotAuditPresetBodyLabel.add("301");
    CreateSnapshotAuditPresetBodyLabel.add("302");
    
    body.setLabel(CreateSnapshotAuditPresetBodyLabel); 
    
    // 截图存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符,最大长度为 180 个字符,默认值为 {audit}/{PushDomain}/{App}/{Stream}/{UnixTimestamp}。
    body.setSnapshotObject("{Domain}/{App}/{Stream}/{UnixTimestamp}");

    try {
      CreateSnapshotAuditPresetRes resp = service.createSnapshotAuditPreset(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

删除截图审核配置

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

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.DeleteSnapshotAuditPresetBody;
import com.volcengine.model.live.v20230101.DeleteSnapshotAuditPresetRes;
import com.volcengine.service.live.v20230101.LiveService;

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

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    DeleteSnapshotAuditPresetBody body = new DeleteSnapshotAuditPresetBody();
     
    // 域名空间名称。
    body.setVhost("push.example.com");
    
    // 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。
    body.setApp("live");
    
    // 截图审核配置的名称。
    body.setPresetName("preset-123");

    try {
      DeleteSnapshotAuditPresetRes resp = service.deleteSnapshotAuditPreset(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

更新截图审核配置

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

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.UpdateSnapshotAuditPresetBody;
import com.volcengine.model.live.v20230101.UpdateSnapshotAuditPresetRes;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 

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

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    UpdateSnapshotAuditPresetBody body = new UpdateSnapshotAuditPresetBody();
     
    // 域名空间名称。
    // note:
    // 参数 `Domain` 和 `Vhost` 传且仅传一个。
    body.setVhost("push.example.com");
    
    // 推流域名。
    // note:
    // 参数 `Domain` 和 `Vhost` 传且仅传一个。
    body.setDomain("push.example.com");
    
    // 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。
    body.setApp("live");
    
    // 截图间隔时间,单位秒,取值范围为[0.1,10],支持保留两位小数。
    Float bodyInterval = (float)10;

    body.setInterval(bodyInterval);
    
    // 截图审核配置的名称,您可以通过调用[查询截图审核配置列表](https//www.volcengine.com/docs/6469/1126870)接口获取。
    body.setPresetName("preset-123");
    
    // ToS 存储对应的 Bucket。
    // note:
    // 参数 `Bucket` 和 `ServiceID` 传且仅传一个。
    body.setBucket("live-test-tos-example");
    
    // ToS 存储对应 Bucket 下的存储目录,默认为空。
    // 例如,存储位置为 live-test-tos-example/live/liveapp 时,StorageDir 取值为 live/liveapp。
    body.setStorageDir("live/liveapp");
    
    // veimageX 的服务 ID。
    // note:
    // 参数 `Bucket` 和 `ServiceID` 传且仅传一个。
    body.setServiceID("WMK***UXe");
    
    // 截图审核配置的描述。
    body.setDescription("常用审核模版");
    
    // 存储策略。支持以下取值。
    // <li> 0:触发存储,只存储有风险图片; </li>
    // <li> 1:全部存储,存储全部图片。 </li>
    body.setStorageStrategy(0);
    
    // 审核标签,缺省情况下取值为 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>
    List<String> UpdateSnapshotAuditPresetBodyLabel = new ArrayList<>(); 

    UpdateSnapshotAuditPresetBodyLabel.add("301");
    UpdateSnapshotAuditPresetBodyLabel.add("302");
    
    body.setLabel(UpdateSnapshotAuditPresetBodyLabel); 
    
    // 截图存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符,最大长度为 180 个字符。
    body.setSnapshotObject("{Domain}/{App}/{Stream}/{UnixTimestamp}");

    try {
      UpdateSnapshotAuditPresetRes resp = service.updateSnapshotAuditPreset(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

查询截图审核配置列表

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

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.ListVhostSnapshotAuditPresetBody;
import com.volcengine.model.live.v20230101.ListVhostSnapshotAuditPresetRes;
import com.volcengine.service.live.v20230101.LiveService;

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

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    ListVhostSnapshotAuditPresetBody body = new ListVhostSnapshotAuditPresetBody();
     
    // 域名空间名称。
    body.setVhost("push.example.com");

    try {
      ListVhostSnapshotAuditPresetRes resp = service.listVhostSnapshotAuditPreset(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}