Skip to main content

You are viewing Agora Docs forBetaproducts and features. Switch to Docs

  • Core Products
  • Add-Ons
  • Extensions Marketplace
Android
iOS
macOS
Web
Windows
Electron
Flutter
React Native
React JS
Unity
Unreal Engine
Unreal (Blueprint)

Local screenshot upload

To meet the needs of video content supervision, Agora Video SDK enables you to take screenshots of the video stream in a channel and then upload these images to third-party cloud storage.

This page shows you how to enable screenshot uploads on your app and handle screenshot upload callbacks.

Information

Local screenshot upload is a paid service. For billing details, refer to Pricing.

Understand the tech​

When you enable screenshot upload, you set the interval between screenshots. After each interval, Video SDK takes a screenshot of the video stream sent by local users, and uploads the image to Agora SD-RTN™. Agora SD-RTN™ uploads each screenshot to your third-party cloud storage and sends a callback notification to your server in the form of an HTTPS request.

Prerequisites​

Before implementing the Agora local screenshot upload feature, take the following steps:

  1. Activate local screenshot upload service

    Log in to Agora Console, select the project for which you want to activate the local screenshot upload service, and then click Configure. Scroll down to the features section to find Video Screenshot Upload and click Config.

    Enable screenshot upload

  2. Configure third-party cloud storage

    In the Video Screenshot Upload Configuration, update the screenshot upload settings:

    Screenshot upload config

    Information

    Currently, the Agora local screenshot upload service supports Amazon S3 and Alibaba Cloud OSS as the third-party cloud storage providers. If you want to use other provider, contact technical support.

    Fill in the following information:

    • Screenshot Callback Address: The server address to receive callback notifications of local screenshot upload results.

    • Storage: Third-party cloud storage provider. Select AWS.

    • Region: The data center region setting for third-party cloud storage. See AWS Official Documentation for details.

    • Access Key: String type, the access key of the third-party cloud storage. Best practice is to provide a write-only access key.

    • Secret Key: String type, the secret key of the third-party cloud storage.

    • Bucket Name: String type, the bucket name of the third-party cloud storage. The bucket name must comply with the naming rules of the corresponding third-party cloud storage service.

    • Endpoint: Specify the access domain (Endpoint) of the bucket. See AWS Official Documentation for details.

    • Filename Prefix: (Optional) JSON Array, an array composed of multiple strings, indicating the storage location of screenshots in the third-party cloud storage. For example, if fileNamePrefix = ["directory1","directory2"], the prefix directory1/directory2/ will be added to the screenshot filename, that is, directory1/directory2/xxx.jpg. The prefix length, including slashes, must not exceed 128 characters. The string should not contain symbols such as slashes, underscores, parentheses, and so on. The supported character set is as follows:

      • 26 lowercase English letters a-z
      • 26 uppercase English letters A-Z
      • 10 digits 0-9

    Sample configuration
    • Snapshot Callback Address: https://webhook.site/2e75da2d-xxxx-xxxx-xxx-a0ef44a5259d
    • Storage: AWS
    • Region: cn-north-1
    • Access Key: 12345678
    • Secret Key: abcd123
    • Bucket Name: test-artifacts
    • Endpoint: s3.cn-north-1.amazonaws.com.cn
    • Filename Prefix: test

  3. Integrate Video SDK

    Integrate the Video SDK (including the local screenshot upload dynamic library) into your project, join a channel, and publish a video stream. See SDK quickstart for details.

Implement local screenshot upload​

You enable screenshot upload in your Broadcast Streaming client and handle the notification callback from Agora on your callback server.

Enable screenshot upload​

Call the enableContentInspect method to enable the local screenshot upload feature. After successfully enabling the feature, the SDK will capture screenshots at the specified frequency and upload them to the Agora cloud server. To implement this logic, refer to the following code:


_8
ContentInspectConfig config = new ContentInspectConfig();
_8
config.extraInfo = "YourExtraInfo";
_8
config.moduleCount = 1;
_8
// The type of the feature module is local screenshot upload
_8
config.modules[0].type = ContentInspectConfig.CONTENT_INSPECT_TYPE_SUPERVISE;
_8
// The frequency of local screenshot upload is once every 2 seconds
_8
config.modules[0].interval = 2;
_8
mRtcEngine.enableContentInspect(true, config);

HTTP notification callback​

After a screenshot is successfully uploaded to the Agora SD-RTN™, Agora sends a message notification callback to your application server in the form of an HTTPS POST request. The data format is JSON, and the character encoding is UTF-8.

Upon receiving the message notification, your application server must respond with status code 200. The expected response body format is JSON. In any of the following cases, the notification is considered to have failed:

  • No response is received from your server within 5 seconds after sending the message notification.
  • The HTTP status code of the response is not 200, or the response body format is not JSON.

The Agora service immediately retries after the first notification failure, and sends the message three times in total.

Request header​

Field NameValue
Content-Typeapplication/json;charset=utf-8

Request body​

The request body is a JSON Object, containing the following fields:

FieldTypeDescription
requestIdStringCallback notification ID, identifying an event notification from the Agora business server.
callbackParamJSON ObjectCustom fields passed in the callback, currently includes the cname field, representing the channel name.
callbackDataStringString data passed through by the SDK local screenshot upload module.
checksumStringMD5 value calculated from the parameters callbackAddr, code, object, and requestId. Used to verify whether this callback notification comes from the local screenshot upload service.
objectStringName of the screenshot file. The naming convention for this file is: <OSS prefix>/<year month day>/<sid>_<cname>__uid_s_<uid>__uid_e_<type>_utc.jpg. The meanings of the fields in the filename are as follows:
  • <sid>: Screenshot ID, a unique identifier for a screenshot.
  • <cname>: Channel name to which the user being screenshotted belongs.
  • <uid>: The user ID set when joining the channel.
  • <type>: File type, supports only video.
  • <utc>: Unix timestamp of this screenshot. UTC time, consists of year, month, day, hour, minute, second, and millisecond. For example, if utc is equal to 20190611073246073, it represents the start time of this slice file as UTC June 11, 2019, 7:32:46.073 AM.
codeNumberStatus code of this screenshot. 200 indicates that the screenshot is completed.
msgStringStatus of this screenshot. "Supervise complete" indicates that the screenshot is completed.
channelNameStringChannel name to which the user being screenshotted belongs. Consistent with object.cname.
userIdStringUser ID of the user being screenshotted. Consistent with object.uid.
timestampIntUnix timestamp (milliseconds) of this screenshot. UTC time, consistent with object.utc.
Request Example

_14
{
_14
"requestId": "38f8e3cfdcXXXXXXXXX1ceba380d7e1a_1652693284_b5813fe2ae4fa5cdfe5abd8fef82526f",
_14
"callbackParam": {
_14
"cname": "httpClient463224"
_14
},
_14
"callbackData": "",
_14
"checksum": "75ee988XXXXXXc2ad4ec2aef58f178fd8",
_14
"object": "test/20201216/38f8e3cfdc474cd56fc1ceba380d7e1a_httpClient463224__uid_s_91__uid_e_video_20200413081128672.jpg",
_14
"code": 200,
_14
"msg": "Supervise complete",
_14
"channelName": "httpClient463224",
_14
"userId": "91",
_14
"timestamp": 20190611073246070
_14
}

Response​

After receiving the message notification, your application server is expected to respond. The response package format is JSON. In any of the following cases, the Agora service considers the notification as failed:

  • After sending a message notification, no response is received from your server within 5 seconds.
  • The HTTP status code of the response is not 200, or the response body format is not JSON.

The Agora service immediately retries and sends the message notification again after the first notification fails. It attempts to notify you three times in total.

Reference​

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

local screenshot upload dynamic library​

You can find details about the name of the local screenshot upload dynamic library and the increase in app size after integration in App size optimization.

HTTP status codes​

The HTTP status codes for the application server responses are as follows:

Status CodeDescription
200Successful request.
201Successful request and creation of a new resource.
206No user streamed during the entire screenshot process, or some screenshot files were not uploaded to the third-party cloud storage.
400Syntax error in the request (For example, parameter error), and the server cannot understand it.
401Unauthorized (App ID or Customer Certificate mismatch).
404The server cannot find the requested resource (webpage).
500Internal server error, unable to complete the request.
504Internal server error. The server acting as a gateway or proxy did not receive a timely response from the upstream server.
vundefined