Screenshot capture rules: Only I-frames are captured. After stream pushing starts, the first I-frame is captured as the first screenshot file. You can specify the capture frequency, that is, the minimum time interval between two consecutive screenshot capture operations. Assume that the capture frequency is set to 20 seconds. The first I-frame is captured as the first screenshot, the first I-frame that appears after 20 seconds (inclusive) is captured as the next screenshot file, and so on.

• To use the screenshot service, you must apply for its activation in the KLS console, and specify the callback URL and the buckets used to store screenshot files. Original screenshot files are provided in .jpg format only.
• Screenshot capture during live streaming is only available in Beijing region.

Storage rules

With screenshot overwrite disabled

Note: After you disable screenshot overwrite, the screenshot files are named in the format of {StreamName}-{UnixTimestamp}.jpg. All of the screenshot files are stored in Kingsoft Cloud Standard Storage Service (KS3).

Naming rule: {StreamName}-{UnixTimestamp}.jpg

Storage path: record/{App}/{StreamName}/picture/{UnixTimeMs}-{SessionId}/{StreamName}-{UnixTimestamp}.jpg

Example: record/myapp/mystream/picture/mystream-1587523655.jpg

Path description

With screenshot overwrite enabled

Note: After you enable screenshot overwrite, the screenshot files are named in the format of {StreamName}.jpg, and a new screenshot file automatically replaces the old one. Therefore, only the latest screenshot file is stored in KS3.

Naming rule: {StreamName}.jpg

Storage path: record/{App}/{StreamName}/picture/{StreamName}.jpg

Example: record/myapp/mystream/picture/mystream.jpg

Callback API

Configure the callback URL

You can configure in the KLS console the callback URL for when a screenshot file is generated. You are notified of the details about the screenshot through an HTTP POST request.

Sample callback

{
    "status":3,
    "taskid":"xxx",
    "type":"LiveSnapShotCallBack",
    "details":{
        "errnum":0,
        "errmsg":"",
        "uniqname":"myuniqname",
        "stream_name":"12345",
        "timestamp":1464765845,
        "srcWidth":1280,
        "srcHeight":720,
        "bucket":"myBucket",
        "items":[
            {
                "output_format":0,
                "width":480,
                "height":360,
                "setWidth":540,
                "setHeight":360,
                "intelligentSwitch":1,
                "quality":5,
                "dstpath":"upic/2016/05/11/live/1.jpg",
                "container":"webp",
                "suffix":"480"
            },
          // Historical fields, which can be ignored
             "itmes":[
        {
            "cmd":"tag=avop&f=mp4&res=1280x720&vbr=1500k&abr=128k|tag=saveas&bucket=xxx&object=cmVjb3JkL3VwbG9hZC9WMTQ1NTUwODQyNDExMjY3OC9WMTQ1NTUwODQyNDExMjY3OC5tcDQ=",
            "desc":"success",
            "keys":[
                "record/upload/V1455508424112678/xxx.mp4"
            ],
            "code":3
         }
         ]
        ]
    }
}

Parameter description