API | Description |
Submits video moderation job. | |
Queries the result of specified video moderation job. |
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;// Add request parameters as detailed in the API documentationreq.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);// Call the API to get the job response objectCosResult result = cos.CreateVideoAuditingJob(req, &resp);if (result.IsSucc()) {// If the moderation job is created successfully, you can call the member functions of `CreateVideoAuditingJobResp`.} else {// If the moderation job failed to be created, you can call the member functions of `CosResult` to output the error message.}
Parameter | Description | Type | Required |
req | CreateVideoAuditing operation request | CreateVideoAuditingReq | Yes |
resp | CreateVideoAuditing operation response | CreateVideoAuditingResp | Yes |
CreateVideoAuditingReq
provides the following member functions:// Set the bucket for performing the operationvoid SetBucketName(const std::string& bucket_name);// Set the input video to be moderatedvoid SetInput(const AuditingInput& input);// Set moderation configuration rulesvoid SetConf(const Conf& conf);// conf// Unique identifier of the moderation policy. You can configure the scenes you want to moderate on the moderation policy page in the console, such as porn, adverting, and illegal information. For configuration guides, see [Setting Moderation Policy](https://www.tencentcloud.com/document/product/436/52095).// You can get `BizType` in the console. If `BizType` is specified, the moderation request will perform moderation based on the scenes configured in the moderation policy.void SetBizType(const std::string& biz_type);// The scene to be moderated, such as `Porn` (pornography) and `Ads` (advertising). You can pass in multiple types and separate them by comma, such as `Porn,Ads`. If you need to moderate more scenes, use the `BizType` parameter.void SetDetectType(const std::string& detect_type);// Video image moderation is implemented by taking a certain number of screenshots based on the video frame capturing capability and then moderating the screenshots one by one. This parameter is used to specify the configuration of video frame capturing.void SetSnapShot(const SnapShotConf& snap_shot);// Callback address, which must start with `http://` or `https://`.void SetCallBack(const std::string& callback);// Structure of the callback content. Valid values: `Simple` (the callback content contains basic information), `Detail` (the callback content contains detailed information). Default value: `Simple`.void SetCallBackVersion(const std::string& callback_version);// Specify whether to moderate video sound. Valid values: `0` (moderates the video image only), `1` (moderates both the video image and video sound). Default value: `0`.void SetDetectContent(const int detect_content);// input// Name of the video file stored in the COS bucket; for example, if the file is `video.mp4` in the `test` directory, then the filename is `test/video.mp4`.void SetObject(const std::string& object);// Full URL of the video file, such as `http://examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/test.mp4`. Either `Object` or `Url` can be selected at a time.void SetUrl(const std::string& url);// This field will return the original content in the moderation result, which can contain up to 512 bytes. You can use this field to uniquely identify the data to be moderated in your business.void SetDataId(const std::string& data_id);// Business field.void SetUserInfo(const UserInfo& user_info);
CreateVideoAuditingResp
provides the following member functions:// Get the job details returned by the API requestVideoAuditingJobsDetail GetJobsDetail();// Get the `RequestId` returned by the APIstd::string GetRequestId();
VideoAuditingJobsDetail
structure. For specific response parameters, see Submitting Video Moderation Job.CosResult
structure. For more information, see Troubleshooting.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;// Add request parameters as detailed in the API documentationreq.SetJobId("vab1ca9fc8a3ed11ea834c525400863904");// Call the API to get the job response objectCosResult result = cos.DescribeVideoAuditingJob(req, &resp);if (result.IsSucc()) {// If the moderation job is queried successfully, you can call the member functions of `DescribeVideoAuditingJobResp`.} else {// If the moderation job failed to be queried, you can call the member functions of `CosResult` to output the error message.}
Parameter | Description | Type | Required |
req | DescribeVideoAuditingJob operation request | DescribeVideoAuditingJobReq | Yes |
resp | DescribeVideoAuditingJob operation response | DescribeVideoAuditingJobResp | Yes |
DescribeVideoAuditingJobReq
provides the following member functions:// Set the bucket for performing the operationvoid SetBucketName(const std::string& bucket_name);// Set the ID of the moderation job to be queriedvoid SetJobId(const std::string& job_id);
DescribeVideoAuditingJobResp
provides the following member functions:// Get the job details returned by the API requestVideoAuditingJobsDetail GetJobsDetail();// Get the `RequestId` returned by the APIstd::string GetRequestId();
VideoAuditingJobsDetail
structure. For specific response parameters, see Submitting Video Moderation Job.CosResult
structure. For more information, see Troubleshooting.
Was this page helpful?