最近更新时间:2024.04.15 11:36:59
首次发布时间:2023.12.28 21:21:51
阅读本文,您可以获取 Java SDK 截图配置的接口调用示例,实现快速开发。
说明
本文的调用示例包含接口的全部参数。由于参数间可能存在互斥关系,在调用时,请您参考注释,进行调整。
调用接口前,请先完成 Java SDK 的安装及初始化操作
本节为您介绍截图配置相关接口的功能和调用示例。
您可以调用 CreateSnapshotPresetV2 接口添加截图配置。详细的参数说明可参见 CreateSnapshotPresetV2 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.CreateSnapshotPresetV2Body; import com.volcengine.model.live.v20230101.CreateSnapshotPresetV2BodySnapshotPresetConfig; import com.volcengine.model.live.v20230101.CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParam; import com.volcengine.model.live.v20230101.CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam; import com.volcengine.model.live.v20230101.CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam; import com.volcengine.model.live.v20230101.CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParam; import com.volcengine.model.live.v20230101.CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam; import com.volcengine.model.live.v20230101.CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam; import com.volcengine.model.live.v20230101.CreateSnapshotPresetV2Res; import com.volcengine.service.live.v20230101.LiveService; public class CreateSnapshotPresetV2Demo { 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")); CreateSnapshotPresetV2Body body = new CreateSnapshotPresetV2Body(); // 域名空间名称。 body.setVhost("push.example.com"); // 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。 body.setApp("live"); // 截图配置生效状态,默认为生效。 // <li> 1:生效; </li> // <li> 0:不生效。 </li> body.setStatus(1); // 截图配置的详细参数配置。 CreateSnapshotPresetV2BodySnapshotPresetConfig CreateSnapshotPresetV2BodySnapshotPresetConfig = new CreateSnapshotPresetV2BodySnapshotPresetConfig(); // 图片格式为 JPEG 时的截图参数,开启 JPEG 截图时设置。 // note: // JPEG 截图和 JPG 截图必须开启且只能开启一个。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParam CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParam = new CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParam(); // 当前格式的截图是否开启,默认为 false,取值及含义如下所示。 // <li> false:不开启; </li> // <li> true:开启。 </li> CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParam.setEnable(true); // 截图存储到 TOS 时的配置。 // note: // TOSParam 和 ImageXParam 配置且配置其中一个。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam = new CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam(); // 截图是否使用 TOS 存储,默认为 false,取值及含义如下所示。 // <li> false:不使用; </li> // <li> true:使用。 </li> CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam.setEnable(true); // TOS 存储对应的 Bucket。 // 例如,存储路径为 live-test-tos-example/live/liveapp 时,Bucket 取值为 live-test-tos-example。 // note: // 使用 TOS 存储时 Bucket 为必填项。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam.setBucket("live-test-tos-example"); // ToS 存储对应的 bucket 下的存储目录,默认为空。 // 例如,存储位置为 live-test-tos-example/live/liveapp 时,StorageDir 取值为 live/liveapp。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam.setStorageDir("live/liveapp"); // 存储方式为实时截图时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam.setExactObject("{Domain}/{App}/{Stream}/{UnixTimestamp}"); // 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam.setOverwriteObject("{Domain}/{App}/{Stream}"); CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParam.setTOSParam(CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam); // 截图存储到 veImageX 时的配置。 // note: // TOSParam 和 ImageXParam 配置且配置其中一个。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam = new CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam(); // 截图是否使用 veImageX 存储,默认为 false,取值及含义如下所示。 // <li> false:不使用; </li> // <li> true:使用。 </li> CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam.setEnable(true); // 使用 veImageX 存储截图时,对应的 veImageX 的服务 ID。 // note: // 使用 veImageX 存储时 ServiceID 为必填项。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam.setServiceID("WMK***UX"); // 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam.setOverwriteObject("{Domain}/{App}/{Stream}"); // 存储方式为实时截图时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam.setExactObject("{Domain}/{App}/{Stream}/{UnixTimestamp}"); CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParam.setImageXParam(CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam); CreateSnapshotPresetV2BodySnapshotPresetConfig.setJpegParam(CreateSnapshotPresetV2BodySnapshotPresetConfigJpegParam); // 截图间隔时间,单位为秒,默认值为 10,取值范围为正整数。 CreateSnapshotPresetV2BodySnapshotPresetConfig.setInterval(10); // 截图格式为 JPG 时的截图参数,开启 JPG 截图时设置。 // note: // JPEG 截图和 JPG 截图必须开启且只能开启一个。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParam CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParam = new CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParam(); // 当前格式的截图是否开启,默认为 false,取值及含义如下所示。 // <li> false:不开启; </li> // <li> true:开启。 </li> CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParam.setEnable(true); // 截图存储到 TOS 时的配置。 // note: // TOSParam 和 ImageXParam 配置且配置其中一个。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam = new CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam(); // 截图是否使用 TOS 存储,默认为 false,取值及含义如下所示。 // <li> false:不使用; </li> // <li> true:使用。 </li> CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam.setEnable(true); // TOS 存储对应的 Bucket。 // 例如,存储路径为 live-test-tos-example/live/liveapp 时,Bucket 取值为 live-test-tos-example。 // note: // 使用 TOS 存储时 Bucket 为必填项。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam.setBucket("live-test-tos-example"); // ToS 存储对应的 bucket 下的存储目录,默认为空。 // 例如,存储位置为 live-test-tos-example/live/liveapp 时,StorageDir 取值为 live/liveapp。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam.setStorageDir("live/liveapp"); // 存储方式为实时截图时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam.setExactObject("{Domain}/{App}/{Stream}/{UnixTimestamp}"); // 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam.setOverwriteObject("{Domain}/{App}/{Stream}"); CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParam.setTOSParam(CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam); // 截图存储到 veImageX 时的配置。 // note: // TOSParam 和 ImageXParam 配置且配置其中一个。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam = new CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam(); // 截图是否使用 veImageX 存储,默认为 false,取值及含义如下所示。 // <li> false:不使用; </li> // <li> true:使用。 </li> CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam.setEnable(true); // 使用 veImageX 存储截图时,对应的 veImageX 的服务 ID。 // note: // 使用 veImageX 存储时 ServiceID 为必填项。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam.setServiceID("WMK***UX"); // 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam.setOverwriteObject("{Domain}/{App}/{Stream}"); // 存储方式为实时截图时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam.setExactObject("{Domain}/{App}/{Stream}/{UnixTimestamp}"); CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParam.setImageXParam(CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam); CreateSnapshotPresetV2BodySnapshotPresetConfig.setJpgParam(CreateSnapshotPresetV2BodySnapshotPresetConfigJpgParam); body.setSnapshotPresetConfig(CreateSnapshotPresetV2BodySnapshotPresetConfig); try { CreateSnapshotPresetV2Res resp = service.createSnapshotPresetV2(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 UpdateSnapshotPresetV2 接口更新截图配置。详细的参数说明可参见 UpdateSnapshotPresetV2 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.UpdateSnapshotPresetV2Body; import com.volcengine.model.live.v20230101.UpdateSnapshotPresetV2BodySnapshotPresetConfig; import com.volcengine.model.live.v20230101.UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParam; import com.volcengine.model.live.v20230101.UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam; import com.volcengine.model.live.v20230101.UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam; import com.volcengine.model.live.v20230101.UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParam; import com.volcengine.model.live.v20230101.UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam; import com.volcengine.model.live.v20230101.UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam; import com.volcengine.model.live.v20230101.UpdateSnapshotPresetV2Res; import com.volcengine.service.live.v20230101.LiveService; public class UpdateSnapshotPresetV2Demo { 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")); UpdateSnapshotPresetV2Body body = new UpdateSnapshotPresetV2Body(); // 域名空间名称。 body.setVhost("push.example.com"); // 截图配置的名称。 body.setPreset("preset-123"); // 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。 body.setApp("live"); // 截图配置生效状态,默认为生效。 // <li> 1:生效; </li> // <li> 0:不生效。 </li> body.setStatus(1); // 截图配置的详细参数配置。 UpdateSnapshotPresetV2BodySnapshotPresetConfig UpdateSnapshotPresetV2BodySnapshotPresetConfig = new UpdateSnapshotPresetV2BodySnapshotPresetConfig(); // 图片格式为 JPEG 时的截图参数,开启 JPEG 截图时设置。 // note: // JPEG 截图和 JPG 截图必须开启且只能开启一个。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParam UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParam = new UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParam(); // 当前格式的截图配置是否开启,默认为 false,取值及含义如下所示。 // <li> false:不开启; </li> // <li> true:开启。 </li> UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParam.setEnable(true); // 截图存储到 TOS 时的配置。 // note: // TOSParam 和 ImageXParam 配置且配置其中一个。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam = new UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam(); // 截图是否使用 TOS 存储,默认为 false,取值及含义如下所示。 // <li> false:不使用; </li> // <li> true:使用。 </li> UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam.setEnable(true); // TOS 存储对应的 Bucket。 // 例如,存储路径为 live-test-tos-example/live/liveapp 时,Bucket 取值为 live-test-tos-example。 // note: // 使用 TOS 存储时 Bucket 为必填项。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam.setBucket("live-test-tos-example"); // Bucket 目录,默认为空。 // 例如,存储路径为 live-test-tos-example/live/liveapp 时,StorageDir 取值为 live/liveapp。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam.setStorageDir("live/liveapp"); // 存储方式为实时存储时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam.setExactObject("{Domain}/{App}/{Stream}/{UnixTimestamp}"); // 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam.setOverwriteObject("{Domain}/{App}/{Stream}"); UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParam.setTOSParam(UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamTOSParam); // 截图存储到 veImageX 时的配置。 // note: // TOSParam 和 ImageXParam 配置且配置其中一个。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam = new UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam(); // 截图是否使用 veImageX 存储,默认为 false,取值及含义如下所示。 // <li> false:不使用; </li> // <li> true:使用。 </li> UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam.setEnable(true); // 使用 veImageX 存储截图时,对应的 veImageX 的服务 ID。 // note: // 使用 veImageX 存储时 ServiceID 为必填项。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam.setServiceID("WMK***UX"); // 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam.setOverwriteObject("{Domain}/{App}/{Stream}"); // 存储方式为实时存储时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、*" 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam.setExactObject("{Domain}/{App}/{Stream}/{UnixTimestamp}"); UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParam.setImageXParam(UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParamImageXParam); UpdateSnapshotPresetV2BodySnapshotPresetConfig.setJpegParam(UpdateSnapshotPresetV2BodySnapshotPresetConfigJpegParam); // 截图间隔时间,单位为秒,默认值为 10,取值范围为正整数。 UpdateSnapshotPresetV2BodySnapshotPresetConfig.setInterval(10); // 截图格式为 JPG 时的截图参数,开启 JPG 截图时设置。 // note: // JPEG 截图和 JPG 截图必须开启且只能开启一个。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParam UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParam = new UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParam(); // 当前格式的截图配置是否开启,默认为 false,取值及含义如下所示。 // <li> false:不开启; </li> // <li> true:开启。 </li> UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParam.setEnable(true); // 截图存储到 TOS 时的配置。 // note: // TOSParam 和 ImageXParam 配置且配置其中一个。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam = new UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam(); // 截图是否使用 TOS 存储,默认为 false,取值及含义如下所示。 // <li> false:不使用; </li> // <li> true:使用。 </li> UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam.setEnable(true); // TOS 存储对应的 Bucket。 // 例如,存储路径为 live-test-tos-example/live/liveapp 时,Bucket 取值为 live-test-tos-example。 // note: // 使用 TOS 存储时 Bucket 为必填项。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam.setBucket("live-test-tos-example"); // Bucket 目录,默认为空。 // 例如,存储路径为 live-test-tos-example/live/liveapp 时,StorageDir 取值为 live/liveapp。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam.setStorageDir("live/liveapp"); // 存储方式为实时存储时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam.setExactObject("{Domain}/{App}/{Stream}/{UnixTimestamp}"); // 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam.setOverwriteObject("{Domain}/{App}/{Stream}"); UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParam.setTOSParam(UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamTOSParam); // 截图存储到 veImageX 时的配置。 // note: // TOSParam 和 ImageXParam 配置且配置其中一个。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam = new UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam(); // 截图是否使用 veImageX 存储,默认为 false,取值及含义如下所示。 // <li> false:不使用; </li> // <li> true:使用。 </li> UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam.setEnable(true); // 使用 veImageX 存储截图时,对应的 veImageX 的服务 ID。 // note: // 使用 veImageX 存储时 ServiceID 为必填项。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam.setServiceID("WMK***UX"); // 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam.setOverwriteObject("{Domain}/{App}/{Stream}"); // 存储方式为实时存储时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、*" 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam.setExactObject("{Domain}/{App}/{Stream}/{UnixTimestamp}"); UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParam.setImageXParam(UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParamImageXParam); UpdateSnapshotPresetV2BodySnapshotPresetConfig.setJpgParam(UpdateSnapshotPresetV2BodySnapshotPresetConfigJpgParam); body.setSnapshotPresetConfig(UpdateSnapshotPresetV2BodySnapshotPresetConfig); try { UpdateSnapshotPresetV2Res resp = service.updateSnapshotPresetV2(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 ListVhostSnapshotPresetV2 接口查询截图配置列表。详细的参数说明可参见 ListVhostSnapshotPresetV2 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.ListVhostSnapshotPresetV2Body; import com.volcengine.model.live.v20230101.ListVhostSnapshotPresetV2Res; import com.volcengine.service.live.v20230101.LiveService; public class ListVhostSnapshotPresetV2Demo { 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")); ListVhostSnapshotPresetV2Body body = new ListVhostSnapshotPresetV2Body(); // 域名空间名称。 body.setVhost("push.example.com"); // 截图配置中截图文件的存储位置,缺省情况下表示不对存储位置进行过滤,取值及含义如下所示。 // <li> tos:TOS 对象存储服务; </li> // <li> imageX:veImageX 图片服务。 </li> body.setType("tos"); try { ListVhostSnapshotPresetV2Res resp = service.listVhostSnapshotPresetV2(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 DeleteSnapshotPreset 接口删除截图配置。详细的参数说明可参见 DeleteSnapshotPreset 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.DeleteSnapshotPresetBody; import com.volcengine.model.live.v20230101.DeleteSnapshotPresetRes; import com.volcengine.service.live.v20230101.LiveService; public class DeleteSnapshotPresetDemo { 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")); DeleteSnapshotPresetBody body = new DeleteSnapshotPresetBody(); // 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。 body.setApp("live"); // 截图配置名称。 body.setPreset("preset-123"); // 域名空间名称。 body.setVhost("push.example.com"); try { DeleteSnapshotPresetRes resp = service.deleteSnapshotPreset(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 DescribeCDNSnapshotHistory 接口查询截图历史详情。详细的参数说明可参见 DescribeCDNSnapshotHistory 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.DescribeCDNSnapshotHistoryBody; import com.volcengine.model.live.v20230101.DescribeCDNSnapshotHistoryRes; import com.volcengine.service.live.v20230101.LiveService; public class DescribeCDNSnapshotHistoryDemo { 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")); DescribeCDNSnapshotHistoryBody body = new DescribeCDNSnapshotHistoryBody(); // 域名空间名称,由 1 到 60 位数字、字母、下划线及"-"和"."组成。 body.setVhost("push.example.com"); // 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。 body.setApp("live"); // 流名称,由 1 到 100 位数字、字母、下划线及"-"和"."组成。 body.setStream("stream-123"); // 查询的开始时间,RFC3339 格式的 UTC 时间,精度为秒。 // note: // <li> 当您查询指定截图任务详情时,DateFrom 应设置为推流开始时间之前的任意时间。 </li> // <li> 查询的最大时间跨度为 7 天。 </li> body.setDateFrom("2022-04-01T00:00:00+08:00"); // 查询的结束时间,RFC3339 格式的 UTC 时间,精度为秒。 body.setDateTo("2022-04-02T00:00:00+08:00"); // 查询数据的页码,默认为 1,表示查询第一页的数据。 body.setPageNum(1); // 每页显示的数据条数,默认为 10,最大值为 1000。 body.setPageSize(30); // 截图文件保存位置,默认取值为 tos。 // * tos:TOS 对象存储服务; // * imageX:veImageX 图片服务。 body.setType("tos"); try { DescribeCDNSnapshotHistoryRes resp = service.describeCDNSnapshotHistory(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }