Asynchronous playback

Asynchronous playback refers to purposely setting a time lag between the playback screen seen by the user and the live stream.

Currently, the asynchronous playback function only supports Push CDN mode.

Set a time lag

Sets a time lag for the specified live stream.

PATCH https://api.agora.io/v1/projects/{appid}/fls/entry_points/{entry_point}/admin/delayed_streams/{stream_name}

Parameter	Type	Description
`appid`	String	Required. The App ID retrieved from Agora Console.
`entry_point`	String	Required. The entry point name.
`stream_name`	String	Required. The stream name.

The request body is in the JSON Object type, and contains the following fields:

Field	Type	Description
`delay`	Integer	Required. The time lag in seconds, with a maximum value of 600.

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/admin/delayed_streams/{stream_name} HTTP/1.1

Response line

HTTP/1.1 200 OK

Cancels the time lag for the specified live stream.

DELETE https://api.agora.io/v1/projects/{appid}/fls/entry_points/{entry_point}/admin/delayed_streams/{stream_name}

Parameter	Type	Description
`appid`	String	Required. The App ID retrieved from Agora Console.
`entry_point`	String	Required. The entry point name.
`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 code for possible reasons.

Request line

DELETE https://api.agora.io/v1/projects/{your_appid}/fls/entry_points/live/admin/delayed_streams/{stream_name} HTTP/1.1

Response line

HTTP/1.1 200 OK

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.