最近更新时间:2024.04.15 11:36:58
首次发布时间:2023.12.28 21:21:51
阅读本文,您可以获取 PHP SDK 截图审核的接口调用示例,实现快速开发。
说明
本文的调用示例包含接口的全部参数。由于参数间可能存在互斥关系,在调用时,请您参考注释,进行调整。
调用接口前,请先完成 PHP SDK 的安装及初始化操作
本节为您介绍截图审核相关接口的功能和调用示例。
您可以调用 CreateSnapshotAuditPreset 接口添加截图审核配置。详细的参数说明可参见 CreateSnapshotAuditPreset 接口文档。
接口调用示例如下所示。
<?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 = []; // 域名空间名称。 // note: // 参数 `Domain` 和 `Vhost` 传且仅传一个。 $body["Vhost"] = "push.example.com"; // 推流域名。 // note: // 参数 `Domain` 和 `Vhost` 传且仅传一个。 $body["Domain"] = "push.example.com"; // 应用名称,由 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` 传且仅传一个。 $body["Bucket"] = "live-test-tos-example"; // ToS 存储对应的 bucket 下的存储目录,默认为空。 // 例如,存储位置为 live-test-tos-example/live/liveapp 时,StorageDir 取值为 live/liveapp。 $body["StorageDir"] = "live/liveapp"; // veImageX 的服务 ID。 // note: // 参数 `Bucket` 和 `ServiceID` 传且仅传一个。 $body["ServiceID"] = "WMK***UXe"; // 截图审核配置的描述。 $body["Description"] = "常用审核配置"; // 存储策略,支持的取值及含义如下。 // <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> $CreateSnapshotAuditPresetBodyLabel = []; array_push($CreateSnapshotAuditPresetBodyLabel,"301"); array_push($CreateSnapshotAuditPresetBodyLabel,"302"); $body["Label"] = $CreateSnapshotAuditPresetBodyLabel; // 截图存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符,最大长度为 180 个字符,默认值为 {audit}/{PushDomain}/{App}/{Stream}/{UnixTimestamp}。 $body["SnapshotObject"] = "{Domain}/{App}/{Stream}/{UnixTimestamp}"; $response = $client->createSnapshotAuditPreset($body); print_r($response);
您可以调用 DeleteSnapshotAuditPreset 接口删除截图审核配置。详细的参数说明可参见 DeleteSnapshotAuditPreset 接口文档。
接口调用示例如下所示。
<?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"; // 截图审核配置的名称。 $body["PresetName"] = "preset-123"; $response = $client->deleteSnapshotAuditPreset($body); print_r($response);
您可以调用 UpdateSnapshotAuditPreset 接口更新截图审核配置。详细的参数说明可参见 UpdateSnapshotAuditPreset 接口文档。
接口调用示例如下所示。
<?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 = []; // 域名空间名称。 // note: // 参数 `Domain` 和 `Vhost` 传且仅传一个。 $body["Vhost"] = "push.example.com"; // 推流域名。 // note: // 参数 `Domain` 和 `Vhost` 传且仅传一个。 $body["Domain"] = "push.example.com"; // 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。 $body["App"] = "live"; // 截图间隔时间,单位秒,取值范围为[0.1,10],支持保留两位小数。 $body["Interval"] = 10; // 截图审核配置的名称,您可以通过调用[查询截图审核配置列表](https://www.volcengine.com/docs/6469/1126870)接口获取。 $body["PresetName"] = "preset-123"; // ToS 存储对应的 Bucket。 // note: // 参数 `Bucket` 和 `ServiceID` 传且仅传一个。 $body["Bucket"] = "live-test-tos-example"; // ToS 存储对应 Bucket 下的存储目录,默认为空。 // 例如,存储位置为 live-test-tos-example/live/liveapp 时,StorageDir 取值为 live/liveapp。 $body["StorageDir"] = "live/liveapp"; // veimageX 的服务 ID。 // note: // 参数 `Bucket` 和 `ServiceID` 传且仅传一个。 $body["ServiceID"] = "WMK***UXe"; // 截图审核配置的描述。 $body["Description"] = "常用审核模版"; // 存储策略。支持以下取值。 // <li> 0:触发存储,只存储有风险图片; </li> // <li> 1:全部存储,存储全部图片。 </li> $body["StorageStrategy"] = 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> $UpdateSnapshotAuditPresetBodyLabel = []; array_push($UpdateSnapshotAuditPresetBodyLabel,"301"); array_push($UpdateSnapshotAuditPresetBodyLabel,"302"); $body["Label"] = $UpdateSnapshotAuditPresetBodyLabel; // 截图存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、-、!、_、.、* 及占位符,最大长度为 180 个字符。 $body["SnapshotObject"] = "{Domain}/{App}/{Stream}/{UnixTimestamp}"; $response = $client->updateSnapshotAuditPreset($body); print_r($response);
您可以调用 ListVhostSnapshotAuditPreset 接口查询截图审核配置列表。详细的参数说明可参见 ListVhostSnapshotAuditPreset 接口文档。
接口调用示例如下所示。
<?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"; $response = $client->listVhostSnapshotAuditPreset($body); print_r($response);