To enable porn detection, you need to enable live screencapture first either in the CSS console or through API. This document describes how to implement porn detection through API.

Enabling Porn Detection

As the porn detection feature is based on the live screencapture feature, you have to enable screencapture first before you can enable porn detection. The steps are as follows:

1. Create a porn detection-enabled live screencapture template

Call CreateLiveSnapshotTemplate and set PornFlag to 1 to create a porn detection-enabled live screencapture template.

2. Create a porn detection-enabled live screencapture rule

Call CreateLiveSnapshotRule to create a porn detection-enabled live screencapture rule and bind the live screencapture template ID created in step 1 to the AppID, DomainName, AppName, and StreamName of the live stream that needs to undergo porn detection.

3. Start a live stream and start porn detection

After a porn detection-enabled live screencapture rule is created, the porn detection feature will be automatically enabled for new live streams. If you want to enable porn detection for a live stream that is in progress, you need to stop and restart the stream for the feature to take effect.

Getting Porn Detection Result

After porn detection is enabled, you can configure the registered callback domain name in the porn detection callback template to have the CSS backend call back the porn detection result.

Note：

By default, only suspicious results will be called back.

1. Create an porn detection callback template

Call CreateLiveCallbackTemplate and set PornCensorshipNotifyUrl to your domain name to create an porn detection callback template.

2. Create an porn detection callback rule

Call CreateLiveCallbackRule to create a porn detection-enabled screencapture rule and bind the screencapture template ID created in the previous step to the AppId, DomainName, and AppName of the live stream that needs to undergo porn detection.

3. Get the porn detection result

The CSS backend sends the porn detection result to your registered domain name through an HTTP POST request where the result is stored in the HTTP body in JSON format. You can determine whether the live stream is pornographic by the type field alone.

Note：

We recommend you use the type of an image to determine whether it is pornographic. As the detection system cannot achieve 100% accuracy, there may be false positives or false negatives, and human confirmation is recommended.

Complete protocol

AbductionRisk description

faceDetail description

gameDetails description

gameList description

Sample request

HTTP Body:

{
    "ocrMsg":"",
            
    "type":[2],
            
    "confidence":0,
            
    "normalScore":2,
            
    "hotScore":97,
            
    "pornScore":0,
            
    "screenshotTime":1575513174,
            
    "level":0,
            
    "img":"http://test-10000.cos.ap-shanghai.myqcloud.com/2019-12-05/teststream-screenshot-10-32-54-960x540.jpg",
            
    "abductionRisk":[ ],
            
    "sendTime":1575513176,
            
    "similarScore":0,
            
    "tid":20001,
            
    "streamId":"teststream",
            
    "channelId":"teststream",
            
    "stream_param":"txSecret=40f38f69f574fd51126c421a3d96c374&txTime=5DEBEC80",
            
    "app":"testlive.myqcloud.com",
            
    "appname":"live",
            
    "appid":10000
}  

Disabling CSS Porn Detection

CSS porn detection can be disabled by deleting the screencapture rule or modifying the screencapture template. Both deletion and modification are effective only for new live streams. If you want to disable CSS porn detection for a live stream that has already started, you have to stop and restart the stream.

1. Delete the porn detection-enabled screencapture rule

Call DeleteLiveSnapshotRule to delete the corresponding CSS screencapture rule under DomainName, AppName, and StreamName by template ID.

2. Delete or modify the porn detection-enabled screencapture template

Call ModifyLiveSnapshotTemplate to set the porn detection flag of the CSS screencapture template to 0.