DescribeLiveStreamDelayConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Usage note

Obtain the streaming domain, and then call this operation to query the live streaming latency.

QPS limit

You can call this operation up to 1,000 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeLiveStreamDelayConfig	The operation that you want to perform. Set the value to DescribeLiveStreamDelayConfig.
RegionId	String	No	cn-shanghai	The ID of the region where the streaming domain resides.
DomainName	String	Yes	example.com	The streaming domain.

Response parameters


Parameter	Type	Example	Description
RequestId	String	785C9CB0-EB8A-4912-BBF2-966BEFD32DC3	The ID of the request.
LiveStreamHlsDelayConfig	Object		The latency of HLS-based playback.
Delay	Integer	3	The playback latency. Unit: seconds.
Level	String	short	The latency level. Valid values: short: The latency is less than or equal to 4 seconds. medium: The latency is greater than 4 seconds, and less than or equal to 8 seconds. long: The latency is greater than 8 seconds.
LiveStreamFlvDelayConfig	Object		The latency of FLV-based playback.
Delay	Integer	5	The playback latency. Unit: seconds.
Level	String	medium	The latency level. Valid values: short: The latency is less than or equal to 4 seconds. medium: The latency is greater than 4 seconds, and less than or equal to 8 seconds. long: The latency is greater than 8 seconds.
LiveStreamRtmpDelayConfig	Object		The latency of RTMP-based playback.
Delay	Integer	4	The playback latency. Unit: seconds.
Level	String	short	The latency level. Valid values: short: The latency is less than or equal to 4 seconds. medium: The latency is greater than 4 seconds, and less than or equal to 8 seconds. long: The latency is greater than 8 seconds.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamDelayConfig
&DomainName=example.com
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveStreamDelayConfigResponse>
    <RequestId>785C9CB0-EB8A-4912-BBF2-966BEFD32DC3</RequestId>
    <LiveStreamHlsDelayConfig>
        <Delay>3</Delay>
        <Level>short</Level>
    </LiveStreamHlsDelayConfig>
    <LiveStreamRtmpDelayConfig>
        <Delay>4</Delay>
        <Level>short</Level>
    </LiveStreamRtmpDelayConfig>
    <LiveStreamFlvDelayConfig>
        <Delay>5</Delay>
        <Level>medium</Level>
    </LiveStreamFlvDelayConfig>
</DescribeLiveStreamDelayConfigResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "785C9CB0-EB8A-4912-BBF2-966BEFD32DC3",
  "LiveStreamHlsDelayConfig" : {
    "Delay" : 3,
    "Level" : "short"
  },
  "LiveStreamRtmpDelayConfig" : {
    "Delay" : 4,
    "Level" : "short"
  },
  "LiveStreamFlvDelayConfig" : {
    "Delay" : 5,
    "Level" : "medium"
  }
}

Error codes

For a list of error codes, visit the API Error Center.


HttpCode	Error code	Error message	Description
500	Internal	The request processing has failed due to some unknown error.	The error message returned because an unknown error occurred.
404	InvalidDomain.NotFound	The domain provided does not exist in our records.	The error message returned because the domain name was not found under your Alibaba Cloud account.
403	IllegalOperation	Illegal domain operate is not permitted.	The error message returned because the current operation is not supported. For example, the specified domain name is not a streaming domain.