Sets the standard snapshot configuration for all live streams under an entry point, including the interval of snapshot capturing and whether to enable content moderation.
PATCH https://api.agora.io/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/snapshot/standard/regions/{region}
Parameter | Type | Description |
---|---|---|
appid |
String | Required. The App ID retrieved from Agora Console. |
entry_point |
String | Required. The entry point name. |
region |
String | Required. The configured region when adding the domain. |
The request body is in the JSON Object type, and contains the following fields:
Field | Type | Description |
---|---|---|
enabled |
Bool | Required. Whether to enable the snapshot capturing function:true : Enable snapshot capturing.false : Disable snapshot capturing. |
snapshotInterval |
Integer | Optional. The interval between snapshot capturings, in seconds. The default value is 10, and the value range is [5,300]. |
enableModeration |
Bool | Optional. Whether to enable content moderation:true : Enable content moderation.false : (default) Disable content moderation. |
If the returned HTTP status code is 200, the request is successful.
If the returned HTTP status code is not 200, the request fails. You can refer to the HTTP status code for possible reasons.
Request line
PATCH https://api.agora.io/v1/projects/{your_appid}/fls/entry_points/live/settings/snapshot/standard/regions/cn HTTP/1.1
Request body
{
"enabled": true,
"enableModeration": true,
"snapshotInterval": 30
}
Response line
HTTP/1.1 200 OK
Gets the standard snapshot configuration of an entry point.
GET https://api.agora.io/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/snapshot/standard/regions/{region}
Parameter | Type | Description |
---|---|---|
appid |
String | Required. The App ID retrieved from Agora Console. |
entry_point |
String | Required. The entry point name. |
region |
String | Required. The configured region when adding the domain. |
If the returned HTTP status code is 200, the request is successful, and the response body contains the following fields:
Field | Type | Description |
---|---|---|
enabled |
Bool | Whether the snapshot capturing function is enabled:true : Snapshot capturing is enabled.false : Snapshot capturing is disabled. |
snapshotInterval |
Integer | The interval between snapshot capturings, in seconds. The default value is 10, and the value range is [5,300]. |
enableModeration |
Bool | Whether content moderation is enabled:true : Content moderation is enabled.false : Content moderation is not enabled. |
If the returned HTTP status code is not 200, the request fails. You can refer to the HTTP status code for possible reasons.
Request line
GET https://api.agora.io/v1/projects/{your_appid}/fls/entry_points/live/settings/snapshot/standard/regions/cn HTTP/1.1
Response line
HTTP/1.1 200 OK
Request body
{
"enabled": true,
"enableModeration": true,
"snapshotInterval": 30
}
Status code | Description |
---|---|
200 | The request succeeds. |
400 | The parameter is invalid, for example the appid or the entry_point is empty, or the region parameter value is invalid. |
401 | Unauthorized (the customer ID and the customer secret do not match). |
404 | The server cannot find the resource according to the request, which means the requested entry point does not exist or the requested URI path is invalid. |
500 | An internal error occurs in the server, so the server is not able to complete the request. |
504 | An internal error occurs in the server. The gateway or the proxy server did not receive a timely request from the remote server. |