控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

填写文档满意度调查问卷,赢取缤纷好礼> HOT

视频审核

最近更新时间:2022-07-01 09:27:53

简介

本文档提供关于视频审核的 API 概览和 SDK 示例代码。

API 操作描述
提交视频审核任务 用于提交一个视频审核任务
查询视频审核任务结果 用于查询指定的视频审核任务

提交视频审核任务

功能说明

用于提交一个视频审核任务。

方法原型

CosResult CreateVideoAuditingJob(const CreateVideoAuditingJobReq& req, CreateVideoAuditingJobResp* resp);

请求示例

qcloud_cos::CosConfig config("./config.json");
qcloud_cos::CosAPI cos(config);
std::string bucket_name = "examplebucket-1250000000";
std::string object_name = "test.mp4";

CreateVideoAuditingJobReq req(bucket_name);
CreateVideoAuditingJobResp resp;

// 添加请求参数 参数详情请见api接口文档
req.SetObject(object_name);
req.SetBizType("b81d45f94b91a683255e9a9506f45a11");
// req.SetDetectType("Porn,Ads");
SnapShotConf snap_shot = SnapShotConf();
snap_shot.SetCount(100);
snap_shot.SetMode("Interval");
snap_shot.SetTimeInterval(10);
req.SetSnapShot(snap_shot);

// 调用接口,获取任务响应对象
CosResult result = cos.CreateVideoAuditingJob(req, &resp);
if (result.IsSucc()) {
    // 创建审核任务成功,可以调用 CreateVideoAuditingJobResp 的成员函数
} else {
    // 创建审核任务失败,可以调用 CosResult 的成员函数输出错误信息
}

参数说明

参数 参数描述 类型 是否必填
req CreateVideoAuditing 操作的请求 CreateVideoAuditingReq
resp CreateVideoAuditing 操作的响应 CreateVideoAuditingResp

CreateVideoAuditingReq 提供以下成员函数:

// 设置执行操作的bucket
void SetBucketName(const std::string& bucket_name);
// 设置input需要审核的视频
void SetInput(const AuditingInput& input);
// 设置审核配置规则
void SetConf(const Conf& conf);

// conf
// 表示审核策略的唯一标识,您可以通过控制台上的审核策略页面,配置您希望审核的场景,如涉黄、广告、违法违规等,配置指引: 设置公共审核策略。
// 您可以在控制台上获取到 BizType。BizType 填写时,此条审核请求将按照该审核策略中配置的场景进行审核。
void SetBizType(const std::string& biz_type);
// 审核的场景类型,有效值:Porn(涉黄)、Ads(广告)等,可以传入多种类型,不同类型以逗号分隔,例如:Porn,Ads。如您有更多场景的审核需要,请使用 BizType 参数。
void SetDetectType(const std::string& detect_type);
// 视频画面的审核通过视频截帧能力截取出一定量的截图,通过对截图逐一审核而实现的,该参数用于指定视频截帧的配置。
void SetSnapShot(const SnapShotConf& snap_shot);
// 回调地址,以http://或者https://开头的地址。
void SetCallBack(const std::string& callback);
// 回调内容的结构,有效值:Simple(回调内容包含基本信息)、Detail(回调内容包含详细信息)。默认为 Simple。
void SetCallBackVersion(const std::string& callback_version);
// 用于指定是否审核视频声音,当值为0时:表示只审核视频画面截图;值为1时:表示同时审核视频画面截图和视频声音。默认值为0。
void SetDetectContent(const int detect_content);

// input
// 当前 COS 存储桶中的视频文件名称,例如在目录 test 中的文件 video.mp4,则文件名称为 test/video.mp4。
void SetObject(const std::string& object);
// 视频文件的链接地址,例如 http://examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/test.mp4。Object 和 Url 只能选择其中一种。
void SetUrl(const std::string& url);
// 该字段在审核结果中会返回原始内容,长度限制为512字节。您可以使用该字段对待审核的数据进行唯一业务标识。
void SetDataId(const std::string& data_id);
// 用户业务字段。
void SetUserInfo(const UserInfo& user_info);

CreateVideoAuditingResp 提供的成员函数如下:

// 获取API请求执行返回的任务详情
VideoAuditingJobsDetail GetJobsDetail();
// 获取API请求的透传ID
std::string GetRequestId();

返回结果说明

  • 成功:解析 API 返回的 XML 内容中的审核任务结果到 VideoAuditingJobsDetail 结构中,具体返回参数可查看 提交视频审核任务 文档。
  • 失败:发生错误(例如 Bucket 不存在),错误信息则解析在 CosResult 结构体中。详情请参见 异常处理

查询视频审核任务结果

功能说明

用于查询视频审核任务执行情况和结果。

方法原型

CosResult DescribeVideoAuditingJob(const DescribeVideoAuditingJobReq& req, DescribeVideoAuditingJobResp* resp);

请求示例

qcloud_cos::CosConfig config("./config.json");
qcloud_cos::CosAPI cos(config);
std::string bucket_name = "examplebucket-1250000000";

DescribeVideoAuditingJobReq req(bucket_name);
DescribeVideoAuditingJobResp resp;

// 添加请求参数 参数详情请见api接口文档
req.SetJobId("vab1ca9fc8a3ed11ea834c525400863904");

// 调用接口,获取任务响应对象
CosResult result = cos.DescribeVideoAuditingJob(req, &resp);
if (result.IsSucc()) {
    // 查询审核任务成功,可以调用 DescribeVideoAuditingJobResp 的成员函数
} else {
    // 查询审核任务失败,可以调用 CosResult 的成员函数输出错误信息
}

参数说明

参数 参数描述 类型 是否必填
req DescribeVideoAuditingJob 操作的请求 DescribeVideoAuditingJobReq
resp DescribeVideoAuditingJob 操作的响应 DescribeVideoAuditingJobResp

DescribeVideoAuditingJobReq 提供以下成员函数:

// 设置执行操作的bucket
void SetBucketName(const std::string& bucket_name);
// 设置查询的审核任务ID
void SetJobId(const std::string& job_id);

DescribeVideoAuditingJobResp 提供的成员函数如下:

// 获取API请求执行返回的任务详情
VideoAuditingJobsDetail GetJobsDetail();
// 获取API请求的透传ID
std::string GetRequestId();

返回结果说明

  • 成功:解析 API 返回的 XML 内容中的审核任务结果到 VideoAuditingJobsDetail 结构中,具体返回参数可查看 提交视频审核任务 文档。
  • 失败:发生错误(例如 Bucket 不存在),错误信息则解析在 CosResult 结构体中。详情请参见 异常处理
目录