tencent cloud

文档反馈

直播审核

最后更新时间:2024-03-13 11:41:11

    简介

    内容审核功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
    说明:
    使用内容审核服务需拥有数据万象使用权限:
    主账号请 单击此处 进行角色授权。
    子账号请参见 授权子账号接入数据万象服务 文档。
    本文档提供关于直播审核的 API 概览和 SDK 示例代码。
    注意:
    COS 小程序 SDK 版本需要大于等于 v1.1.1。
    API
    操作描述
    用于提交一个直播审核任务
    用于查询指定的直播审核任务

    提交直播审核任务

    功能说明

    用于提交一个直播审核任务。

    请求示例

    function postLiveAuditing() {
    var config = {
    // 需要替换成您自己的存储桶信息
    Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */
    Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
    };
    var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
    var url = 'https://' + host + '/video/auditing';
    var body = COS.util.json2xml({
    Request: {
    Type: 'live_video',
    Input: {
    Url: 'rtmp://example.com/live/123', // 需要审核的直播流播放地址
    // DataId: '',
    // UserInfo: {},
    },
    Conf: {
    BizType: '766d07a7af937c26216c51db29793ea6', // BizType 可通过控制台创建直播审核策略后获得,必填
    // Callback: 'https://callback.com', // 回调地址,非必须
    // CallbackType: 1, // 回调片段类型,非必须
    }
    }
    });
    cos.request({
    Bucket: config.Bucket,
    Region: config.Region,
    Method: 'POST',
    Url: url,
    Key: '/video/auditing',
    ContentType: 'application/xml',
    Body: body
    },
    function(err, data){
    console.log(err || data);
    });
    }
    postLiveAuditing();

    参数说明

    节点名称(关键字)
    父节点
    描述
    类型
    是否必选
    Request
    直播流审核的具体配置项。
    Container
    Container 类型 Request 的具体数据描述如下:
    节点名称(关键字)
    父节点
    描述
    类型
    是否必选
    Type
    Request
    审核的任务类型,直播流审核固定为 live_video。
    String
    Input
    Request
    包含需要审核的直播流信息。
    Container
    Conf
    Request
    包含审核规则的配置信息。
    Container
    StorageConf
    Request
    包含直播流转存的配置信息。
    Container
    Container 类型 Input 的具体数据描述如下:
    节点名称(关键字)
    父节点
    描述
    类型
    是否必选
    Url
    Request.Input
    需要审核的直播流播放地址,例如 rtmp://example.com/live/123。
    String
    DataId
    Request.Input
    该字段在审核结果中会返回原始内容,长度限制为512字节。您可以使用该字段对待审核的数据进行唯一业务标识。
    String
    UserInfo
    Request.Input
    自定义字段,可用于辅助行为数据分析。
    Container
    Container 节点 UserInfo 的内容:
    节点名称(关键字)
    父节点
    描述
    类型
    是否必选
    TokenId
    Request.Input.UserInfo
    一般用于表示账号信息,长度不超过128字节。
    String
    Nickname
    Request.Input.UserInfo
    一般用于表示昵称信息,长度不超过128字节。
    String
    DeviceId
    Request.Input.UserInfo
    一般用于表示设备信息,长度不超过128字节。
    String
    AppId
    Request.Input.UserInfo
    一般用于表示 App 的唯一标识,长度不超过128字节。
    String
    Room
    Request.Input.UserInfo
    一般用于表示房间号信息,长度不超过128字节。
    String
    IP
    Request.Input.UserInfo
    一般用于表示 IP 地址信息,长度不超过128字节。
    String
    Type
    Request.Input.UserInfo
    一般用于表示业务类型,长度不超过128字节。
    String
    ReceiveTokenId
    Request.Input.UserInfo
    一般用于表示接收消息的用户账号,长度不超过128字节。
    String
    Gender
    Request.Input.UserInfo
    一般用于表示性别信息,长度不超过128字节。
    String
    Level
    Request.Input.UserInfo
    一般用于表示等级信息,长度不超过128字节。
    String
    Role
    Request.Input.UserInfo
    一般用于表示角色信息,长度不超过128字节。
    String
    Container 类型 Conf 的具体数据描述如下:
    节点名称(关键字)
    父节点
    描述
    类型
    是否必选
    BizType
    Request.Conf
    表示审核策略的唯一标识,您可以通过控制台上的审核策略页面,配置您希望审核的场景,例如涉黄、广告、违法违规等,配置指引: 设置审核策略
    您可以在控制台上获取到 BizType。BizType 填写时,此条审核请求将按照该审核策略中配置的场景进行审核。
    String
    Callback
    Request.Conf
    回调地址,以http://或者https://开头的地址。
    String
    CallbackType
    Request.Conf
    回调片段类型,有效值:1(回调全部截帧和音频片段)、2(仅回调违规截帧和音频片段)。默认为 1。
    Integer
    Container 类型 StorageConf 的具体数据描述如下:
    节点名称(关键字)
    父节点
    描述
    类型
    是否必选
    Path
    Request.StorageConf
    表示直播流所要转存的路径,直播流的 ts 文件和 m3u8 文件将保存在本桶该目录下。
    m3u8 文件保存文件名为 Path/{$JobId}.m3u8,ts 文件的保存文件名为 Path/{$JobId}-{$Realtime}.ts,其中 Realtime 为17位年月日时分秒毫秒时间。
    String

    返回结果说明

    详情请参见 提交直播审核任务

    查询直播审核任务结果

    功能说明

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

    请求示例

    function getLiveAuditingResult() {
    var config = {
    // 需要替换成您自己的存储桶信息
    Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */
    Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
    };
    var jobId = 'av0ca69557bd6111ed904c5254009411xx'; // jobId 可以通过提交直播审核任务返回
    var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
    var url = 'https://' + host + '/video/auditing/' + jobId;
    cos.request({
    Bucket: config.Bucket,
    Region: config.Region,
    Method: 'GET',
    Key: '/video/auditing/' + jobId,
    Url: url,
    },
    function(err, data){
    console.log(err || data);
    });
    }
    getLiveAuditingResult();

    参数说明

    参数名称
    描述
    类型
    是否必选
    jobId
    需要查询的任务 ID
    String

    返回结果说明

    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持