最近更新时间:2024.04.15 11:36:58
首次发布时间:2023.12.28 21:21:51
阅读本文,您可以获取 PHP SDK 截图配置的接口调用示例,实现快速开发。
说明
本文的调用示例包含接口的全部参数。由于参数间可能存在互斥关系,在调用时,请您参考注释,进行调整。
调用接口前,请先完成 PHP SDK 的安装及初始化操作
本节为您介绍截图配置相关接口的功能和调用示例。
您可以调用 CreateSnapshotPresetV2 接口添加截图配置。详细的参数说明可参见 CreateSnapshotPresetV2 接口文档。
接口调用示例如下所示。
<?php include_once('./vendor/autoload.php'); use Volc\Service\Live\v20230101\Live; // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET $client = Live::getInstance(); $client->setAccessKey(getenv("ACCESS_KEY_ID")); $client->setSecretKey(getenv("ACCESS_KEY_SECRET")); $body = []; // 域名空间名称。 $body["Vhost"] = "push.example.com"; // 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。 $body["App"] = "live"; // 截图配置生效状态,默认为生效。 // <li> 1:生效; </li> // <li> 0:不生效。 </li> $body["Status"] = 1; // 截图配置的详细参数配置。 $bodySnapshotPresetConfig =[]; // 图片格式为 JPEG 时的截图参数,开启 JPEG 截图时设置。 // note: // JPEG 截图和 JPG 截图必须开启且只能开启一个。 $bodySnapshotPresetConfigJpegParam =[]; // 当前格式的截图是否开启,默认为 false,取值及含义如下所示。 // <li> false:不开启; </li> // <li> true:开启。 </li> $bodySnapshotPresetConfigJpegParam["Enable"] = true; // 截图存储到 TOS 时的配置。 // note: // TOSParam 和 ImageXParam 配置且配置其中一个。 $bodySnapshotPresetConfigJpegParamTOSParam =[]; // 截图是否使用 TOS 存储,默认为 false,取值及含义如下所示。 // <li> false:不使用; </li> // <li> true:使用。 </li> $bodySnapshotPresetConfigJpegParamTOSParam["Enable"] = true; // TOS 存储对应的 Bucket。 // 例如,存储路径为 live-test-tos-example/live/liveapp 时,Bucket 取值为 live-test-tos-example。 // note: // 使用 TOS 存储时 Bucket 为必填项。 $bodySnapshotPresetConfigJpegParamTOSParam["Bucket"] = "live-test-tos-example"; // ToS 存储对应的 bucket 下的存储目录,默认为空。 // 例如,存储位置为 live-test-tos-example/live/liveapp 时,StorageDir 取值为 live/liveapp。 $bodySnapshotPresetConfigJpegParamTOSParam["StorageDir"] = "live/liveapp"; // 存储方式为实时截图时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 $bodySnapshotPresetConfigJpegParamTOSParam["ExactObject"] = "{Domain}/{App}/{Stream}/{UnixTimestamp}"; // 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 $bodySnapshotPresetConfigJpegParamTOSParam["OverwriteObject"] = "{Domain}/{App}/{Stream}"; $bodySnapshotPresetConfigJpegParam["TOSParam"] = $bodySnapshotPresetConfigJpegParamTOSParam; // 截图存储到 veImageX 时的配置。 // note: // TOSParam 和 ImageXParam 配置且配置其中一个。 $bodySnapshotPresetConfigJpegParamImageXParam =[]; // 截图是否使用 veImageX 存储,默认为 false,取值及含义如下所示。 // <li> false:不使用; </li> // <li> true:使用。 </li> $bodySnapshotPresetConfigJpegParamImageXParam["Enable"] = true; // 使用 veImageX 存储截图时,对应的 veImageX 的服务 ID。 // note: // 使用 veImageX 存储时 ServiceID 为必填项。 $bodySnapshotPresetConfigJpegParamImageXParam["ServiceID"] = "WMK***UX"; // 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 $bodySnapshotPresetConfigJpegParamImageXParam["OverwriteObject"] = "{Domain}/{App}/{Stream}"; // 存储方式为实时截图时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 $bodySnapshotPresetConfigJpegParamImageXParam["ExactObject"] = "{Domain}/{App}/{Stream}/{UnixTimestamp}"; $bodySnapshotPresetConfigJpegParam["ImageXParam"] = $bodySnapshotPresetConfigJpegParamImageXParam; $bodySnapshotPresetConfig["JpegParam"] = $bodySnapshotPresetConfigJpegParam; // 截图间隔时间,单位为秒,默认值为 10,取值范围为正整数。 $bodySnapshotPresetConfig["Interval"] = 10; // 截图格式为 JPG 时的截图参数,开启 JPG 截图时设置。 // note: // JPEG 截图和 JPG 截图必须开启且只能开启一个。 $bodySnapshotPresetConfigJpgParam =[]; // 当前格式的截图是否开启,默认为 false,取值及含义如下所示。 // <li> false:不开启; </li> // <li> true:开启。 </li> $bodySnapshotPresetConfigJpgParam["Enable"] = true; // 截图存储到 TOS 时的配置。 // note: // TOSParam 和 ImageXParam 配置且配置其中一个。 $bodySnapshotPresetConfigJpgParamTOSParam =[]; // 截图是否使用 TOS 存储,默认为 false,取值及含义如下所示。 // <li> false:不使用; </li> // <li> true:使用。 </li> $bodySnapshotPresetConfigJpgParamTOSParam["Enable"] = true; // TOS 存储对应的 Bucket。 // 例如,存储路径为 live-test-tos-example/live/liveapp 时,Bucket 取值为 live-test-tos-example。 // note: // 使用 TOS 存储时 Bucket 为必填项。 $bodySnapshotPresetConfigJpgParamTOSParam["Bucket"] = "live-test-tos-example"; // ToS 存储对应的 bucket 下的存储目录,默认为空。 // 例如,存储位置为 live-test-tos-example/live/liveapp 时,StorageDir 取值为 live/liveapp。 $bodySnapshotPresetConfigJpgParamTOSParam["StorageDir"] = "live/liveapp"; // 存储方式为实时截图时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 $bodySnapshotPresetConfigJpgParamTOSParam["ExactObject"] = "{Domain}/{App}/{Stream}/{UnixTimestamp}"; // 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 $bodySnapshotPresetConfigJpgParamTOSParam["OverwriteObject"] = "{Domain}/{App}/{Stream}"; $bodySnapshotPresetConfigJpgParam["TOSParam"] = $bodySnapshotPresetConfigJpgParamTOSParam; // 截图存储到 veImageX 时的配置。 // note: // TOSParam 和 ImageXParam 配置且配置其中一个。 $bodySnapshotPresetConfigJpgParamImageXParam =[]; // 截图是否使用 veImageX 存储,默认为 false,取值及含义如下所示。 // <li> false:不使用; </li> // <li> true:使用。 </li> $bodySnapshotPresetConfigJpgParamImageXParam["Enable"] = true; // 使用 veImageX 存储截图时,对应的 veImageX 的服务 ID。 // note: // 使用 veImageX 存储时 ServiceID 为必填项。 $bodySnapshotPresetConfigJpgParamImageXParam["ServiceID"] = "WMK***UX"; // 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 $bodySnapshotPresetConfigJpgParamImageXParam["OverwriteObject"] = "{Domain}/{App}/{Stream}"; // 存储方式为实时截图时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 $bodySnapshotPresetConfigJpgParamImageXParam["ExactObject"] = "{Domain}/{App}/{Stream}/{UnixTimestamp}"; $bodySnapshotPresetConfigJpgParam["ImageXParam"] = $bodySnapshotPresetConfigJpgParamImageXParam; $bodySnapshotPresetConfig["JpgParam"] = $bodySnapshotPresetConfigJpgParam; $body["SnapshotPresetConfig"] = $bodySnapshotPresetConfig; $response = $client->createSnapshotPresetV2($body); print_r($response);
您可以调用 UpdateSnapshotPresetV2 接口更新截图配置。详细的参数说明可参见 UpdateSnapshotPresetV2 接口文档。
接口调用示例如下所示。
<?php include_once('./vendor/autoload.php'); use Volc\Service\Live\v20230101\Live; // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET $client = Live::getInstance(); $client->setAccessKey(getenv("ACCESS_KEY_ID")); $client->setSecretKey(getenv("ACCESS_KEY_SECRET")); $body = []; // 域名空间名称。 $body["Vhost"] = "push.example.com"; // 截图配置的名称。 $body["Preset"] = "preset-123"; // 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。 $body["App"] = "live"; // 截图配置生效状态,默认为生效。 // <li> 1:生效; </li> // <li> 0:不生效。 </li> $body["Status"] = 1; // 截图配置的详细参数配置。 $bodySnapshotPresetConfig =[]; // 图片格式为 JPEG 时的截图参数,开启 JPEG 截图时设置。 // note: // JPEG 截图和 JPG 截图必须开启且只能开启一个。 $bodySnapshotPresetConfigJpegParam =[]; // 当前格式的截图配置是否开启,默认为 false,取值及含义如下所示。 // <li> false:不开启; </li> // <li> true:开启。 </li> $bodySnapshotPresetConfigJpegParam["Enable"] = true; // 截图存储到 TOS 时的配置。 // note: // TOSParam 和 ImageXParam 配置且配置其中一个。 $bodySnapshotPresetConfigJpegParamTOSParam =[]; // 截图是否使用 TOS 存储,默认为 false,取值及含义如下所示。 // <li> false:不使用; </li> // <li> true:使用。 </li> $bodySnapshotPresetConfigJpegParamTOSParam["Enable"] = true; // TOS 存储对应的 Bucket。 // 例如,存储路径为 live-test-tos-example/live/liveapp 时,Bucket 取值为 live-test-tos-example。 // note: // 使用 TOS 存储时 Bucket 为必填项。 $bodySnapshotPresetConfigJpegParamTOSParam["Bucket"] = "live-test-tos-example"; // Bucket 目录,默认为空。 // 例如,存储路径为 live-test-tos-example/live/liveapp 时,StorageDir 取值为 live/liveapp。 $bodySnapshotPresetConfigJpegParamTOSParam["StorageDir"] = "live/liveapp"; // 存储方式为实时存储时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 $bodySnapshotPresetConfigJpegParamTOSParam["ExactObject"] = "{Domain}/{App}/{Stream}/{UnixTimestamp}"; // 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 $bodySnapshotPresetConfigJpegParamTOSParam["OverwriteObject"] = "{Domain}/{App}/{Stream}"; $bodySnapshotPresetConfigJpegParam["TOSParam"] = $bodySnapshotPresetConfigJpegParamTOSParam; // 截图存储到 veImageX 时的配置。 // note: // TOSParam 和 ImageXParam 配置且配置其中一个。 $bodySnapshotPresetConfigJpegParamImageXParam =[]; // 截图是否使用 veImageX 存储,默认为 false,取值及含义如下所示。 // <li> false:不使用; </li> // <li> true:使用。 </li> $bodySnapshotPresetConfigJpegParamImageXParam["Enable"] = true; // 使用 veImageX 存储截图时,对应的 veImageX 的服务 ID。 // note: // 使用 veImageX 存储时 ServiceID 为必填项。 $bodySnapshotPresetConfigJpegParamImageXParam["ServiceID"] = "WMK***UX"; // 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 $bodySnapshotPresetConfigJpegParamImageXParam["OverwriteObject"] = "{Domain}/{App}/{Stream}"; // 存储方式为实时存储时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、*" 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 $bodySnapshotPresetConfigJpegParamImageXParam["ExactObject"] = "{Domain}/{App}/{Stream}/{UnixTimestamp}"; $bodySnapshotPresetConfigJpegParam["ImageXParam"] = $bodySnapshotPresetConfigJpegParamImageXParam; $bodySnapshotPresetConfig["JpegParam"] = $bodySnapshotPresetConfigJpegParam; // 截图间隔时间,单位为秒,默认值为 10,取值范围为正整数。 $bodySnapshotPresetConfig["Interval"] = 10; // 截图格式为 JPG 时的截图参数,开启 JPG 截图时设置。 // note: // JPEG 截图和 JPG 截图必须开启且只能开启一个。 $bodySnapshotPresetConfigJpgParam =[]; // 当前格式的截图配置是否开启,默认为 false,取值及含义如下所示。 // <li> false:不开启; </li> // <li> true:开启。 </li> $bodySnapshotPresetConfigJpgParam["Enable"] = true; // 截图存储到 TOS 时的配置。 // note: // TOSParam 和 ImageXParam 配置且配置其中一个。 $bodySnapshotPresetConfigJpgParamTOSParam =[]; // 截图是否使用 TOS 存储,默认为 false,取值及含义如下所示。 // <li> false:不使用; </li> // <li> true:使用。 </li> $bodySnapshotPresetConfigJpgParamTOSParam["Enable"] = true; // TOS 存储对应的 Bucket。 // 例如,存储路径为 live-test-tos-example/live/liveapp 时,Bucket 取值为 live-test-tos-example。 // note: // 使用 TOS 存储时 Bucket 为必填项。 $bodySnapshotPresetConfigJpgParamTOSParam["Bucket"] = "live-test-tos-example"; // Bucket 目录,默认为空。 // 例如,存储路径为 live-test-tos-example/live/liveapp 时,StorageDir 取值为 live/liveapp。 $bodySnapshotPresetConfigJpgParamTOSParam["StorageDir"] = "live/liveapp"; // 存储方式为实时存储时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 $bodySnapshotPresetConfigJpgParamTOSParam["ExactObject"] = "{Domain}/{App}/{Stream}/{UnixTimestamp}"; // 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 $bodySnapshotPresetConfigJpgParamTOSParam["OverwriteObject"] = "{Domain}/{App}/{Stream}"; $bodySnapshotPresetConfigJpgParam["TOSParam"] = $bodySnapshotPresetConfigJpgParamTOSParam; // 截图存储到 veImageX 时的配置。 // note: // TOSParam 和 ImageXParam 配置且配置其中一个。 $bodySnapshotPresetConfigJpgParamImageXParam =[]; // 截图是否使用 veImageX 存储,默认为 false,取值及含义如下所示。 // <li> false:不使用; </li> // <li> true:使用。 </li> $bodySnapshotPresetConfigJpgParamImageXParam["Enable"] = true; // 使用 veImageX 存储截图时,对应的 veImageX 的服务 ID。 // note: // 使用 veImageX 存储时 ServiceID 为必填项。 $bodySnapshotPresetConfigJpgParamImageXParam["ServiceID"] = "WMK***UX"; // 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 $bodySnapshotPresetConfigJpgParamImageXParam["OverwriteObject"] = "{Domain}/{App}/{Stream}"; // 存储方式为实时存储时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、*" 及占位符。 // note: // 参数 ExactObject 和 OverwriteObject 传且仅传一个。 $bodySnapshotPresetConfigJpgParamImageXParam["ExactObject"] = "{Domain}/{App}/{Stream}/{UnixTimestamp}"; $bodySnapshotPresetConfigJpgParam["ImageXParam"] = $bodySnapshotPresetConfigJpgParamImageXParam; $bodySnapshotPresetConfig["JpgParam"] = $bodySnapshotPresetConfigJpgParam; $body["SnapshotPresetConfig"] = $bodySnapshotPresetConfig; $response = $client->updateSnapshotPresetV2($body); print_r($response);
您可以调用 ListVhostSnapshotPresetV2 接口查询截图配置列表。详细的参数说明可参见 ListVhostSnapshotPresetV2 接口文档。
接口调用示例如下所示。
<?php include_once('./vendor/autoload.php'); use Volc\Service\Live\v20230101\Live; // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET $client = Live::getInstance(); $client->setAccessKey(getenv("ACCESS_KEY_ID")); $client->setSecretKey(getenv("ACCESS_KEY_SECRET")); $body = []; // 域名空间名称。 $body["Vhost"] = "push.example.com"; // 截图配置中截图文件的存储位置,缺省情况下表示不对存储位置进行过滤,取值及含义如下所示。 // <li> tos:TOS 对象存储服务; </li> // <li> imageX:veImageX 图片服务。 </li> $body["Type"] = "tos"; $response = $client->listVhostSnapshotPresetV2($body); print_r($response);
您可以调用 DeleteSnapshotPreset 接口删除截图配置。详细的参数说明可参见 DeleteSnapshotPreset 接口文档。
接口调用示例如下所示。
<?php include_once('./vendor/autoload.php'); use Volc\Service\Live\v20230101\Live; // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET $client = Live::getInstance(); $client->setAccessKey(getenv("ACCESS_KEY_ID")); $client->setSecretKey(getenv("ACCESS_KEY_SECRET")); $body = []; // 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。 $body["App"] = "live"; // 截图配置名称。 $body["Preset"] = "preset-123"; // 域名空间名称。 $body["Vhost"] = "push.example.com"; $response = $client->deleteSnapshotPreset($body); print_r($response);
您可以调用 DescribeCDNSnapshotHistory 接口查询截图历史详情。详细的参数说明可参见 DescribeCDNSnapshotHistory 接口文档。
接口调用示例如下所示。
<?php include_once('./vendor/autoload.php'); use Volc\Service\Live\v20230101\Live; // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET $client = Live::getInstance(); $client->setAccessKey(getenv("ACCESS_KEY_ID")); $client->setSecretKey(getenv("ACCESS_KEY_SECRET")); $body = []; // 域名空间名称,由 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,表示查询第一页的数据。 $body["PageNum"] = 1; // 每页显示的数据条数,默认为 10,最大值为 1000。 $body["PageSize"] = 30; // 截图文件保存位置,默认取值为 tos。 // * tos:TOS 对象存储服务; // * imageX:veImageX 图片服务。 $body["Type"] = "tos"; $response = $client->describeCDNSnapshotHistory($body); print_r($response);