Enables custom recording for a live stream under the specified entry point.
This API records a stream that is being pushed or is scheduled to be pushed in the next 24 hours. Recording automatically starts and ends when streaming starts and ends.
PUT https://api.agora.io/v1/projects/{appid}/fls/entry_points/{entry_point}/admin/record/custom/regions/{region}/tasks?id={stream_name}
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 area to enable recording. |
stream_name |
String | Required. The stream name. |
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 codes for possible reasons.
Request line
PUT https://api.agora.io/v1/projects/{your_appid}/fls/entry_points/live/admin/record/custom/regions/{region}/tasks?id={stream_name} HTTP/1.1
Response line
HTTP/1.1 200 OK
Disables custom recording for a live stream.
DELETE https://api.agora.io/v1/projects/{appid}/fls/entry_points/{entry_point}/admin/record/custom/regions/{region}/tasks/{stream_name}
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 area to disable recording. |
stream_name |
String | Required. The stream name. |
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 codes for possible reasons.
Request line
DELETE https://api.agora.io/v1/projects/{appid}/fls/entry_points/{entry_point}/admin/record/custom/regions/{region}/tasks/{stream_name} HTTP/1.1
Response line
HTTP/1.1 200 OK
3fca7b40-c158-11ec-8e95-1b7dfd4b7cb0