For AI agents: see the complete documentation index at /llms.txt.
Local screenshot upload
Updated
Take screenshots of the video stream and upload images to third-party cloud storage.
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.
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 SDRTN®. Agora SDRTN® uploads each screenshot to your third-party cloud storage and sends a callback notification to your server in the form of an HTTPS request.
Screenshot upload
Prerequisites
Before implementing the Agora local screenshot upload feature, take the following steps:
- 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.
- Configure third-party cloud storage
In the Video Screenshot Upload Configuration, update the screenshot upload settings:
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 prefixdirectory1/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
-
Screenshot Callback Address: The server address to receive callback notifications of local screenshot upload results.
-
Storage: Third-party cloud storage provider. Select Alibaba Cloud.
-
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 Alibaba Cloud 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 prefixdirectory1/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: Alibaba Cloud
- Region:
cn-north-1 - Access Key:
12345678 - Secret Key:
abcd123 - Bucket Name:
test-artifacts - Endpoint:
oss-accelerate.aliyuncs.com - Filename Prefix:
test
- 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 Video Calling 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:
ContentInspectConfig config = new ContentInspectConfig();
config.extraInfo = "YourExtraInfo";
config.moduleCount = 1;
// The type of the feature module is local screenshot upload
config.modules[0].type = ContentInspectConfig.CONTENT_INSPECT_TYPE_SUPERVISE;
// The frequency of local screenshot upload is once every 2 seconds
config.modules[0].interval = 2;
mRtcEngine.enableContentInspect(true, config);val config = ContentInspectConfig()
config.extraInfo = "YourExtraInfo"
config.moduleCount = 1
// The type of the feature module is local screenshot upload
config.modules[0].type = ContentInspectConfig.CONTENT_INSPECT_TYPE_SUPERVISE
// The frequency of local screenshot upload is once every 2 seconds
config.modules[0].interval = 2
mRtcEngine.enableContentInspect(true, config)HTTP notification callback
After a screenshot is successfully uploaded to the Agora SDRTN®, 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
HTTPstatus code of the response is not200, or the response body format is notJSON.
The Agora service immediately retries after the first notification failure, and sends the message three times in total.
Request header
| Field Name | Value |
|---|---|
Content-Type | application/json;charset=utf-8 |
Request body
The request body is a JSON Object, containing the following fields:
| Field | Type | Description |
|---|---|---|
requestId | String | Callback notification ID, identifying an event notification from the Agora business server. |
callbackParam | JSON Object | Custom fields passed in the callback, currently includes the cname field, representing the channel name. |
callbackData | String | String data passed through by the SDK local screenshot upload module. |
checksum | String | MD5 value calculated from the parameters callbackAddr, code, object, and requestId. Used to verify whether this callback notification comes from the local screenshot upload service. |
object | String | Name of the screenshot file. The naming convention for this file is: |
code | Number | Status code of this screenshot. 200 indicates that the screenshot is completed. |
msg | String | Status of this screenshot. "Supervise complete" indicates that the screenshot is completed. |
channelName | String | Channel name to which the user being screenshotted belongs. Consistent with object.cname. |
userId | String | User ID of the user being screenshotted. Consistent with object.uid. |
timestamp | Int | Unix timestamp (milliseconds) of this screenshot. UTC time, consistent with object.utc. |
Request Example
{
"requestId": "38f8e3cfdcXXXXXXXXX1ceba380d7e1a_1652693284_b5813fe2ae4fa5cdfe5abd8fef82526f",
"callbackParam": {
"cname": "httpClient463224"
},
"callbackData": "",
"checksum": "75ee988XXXXXXc2ad4ec2aef58f178fd8",
"object": "test/20201216/38f8e3cfdc474cd56fc1ceba380d7e1a_httpClient463224__uid_s_91__uid_e_video_20200413081128672.jpg",
"code": 200,
"msg": "Supervise complete",
"channelName": "httpClient463224",
"userId": "91",
"timestamp": 20190611073246070
}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.
Pricing
Agora charges for local screenshot upload based on two metrics:
- Screenshot fee
- QPS overage fee (queries per second)
At the end of each month, Agora calculates:
- The total number of screenshots generated
- The monthly peak QPS if it exceeds the free quota
Billing formula:
Monthly fee = (Number of screenshots - free quota) × Screenshot unit price
+ (Monthly peak QPS - free QPS) × QPS overage unit price| Billing Type | Unit Price | Discount Policy |
|---|---|---|
| Screenshot Fee | $0.30 per 10,000 images | First 10,000 images per month are free |
| QPS Overage Fee | $1.5 per QPS | Includes 500 QPS per month:
|
- Example 1: A project generates 910,000 screenshots in one month. Peak QPS = 100
- Screenshots: 910,000 - 10,000 (free) = 900,000 billable images
- Screenshot fee: 900,000 ÷ 10,000 × $0.30 = $27.00
- QPS fee: 100 ≤ 500 (free), so $0
- Total fee = $27.00
- Example 2: A project generates 2.91 million screenshots in one month. Peak QPS = 600
- Screenshots: 2,910,000 - 10,000 (free) = 2,900,000 billable images
- Screenshot fee: 2,900,000 ÷ 10,000 × $0.30 = $87.00
- QPS fee: (600 - 500) × $1.5 = $150.00
- Total fee = $237.00
API reference
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 Code | Description |
|---|---|
200 | Successful request. |
201 | Successful request and creation of a new resource. |
206 | No user streamed during the entire screenshot process, or some screenshot files were not uploaded to the third-party cloud storage. |
400 | Syntax error in the request (For example, parameter error), and the server cannot understand it. |
401 | Unauthorized (App ID or Customer Certificate mismatch). |
404 | The server cannot find the requested resource (webpage). |
500 | Internal server error, unable to complete the request. |
504 | Internal server error. The server acting as a gateway or proxy did not receive a timely response from the upstream server. |
This page shows you how to enable screenshot uploads on your app and handle screenshot upload callbacks.
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 SDRTN®. Agora SDRTN® uploads each screenshot to your third-party cloud storage and sends a callback notification to your server in the form of an HTTPS request.
Screenshot upload
Prerequisites
Before implementing the Agora local screenshot upload feature, take the following steps:
- 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.
- Configure third-party cloud storage
In the Video Screenshot Upload Configuration, update the screenshot upload settings:
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 prefixdirectory1/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
-
Screenshot Callback Address: The server address to receive callback notifications of local screenshot upload results.
-
Storage: Third-party cloud storage provider. Select Alibaba Cloud.
-
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 Alibaba Cloud 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 prefixdirectory1/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: Alibaba Cloud
- Region:
cn-north-1 - Access Key:
12345678 - Secret Key:
abcd123 - Bucket Name:
test-artifacts - Endpoint:
oss-accelerate.aliyuncs.com - Filename Prefix:
test
- 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 Video Calling 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:
let inspectExtraConfig = AgoraContentInspectConfig()
inspectExtraConfig.extraInfo = "YourExtraInfo"
var modules = [AgoraContentInspectModule]()
let module1 = AgoraContentInspectModule()
// The type of the feature module is local screenshot upload
module1.type = .supervise
// The frequency of local screenshot upload is once every 2 seconds
module1.interval = 2
modules.append(module1)
inspectExtraConfig.modules = modules
agoraKit.enableContentInspect(true, config:inspectExtraConfig)HTTP notification callback
After a screenshot is successfully uploaded to the Agora SDRTN®, 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
HTTPstatus code of the response is not200, or the response body format is notJSON.
The Agora service immediately retries after the first notification failure, and sends the message three times in total.
Request header
| Field Name | Value |
|---|---|
Content-Type | application/json;charset=utf-8 |
Request body
The request body is a JSON Object, containing the following fields:
| Field | Type | Description |
|---|---|---|
requestId | String | Callback notification ID, identifying an event notification from the Agora business server. |
callbackParam | JSON Object | Custom fields passed in the callback, currently includes the cname field, representing the channel name. |
callbackData | String | String data passed through by the SDK local screenshot upload module. |
checksum | String | MD5 value calculated from the parameters callbackAddr, code, object, and requestId. Used to verify whether this callback notification comes from the local screenshot upload service. |
object | String | Name of the screenshot file. The naming convention for this file is: |
code | Number | Status code of this screenshot. 200 indicates that the screenshot is completed. |
msg | String | Status of this screenshot. "Supervise complete" indicates that the screenshot is completed. |
channelName | String | Channel name to which the user being screenshotted belongs. Consistent with object.cname. |
userId | String | User ID of the user being screenshotted. Consistent with object.uid. |
timestamp | Int | Unix timestamp (milliseconds) of this screenshot. UTC time, consistent with object.utc. |
Request Example
{
"requestId": "38f8e3cfdcXXXXXXXXX1ceba380d7e1a_1652693284_b5813fe2ae4fa5cdfe5abd8fef82526f",
"callbackParam": {
"cname": "httpClient463224"
},
"callbackData": "",
"checksum": "75ee988XXXXXXc2ad4ec2aef58f178fd8",
"object": "test/20201216/38f8e3cfdc474cd56fc1ceba380d7e1a_httpClient463224__uid_s_91__uid_e_video_20200413081128672.jpg",
"code": 200,
"msg": "Supervise complete",
"channelName": "httpClient463224",
"userId": "91",
"timestamp": 20190611073246070
}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.
Pricing
Agora charges for local screenshot upload based on two metrics:
- Screenshot fee
- QPS overage fee (queries per second)
At the end of each month, Agora calculates:
- The total number of screenshots generated
- The monthly peak QPS if it exceeds the free quota
Billing formula:
Monthly fee = (Number of screenshots - free quota) × Screenshot unit price
+ (Monthly peak QPS - free QPS) × QPS overage unit price| Billing Type | Unit Price | Discount Policy |
|---|---|---|
| Screenshot Fee | $0.30 per 10,000 images | First 10,000 images per month are free |
| QPS Overage Fee | $1.5 per QPS | Includes 500 QPS per month:
|
- Example 1: A project generates 910,000 screenshots in one month. Peak QPS = 100
- Screenshots: 910,000 - 10,000 (free) = 900,000 billable images
- Screenshot fee: 900,000 ÷ 10,000 × $0.30 = $27.00
- QPS fee: 100 ≤ 500 (free), so $0
- Total fee = $27.00
- Example 2: A project generates 2.91 million screenshots in one month. Peak QPS = 600
- Screenshots: 2,910,000 - 10,000 (free) = 2,900,000 billable images
- Screenshot fee: 2,900,000 ÷ 10,000 × $0.30 = $87.00
- QPS fee: (600 - 500) × $1.5 = $150.00
- Total fee = $237.00
API reference
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 Code | Description |
|---|---|
200 | Successful request. |
201 | Successful request and creation of a new resource. |
206 | No user streamed during the entire screenshot process, or some screenshot files were not uploaded to the third-party cloud storage. |
400 | Syntax error in the request (For example, parameter error), and the server cannot understand it. |
401 | Unauthorized (App ID or Customer Certificate mismatch). |
404 | The server cannot find the requested resource (webpage). |
500 | Internal server error, unable to complete the request. |
504 | Internal server error. The server acting as a gateway or proxy did not receive a timely response from the upstream server. |
This page shows you how to enable screenshot uploads on your app and handle screenshot upload callbacks.
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 SDRTN®. Agora SDRTN® uploads each screenshot to your third-party cloud storage and sends a callback notification to your server in the form of an HTTPS request.
Screenshot upload
Prerequisites
Before implementing the Agora local screenshot upload feature, take the following steps:
- 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.
- Configure third-party cloud storage
In the Video Screenshot Upload Configuration, update the screenshot upload settings:
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 prefixdirectory1/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
-
Screenshot Callback Address: The server address to receive callback notifications of local screenshot upload results.
-
Storage: Third-party cloud storage provider. Select Alibaba Cloud.
-
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 Alibaba Cloud 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 prefixdirectory1/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: Alibaba Cloud
- Region:
cn-north-1 - Access Key:
12345678 - Secret Key:
abcd123 - Bucket Name:
test-artifacts - Endpoint:
oss-accelerate.aliyuncs.com - Filename Prefix:
test
- 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 Video Calling 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:
let inspectExtraConfig = AgoraContentInspectConfig()
inspectExtraConfig.extraInfo = "YourExtraInfo"
var modules = [AgoraContentInspectModule]()
let module1 = AgoraContentInspectModule()
// The type of the feature module is local screenshot upload
module1.type = .supervise
// The frequency of local screenshot upload is once every 2 seconds
module1.interval = 2
modules.append(module1)
inspectExtraConfig.modules = modules
agoraKit.enableContentInspect(true, config:inspectExtraConfig)HTTP notification callback
After a screenshot is successfully uploaded to the Agora SDRTN®, 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
HTTPstatus code of the response is not200, or the response body format is notJSON.
The Agora service immediately retries after the first notification failure, and sends the message three times in total.
Request header
| Field Name | Value |
|---|---|
Content-Type | application/json;charset=utf-8 |
Request body
The request body is a JSON Object, containing the following fields:
| Field | Type | Description |
|---|---|---|
requestId | String | Callback notification ID, identifying an event notification from the Agora business server. |
callbackParam | JSON Object | Custom fields passed in the callback, currently includes the cname field, representing the channel name. |
callbackData | String | String data passed through by the SDK local screenshot upload module. |
checksum | String | MD5 value calculated from the parameters callbackAddr, code, object, and requestId. Used to verify whether this callback notification comes from the local screenshot upload service. |
object | String | Name of the screenshot file. The naming convention for this file is: |
code | Number | Status code of this screenshot. 200 indicates that the screenshot is completed. |
msg | String | Status of this screenshot. "Supervise complete" indicates that the screenshot is completed. |
channelName | String | Channel name to which the user being screenshotted belongs. Consistent with object.cname. |
userId | String | User ID of the user being screenshotted. Consistent with object.uid. |
timestamp | Int | Unix timestamp (milliseconds) of this screenshot. UTC time, consistent with object.utc. |
Request Example
{
"requestId": "38f8e3cfdcXXXXXXXXX1ceba380d7e1a_1652693284_b5813fe2ae4fa5cdfe5abd8fef82526f",
"callbackParam": {
"cname": "httpClient463224"
},
"callbackData": "",
"checksum": "75ee988XXXXXXc2ad4ec2aef58f178fd8",
"object": "test/20201216/38f8e3cfdc474cd56fc1ceba380d7e1a_httpClient463224__uid_s_91__uid_e_video_20200413081128672.jpg",
"code": 200,
"msg": "Supervise complete",
"channelName": "httpClient463224",
"userId": "91",
"timestamp": 20190611073246070
}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.
Pricing
Agora charges for local screenshot upload based on two metrics:
- Screenshot fee
- QPS overage fee (queries per second)
At the end of each month, Agora calculates:
- The total number of screenshots generated
- The monthly peak QPS if it exceeds the free quota
Billing formula:
Monthly fee = (Number of screenshots - free quota) × Screenshot unit price
+ (Monthly peak QPS - free QPS) × QPS overage unit price| Billing Type | Unit Price | Discount Policy |
|---|---|---|
| Screenshot Fee | $0.30 per 10,000 images | First 10,000 images per month are free |
| QPS Overage Fee | $1.5 per QPS | Includes 500 QPS per month:
|
- Example 1: A project generates 910,000 screenshots in one month. Peak QPS = 100
- Screenshots: 910,000 - 10,000 (free) = 900,000 billable images
- Screenshot fee: 900,000 ÷ 10,000 × $0.30 = $27.00
- QPS fee: 100 ≤ 500 (free), so $0
- Total fee = $27.00
- Example 2: A project generates 2.91 million screenshots in one month. Peak QPS = 600
- Screenshots: 2,910,000 - 10,000 (free) = 2,900,000 billable images
- Screenshot fee: 2,900,000 ÷ 10,000 × $0.30 = $87.00
- QPS fee: (600 - 500) × $1.5 = $150.00
- Total fee = $237.00
API reference
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 Code | Description |
|---|---|
200 | Successful request. |
201 | Successful request and creation of a new resource. |
206 | No user streamed during the entire screenshot process, or some screenshot files were not uploaded to the third-party cloud storage. |
400 | Syntax error in the request (For example, parameter error), and the server cannot understand it. |
401 | Unauthorized (App ID or Customer Certificate mismatch). |
404 | The server cannot find the requested resource (webpage). |
500 | Internal server error, unable to complete the request. |
504 | Internal server error. The server acting as a gateway or proxy did not receive a timely response from the upstream server. |
This page shows you how to enable screenshot uploads on your app and handle screenshot upload callbacks.
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 SDRTN®. Agora SDRTN® uploads each screenshot to your third-party cloud storage and sends a callback notification to your server in the form of an HTTPS request.
Screenshot upload
Prerequisites
Before implementing the Agora local screenshot upload feature, take the following steps:
- 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.
- Configure third-party cloud storage
In the Video Screenshot Upload Configuration, update the screenshot upload settings:
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 prefixdirectory1/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
-
Screenshot Callback Address: The server address to receive callback notifications of local screenshot upload results.
-
Storage: Third-party cloud storage provider. Select Alibaba Cloud.
-
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 Alibaba Cloud 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 prefixdirectory1/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: Alibaba Cloud
- Region:
cn-north-1 - Access Key:
12345678 - Secret Key:
abcd123 - Bucket Name:
test-artifacts - Endpoint:
oss-accelerate.aliyuncs.com - Filename Prefix:
test
- 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 Video Calling 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:
const inspectConfig = {
// Set the interval for local screenshot to 2000 milliseconds (2 seconds), with a minimum value of 1000.
interval: 2000,
// (Optional) Set the address prefix for third-party cloud storage.
ossFilePrefix: 'https://your-cloud-storage.com/',
// (Optional) Add additional information.
extraInfo: 'This is some additional information for content inspection.',
// Set the function type to \"supervise\".
inspectType: ['supervise'],
};
client
.enableContentInspect(inspectConfig)
.then(() => {
console.log('Content inspection enabled successfully.');
})
.catch((error) => {
console.error('Failed to enable content inspection:', error);
});HTTP notification callback
After a screenshot is successfully uploaded to the Agora SDRTN®, 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
HTTPstatus code of the response is not200, or the response body format is notJSON.
The Agora service immediately retries after the first notification failure, and sends the message 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.
Pricing
Agora charges for local screenshot upload based on two metrics:
- Screenshot fee
- QPS overage fee (queries per second)
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 Code | Description |
|---|---|
200 | Successful request. |
201 | Successful request and creation of a new resource. |
206 | No user streamed during the entire screenshot process, or some screenshot files were not uploaded to the third-party cloud storage. |
400 | Syntax error in the request (for example, parameter error), and the server cannot understand it. |
401 | Unauthorized (App ID or Customer Certificate mismatch). |
404 | The server cannot find the requested resource (webpage). |
500 | Internal server error, unable to complete the request. |
504 | Internal server error. The server acting as a gateway or proxy did not receive a timely response from the upstream server. |
This page shows you how to enable screenshot uploads on your app and handle screenshot upload callbacks.
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 SDRTN®. Agora SDRTN® uploads each screenshot to your third-party cloud storage and sends a callback notification to your server in the form of an HTTPS request.
Screenshot upload
Prerequisites
Before implementing the Agora local screenshot upload feature, take the following steps:
- 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.
- Configure third-party cloud storage
In the Video Screenshot Upload Configuration, update the screenshot upload settings:
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 prefixdirectory1/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
-
Screenshot Callback Address: The server address to receive callback notifications of local screenshot upload results.
-
Storage: Third-party cloud storage provider. Select Alibaba Cloud.
-
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 Alibaba Cloud 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 prefixdirectory1/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: Alibaba Cloud
- Region:
cn-north-1 - Access Key:
12345678 - Secret Key:
abcd123 - Bucket Name:
test-artifacts - Endpoint:
oss-accelerate.aliyuncs.com - Filename Prefix:
test
- 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 Video Calling 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:
void CMainFrame::OnBtnEnableContentInspect() {
if (CAgoraObject::GetEngine() == NULL) {
return;
}
ContentInspectConfig config;
ContentInspectModule module1;
// The type of the feature module is local screenshot upload
module1.type = kContentInspectSupervise;
// The frequency of local screenshot upload is once every 2 seconds
module1.interval = 2;
config.moduleCount = 1;
config.modules[0] = module1;
CAgoraObject::GetEngine()->enableContentInspect(true, config);
}HTTP notification callback
After a screenshot is successfully uploaded to the Agora SDRTN®, 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
HTTPstatus code of the response is not200, or the response body format is notJSON.
The Agora service immediately retries after the first notification failure, and sends the message three times in total.
Request header
| Field Name | Value |
|---|---|
Content-Type | application/json;charset=utf-8 |
Request body
The request body is a JSON Object, containing the following fields:
| Field | Type | Description |
|---|---|---|
requestId | String | Callback notification ID, identifying an event notification from the Agora business server. |
callbackParam | JSON Object | Custom fields passed in the callback, currently includes the cname field, representing the channel name. |
callbackData | String | String data passed through by the SDK local screenshot upload module. |
checksum | String | MD5 value calculated from the parameters callbackAddr, code, object, and requestId. Used to verify whether this callback notification comes from the local screenshot upload service. |
object | String | Name of the screenshot file. The naming convention for this file is: |
code | Number | Status code of this screenshot. 200 indicates that the screenshot is completed. |
msg | String | Status of this screenshot. "Supervise complete" indicates that the screenshot is completed. |
channelName | String | Channel name to which the user being screenshotted belongs. Consistent with object.cname. |
userId | String | User ID of the user being screenshotted. Consistent with object.uid. |
timestamp | Int | Unix timestamp (milliseconds) of this screenshot. UTC time, consistent with object.utc. |
Request Example
{
"requestId": "38f8e3cfdcXXXXXXXXX1ceba380d7e1a_1652693284_b5813fe2ae4fa5cdfe5abd8fef82526f",
"callbackParam": {
"cname": "httpClient463224"
},
"callbackData": "",
"checksum": "75ee988XXXXXXc2ad4ec2aef58f178fd8",
"object": "test/20201216/38f8e3cfdc474cd56fc1ceba380d7e1a_httpClient463224__uid_s_91__uid_e_video_20200413081128672.jpg",
"code": 200,
"msg": "Supervise complete",
"channelName": "httpClient463224",
"userId": "91",
"timestamp": 20190611073246070
}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.
Pricing
Agora charges for local screenshot upload based on two metrics:
- Screenshot fee
- QPS overage fee (queries per second)
At the end of each month, Agora calculates:
- The total number of screenshots generated
- The monthly peak QPS if it exceeds the free quota
Billing formula:
Monthly fee = (Number of screenshots - free quota) × Screenshot unit price
+ (Monthly peak QPS - free QPS) × QPS overage unit price| Billing Type | Unit Price | Discount Policy |
|---|---|---|
| Screenshot Fee | $0.30 per 10,000 images | First 10,000 images per month are free |
| QPS Overage Fee | $1.5 per QPS | Includes 500 QPS per month:
|
- Example 1: A project generates 910,000 screenshots in one month. Peak QPS = 100
- Screenshots: 910,000 - 10,000 (free) = 900,000 billable images
- Screenshot fee: 900,000 ÷ 10,000 × $0.30 = $27.00
- QPS fee: 100 ≤ 500 (free), so $0
- Total fee = $27.00
- Example 2: A project generates 2.91 million screenshots in one month. Peak QPS = 600
- Screenshots: 2,910,000 - 10,000 (free) = 2,900,000 billable images
- Screenshot fee: 2,900,000 ÷ 10,000 × $0.30 = $87.00
- QPS fee: (600 - 500) × $1.5 = $150.00
- Total fee = $237.00
API reference
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 Code | Description |
|---|---|
200 | Successful request. |
201 | Successful request and creation of a new resource. |
206 | No user streamed during the entire screenshot process, or some screenshot files were not uploaded to the third-party cloud storage. |
400 | Syntax error in the request (For example, parameter error), and the server cannot understand it. |
401 | Unauthorized (App ID or Customer Certificate mismatch). |
404 | The server cannot find the requested resource (webpage). |
500 | Internal server error, unable to complete the request. |
504 | Internal server error. The server acting as a gateway or proxy did not receive a timely response from the upstream server. |
This page shows you how to enable screenshot uploads on your app and handle screenshot upload callbacks.
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 SDRTN®. Agora SDRTN® uploads each screenshot to your third-party cloud storage and sends a callback notification to your server in the form of an HTTPS request.
Screenshot upload
Prerequisites
Before implementing the Agora local screenshot upload feature, take the following steps:
- 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.
- Configure third-party cloud storage
In the Video Screenshot Upload Configuration, update the screenshot upload settings:
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 prefixdirectory1/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
-
Screenshot Callback Address: The server address to receive callback notifications of local screenshot upload results.
-
Storage: Third-party cloud storage provider. Select Alibaba Cloud.
-
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 Alibaba Cloud 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 prefixdirectory1/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: Alibaba Cloud
- Region:
cn-north-1 - Access Key:
12345678 - Secret Key:
abcd123 - Bucket Name:
test-artifacts - Endpoint:
oss-accelerate.aliyuncs.com - Filename Prefix:
test
- 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 Video Calling 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:
// Define ContentInspectModule Function Modules
const modules = [{
// Use Agora's own screenshot upload function
type: ContentInspectType.ContentInspectSupervision,
// The frequency of local screenshot upload.
interval: 2, // Once every 2 seconds
}];
rtcEngine.enableContentInspect(
// Enable local screenshot upload
true,
// Local screenshot upload configuration
{
modules: modules
moduleCount: modules.length,
}
);HTTP notification callback
After a screenshot is successfully uploaded to the Agora SDRTN®, 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
HTTPstatus code of the response is not200, or the response body format is notJSON.
The Agora service immediately retries after the first notification failure, and sends the message three times in total.
Request header
| Field Name | Value |
|---|---|
Content-Type | application/json;charset=utf-8 |
Request body
The request body is a JSON Object, containing the following fields:
| Field | Type | Description |
|---|---|---|
requestId | String | Callback notification ID, identifying an event notification from the Agora business server. |
callbackParam | JSON Object | Custom fields passed in the callback, currently includes the cname field, representing the channel name. |
callbackData | String | String data passed through by the SDK local screenshot upload module. |
checksum | String | MD5 value calculated from the parameters callbackAddr, code, object, and requestId. Used to verify whether this callback notification comes from the local screenshot upload service. |
object | String | Name of the screenshot file. The naming convention for this file is: |
code | Number | Status code of this screenshot. 200 indicates that the screenshot is completed. |
msg | String | Status of this screenshot. "Supervise complete" indicates that the screenshot is completed. |
channelName | String | Channel name to which the user being screenshotted belongs. Consistent with object.cname. |
userId | String | User ID of the user being screenshotted. Consistent with object.uid. |
timestamp | Int | Unix timestamp (milliseconds) of this screenshot. UTC time, consistent with object.utc. |
Request Example
{
"requestId": "38f8e3cfdcXXXXXXXXX1ceba380d7e1a_1652693284_b5813fe2ae4fa5cdfe5abd8fef82526f",
"callbackParam": {
"cname": "httpClient463224"
},
"callbackData": "",
"checksum": "75ee988XXXXXXc2ad4ec2aef58f178fd8",
"object": "test/20201216/38f8e3cfdc474cd56fc1ceba380d7e1a_httpClient463224__uid_s_91__uid_e_video_20200413081128672.jpg",
"code": 200,
"msg": "Supervise complete",
"channelName": "httpClient463224",
"userId": "91",
"timestamp": 20190611073246070
}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.
Pricing
Agora charges for local screenshot upload based on two metrics:
- Screenshot fee
- QPS overage fee (queries per second)
At the end of each month, Agora calculates:
- The total number of screenshots generated
- The monthly peak QPS if it exceeds the free quota
Billing formula:
Monthly fee = (Number of screenshots - free quota) × Screenshot unit price
+ (Monthly peak QPS - free QPS) × QPS overage unit price| Billing Type | Unit Price | Discount Policy |
|---|---|---|
| Screenshot Fee | $0.30 per 10,000 images | First 10,000 images per month are free |
| QPS Overage Fee | $1.5 per QPS | Includes 500 QPS per month:
|
- Example 1: A project generates 910,000 screenshots in one month. Peak QPS = 100
- Screenshots: 910,000 - 10,000 (free) = 900,000 billable images
- Screenshot fee: 900,000 ÷ 10,000 × $0.30 = $27.00
- QPS fee: 100 ≤ 500 (free), so $0
- Total fee = $27.00
- Example 2: A project generates 2.91 million screenshots in one month. Peak QPS = 600
- Screenshots: 2,910,000 - 10,000 (free) = 2,900,000 billable images
- Screenshot fee: 2,900,000 ÷ 10,000 × $0.30 = $87.00
- QPS fee: (600 - 500) × $1.5 = $150.00
- Total fee = $237.00
API reference
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 Code | Description |
|---|---|
200 | Successful request. |
201 | Successful request and creation of a new resource. |
206 | No user streamed during the entire screenshot process, or some screenshot files were not uploaded to the third-party cloud storage. |
400 | Syntax error in the request (For example, parameter error), and the server cannot understand it. |
401 | Unauthorized (App ID or Customer Certificate mismatch). |
404 | The server cannot find the requested resource (webpage). |
500 | Internal server error, unable to complete the request. |
504 | Internal server error. The server acting as a gateway or proxy did not receive a timely response from the upstream server. |
This page shows you how to enable screenshot uploads on your app and handle screenshot upload callbacks.
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 SDRTN®. Agora SDRTN® uploads each screenshot to your third-party cloud storage and sends a callback notification to your server in the form of an HTTPS request.
Screenshot upload
Prerequisites
Before implementing the Agora local screenshot upload feature, take the following steps:
- 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.
- Configure third-party cloud storage
In the Video Screenshot Upload Configuration, update the screenshot upload settings:
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 prefixdirectory1/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
-
Screenshot Callback Address: The server address to receive callback notifications of local screenshot upload results.
-
Storage: Third-party cloud storage provider. Select Alibaba Cloud.
-
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 Alibaba Cloud 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 prefixdirectory1/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: Alibaba Cloud
- Region:
cn-north-1 - Access Key:
12345678 - Secret Key:
abcd123 - Bucket Name:
test-artifacts - Endpoint:
oss-accelerate.aliyuncs.com - Filename Prefix:
test
- 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 Video Calling 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:
// Define ContentInspectModule Function Modules
const modules = [{
// Use Agora's own screenshot upload function
type: ContentInspectType.ContentInspectSupervision,
// The frequency of local screenshot upload.
interval: 2, // Once every 2 seconds
}];
rtcEngine.enableContentInspect(
// Enable local screenshot upload
true,
// Local screenshot upload configuration
{
modules: modules
moduleCount: modules.length,
}
);HTTP notification callback
After a screenshot is successfully uploaded to the Agora SDRTN®, 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
HTTPstatus code of the response is not200, or the response body format is notJSON.
The Agora service immediately retries after the first notification failure, and sends the message three times in total.
Request header
| Field Name | Value |
|---|---|
Content-Type | application/json;charset=utf-8 |
Request body
The request body is a JSON Object, containing the following fields:
| Field | Type | Description |
|---|---|---|
requestId | String | Callback notification ID, identifying an event notification from the Agora business server. |
callbackParam | JSON Object | Custom fields passed in the callback, currently includes the cname field, representing the channel name. |
callbackData | String | String data passed through by the SDK local screenshot upload module. |
checksum | String | MD5 value calculated from the parameters callbackAddr, code, object, and requestId. Used to verify whether this callback notification comes from the local screenshot upload service. |
object | String | Name of the screenshot file. The naming convention for this file is: |
code | Number | Status code of this screenshot. 200 indicates that the screenshot is completed. |
msg | String | Status of this screenshot. "Supervise complete" indicates that the screenshot is completed. |
channelName | String | Channel name to which the user being screenshotted belongs. Consistent with object.cname. |
userId | String | User ID of the user being screenshotted. Consistent with object.uid. |
timestamp | Int | Unix timestamp (milliseconds) of this screenshot. UTC time, consistent with object.utc. |
Request Example
{
"requestId": "38f8e3cfdcXXXXXXXXX1ceba380d7e1a_1652693284_b5813fe2ae4fa5cdfe5abd8fef82526f",
"callbackParam": {
"cname": "httpClient463224"
},
"callbackData": "",
"checksum": "75ee988XXXXXXc2ad4ec2aef58f178fd8",
"object": "test/20201216/38f8e3cfdc474cd56fc1ceba380d7e1a_httpClient463224__uid_s_91__uid_e_video_20200413081128672.jpg",
"code": 200,
"msg": "Supervise complete",
"channelName": "httpClient463224",
"userId": "91",
"timestamp": 20190611073246070
}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.
Pricing
Agora charges for local screenshot upload based on two metrics:
- Screenshot fee
- QPS overage fee (queries per second)
At the end of each month, Agora calculates:
- The total number of screenshots generated
- The monthly peak QPS if it exceeds the free quota
Billing formula:
Monthly fee = (Number of screenshots - free quota) × Screenshot unit price
+ (Monthly peak QPS - free QPS) × QPS overage unit price| Billing Type | Unit Price | Discount Policy |
|---|---|---|
| Screenshot Fee | $0.30 per 10,000 images | First 10,000 images per month are free |
| QPS Overage Fee | $1.5 per QPS | Includes 500 QPS per month:
|
- Example 1: A project generates 910,000 screenshots in one month. Peak QPS = 100
- Screenshots: 910,000 - 10,000 (free) = 900,000 billable images
- Screenshot fee: 900,000 ÷ 10,000 × $0.30 = $27.00
- QPS fee: 100 ≤ 500 (free), so $0
- Total fee = $27.00
- Example 2: A project generates 2.91 million screenshots in one month. Peak QPS = 600
- Screenshots: 2,910,000 - 10,000 (free) = 2,900,000 billable images
- Screenshot fee: 2,900,000 ÷ 10,000 × $0.30 = $87.00
- QPS fee: (600 - 500) × $1.5 = $150.00
- Total fee = $237.00
API reference
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 Code | Description |
|---|---|
200 | Successful request. |
201 | Successful request and creation of a new resource. |
206 | No user streamed during the entire screenshot process, or some screenshot files were not uploaded to the third-party cloud storage. |
400 | Syntax error in the request (For example, parameter error), and the server cannot understand it. |
401 | Unauthorized (App ID or Customer Certificate mismatch). |
404 | The server cannot find the requested resource (webpage). |
500 | Internal server error, unable to complete the request. |
504 | Internal server error. The server acting as a gateway or proxy did not receive a timely response from the upstream server. |
This page shows you how to enable screenshot uploads on your game and handle screenshot upload callbacks.
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 SDRTN®. Agora SDRTN® uploads each screenshot to your third-party cloud storage and sends a callback notification to your server in the form of an HTTPS request.
Screenshot upload
Prerequisites
Before implementing the Agora local screenshot upload feature, take the following steps:
- 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.
- Configure third-party cloud storage
In the Video Screenshot Upload Configuration, update the screenshot upload settings:
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 prefixdirectory1/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
-
Screenshot Callback Address: The server address to receive callback notifications of local screenshot upload results.
-
Storage: Third-party cloud storage provider. Select Alibaba Cloud.
-
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 Alibaba Cloud 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 prefixdirectory1/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: Alibaba Cloud
- Region:
cn-north-1 - Access Key:
12345678 - Secret Key:
abcd123 - Bucket Name:
test-artifacts - Endpoint:
oss-accelerate.aliyuncs.com - Filename Prefix:
test
- 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 Video Calling 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:
private void OnStartButtonClick()
{
var config = new ContentInspectConfig();
config.modules = new ContentInspectModule[1];
// The type of the feature module is local screenshot upload
config.modules[0] = new ContentInspectModule
{
type = CONTENT_INSPECT_TYPE.CONTENT_INSPECT_SUPERVISION,
// The frequency of local screenshot upload
interval = 2 // Once every 2 seconds
};
config.moduleCount =
var nRet = RtcEngine.EnableContentInspect(true, config);
this.Log.UpdateLog("StartContentInspect: " + nRet);
}HTTP notification callback
After a screenshot is successfully uploaded to the Agora SDRTN®, 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
HTTPstatus code of the response is not200, or the response body format is notJSON.
The Agora service immediately retries after the first notification failure, and sends the message three times in total.
Request header
| Field Name | Value |
|---|---|
Content-Type | application/json;charset=utf-8 |
Request body
The request body is a JSON Object, containing the following fields:
| Field | Type | Description |
|---|---|---|
requestId | String | Callback notification ID, identifying an event notification from the Agora business server. |
callbackParam | JSON Object | Custom fields passed in the callback, currently includes the cname field, representing the channel name. |
callbackData | String | String data passed through by the SDK local screenshot upload module. |
checksum | String | MD5 value calculated from the parameters callbackAddr, code, object, and requestId. Used to verify whether this callback notification comes from the local screenshot upload service. |
object | String | Name of the screenshot file. The naming convention for this file is: |
code | Number | Status code of this screenshot. 200 indicates that the screenshot is completed. |
msg | String | Status of this screenshot. "Supervise complete" indicates that the screenshot is completed. |
channelName | String | Channel name to which the user being screenshotted belongs. Consistent with object.cname. |
userId | String | User ID of the user being screenshotted. Consistent with object.uid. |
timestamp | Int | Unix timestamp (milliseconds) of this screenshot. UTC time, consistent with object.utc. |
Request Example
{
"requestId": "38f8e3cfdcXXXXXXXXX1ceba380d7e1a_1652693284_b5813fe2ae4fa5cdfe5abd8fef82526f",
"callbackParam": {
"cname": "httpClient463224"
},
"callbackData": "",
"checksum": "75ee988XXXXXXc2ad4ec2aef58f178fd8",
"object": "test/20201216/38f8e3cfdc474cd56fc1ceba380d7e1a_httpClient463224__uid_s_91__uid_e_video_20200413081128672.jpg",
"code": 200,
"msg": "Supervise complete",
"channelName": "httpClient463224",
"userId": "91",
"timestamp": 20190611073246070
}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.
Pricing
Agora charges for local screenshot upload based on two metrics:
- Screenshot fee
- QPS overage fee (queries per second)
At the end of each month, Agora calculates:
- The total number of screenshots generated
- The monthly peak QPS if it exceeds the free quota
Billing formula:
Monthly fee = (Number of screenshots - free quota) × Screenshot unit price
+ (Monthly peak QPS - free QPS) × QPS overage unit price| Billing Type | Unit Price | Discount Policy |
|---|---|---|
| Screenshot Fee | $0.30 per 10,000 images | First 10,000 images per month are free |
| QPS Overage Fee | $1.5 per QPS | Includes 500 QPS per month:
|
- Example 1: A project generates 910,000 screenshots in one month. Peak QPS = 100
- Screenshots: 910,000 - 10,000 (free) = 900,000 billable images
- Screenshot fee: 900,000 ÷ 10,000 × $0.30 = $27.00
- QPS fee: 100 ≤ 500 (free), so $0
- Total fee = $27.00
- Example 2: A project generates 2.91 million screenshots in one month. Peak QPS = 600
- Screenshots: 2,910,000 - 10,000 (free) = 2,900,000 billable images
- Screenshot fee: 2,900,000 ÷ 10,000 × $0.30 = $87.00
- QPS fee: (600 - 500) × $1.5 = $150.00
- Total fee = $237.00
API reference
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 Code | Description |
|---|---|
200 | Successful request. |
201 | Successful request and creation of a new resource. |
206 | No user streamed during the entire screenshot process, or some screenshot files were not uploaded to the third-party cloud storage. |
400 | Syntax error in the request (For example, parameter error), and the server cannot understand it. |
401 | Unauthorized (App ID or Customer Certificate mismatch). |
404 | The server cannot find the requested resource (webpage). |
500 | Internal server error, unable to complete the request. |
504 | Internal server error. The server acting as a gateway or proxy did not receive a timely response from the upstream server. |