控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

视频审核

最近更新时间:2021-12-20 17:40:39

简介

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

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

提交视频审核任务

功能说明

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

方法原型

VideoAuditingResponse createVideoAuditingJob(VideoAuditingRequest request);

请求示例

//1.创建任务请求对象
VideoAuditingRequest request = new VideoAuditingRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("examplebucket-1250000000");
request.getInput().setObject("1.mp4");
request.getConf().setDetectType("Porn,Ads");
request.getConf().getSnapshot().setCount("10");
request.getConf().getSnapshot().setMode("Interval");
request.getConf().getSnapshot().setTimeInterval("10");
//3.调用接口,获取任务响应对象
VideoAuditingResponse response = client.createVideoAuditingJob(request);

参数说明

Request 中的具体数据描述如下:

节点名称(关键字) 父节点 描述 类型 是否必选
Input Request 需要审核的视频。 Container
Conf Request 审核规则配置。 Container

Container 类型 Input 的具体数据描述如下:

节点名称(关键字) 父节点 描述 类型 是否必选
Object Request.Input 当前 COS 存储桶中的视频文件名称,例如在目录 test 中的文件 video.mp4,则文件名称为 test/video.mp4。 String
Url Request.Input 视频文件的链接地址,例如 http://examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/test.mp4。Object 和 Url 只能选择其中一种。 String

Container 类型 Conf 的具体数据描述如下:

节点名称(关键字) 父节点 描述 类型 是否必选
DetectType Request.Conf 审核的场景类型,有效值:Porn(涉黄)、Ads(广告),可以传入多种类型,不同类型以逗号分隔,例如:Porn,Ads。 String
Snapshot Request.Conf 视频画面的审核通过视频截帧能力截取出一定量的截图,通过对截图逐一审核而实现的,该参数用于指定视频截帧的配置。 Container
Callback Request.Conf 回调地址,以http://或者https://开头的地址。 String
CallbackVersion Request.Conf 回调内容的结构,有效值:Simple(回调内容包含基本信息)、Detail(回调内容包含详细信息)。默认为 Simple。 String
BizType Request.Conf 审核策略,不带审核策略时使用默认策略。 String
DetectContent Request.Conf 用于指定是否审核视频声音,当值为0时:表示只审核视频画面截图;值为1时:表示同时审核视频画面截图和视频声音。默认值为0。 Integer

Container 类型 Snapshot 的具体数据描述如下:

节点名称(关键字) 父节点 描述 类型 是否必选
Mode Request.Conf.Snapshot 截帧模式。Interval 表示间隔模式;Average 表示平均模式;Fps 表示固定帧率模式。
  • Interval 模式:TimeInterval,Count 参数生效。当设置 Count,未设置 TimeInterval 时,表示截取所有帧,共 Count 张图片。
  • Average 模式:Count 参数生效。表示整个视频,按平均间隔截取共 Count 张图片。
  • Fps 模式:TimeInterval 表示每秒截取多少帧,Count 表示共截取多少帧。
  • String
    Count Request.Conf.Snapshot 视频截帧数量,范围为(0, 10000]。 String
    TimeInterval Request.Conf.Snapshot 视频截帧频率,范围为(0, 60],单位为秒,支持 float 格式,执行精度精确到毫秒。 Float

    返回结果说明

    • 成功:成功则返回 VideoAuditingResponse 媒体审核任务结果对象。
    • 失败:发生错误(例如 Bucket 不存在),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理

    查询视频审核任务

    功能说明

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

    方法原型

    VideoAuditingResponse describeAuditingJob(VideoAuditingRequest request);

    请求示例

    //1.创建任务请求对象
    VideoAuditingRequest request = new VideoAuditingRequest();
    //2.添加请求参数 参数详情请见api接口文档
    request.setBucketName("examplebucket-1250000000");
    request.setJobId("av81591b4bbd2211eb80235254008*****");
    //3.调用接口,获取任务响应对象
    VideoAuditingResponse response = client.describeAuditingJob(request);

    参数说明

    参数名称 描述 类型 是否必选
    bucketName Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述 String
    jobId 需要查询的任务id String

    返回结果说明

    • 成功: 返回 VideoAuditingResponse 审核任务结果对象。
    • 失败: 发生错误(如身份认证失败),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理
    目录