DescribeLiveDomainFrameRateAndBitRateData - ApsaraVideo Live

Usage notes

You can call this operation to query the real-time bitrates and frame rates of live streams, which helps you evaluate the stream ingest quality. A delay exists in data collection and statistics. We recommend that you query the data of more than 5 minutes ago.

Note Use this operation to replace the deprecated DescribeLiveStreamsFrameRateAndBitRateData operation.

QPS limit

You can call this operation up to 100 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 limits.

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	DescribeLiveDomainFrameRateAndBitRateData	The operation that you want to perform. Set the value to DescribeLiveDomainFrameRateAndBitRateData.
DomainName	String	Yes	demo.aliyundoc.com	The ingest domain.
QueryTime	String	Yes	2019-02-21T08:00:00Z	The point of time to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Response parameters

Parameter	Type	Example	Description
RequestId	String	C3F2C2C4-59BB-4B62-81FF-345BE557E3E3	The request ID.
FrameRateAndBitRateInfos	Array of FrameRateAndBitRateInfo		The frame rates and bitrates of the live streams that were queried.
FrameRateAndBitRateInfo
VideoFrameRate	Float	24.9	The video frame rate of the live stream. Unit: frames per second (FPS).
StreamUrl	String	rtmp://demo.aliyundoc.com/test/liveStream****_3_4	The URL of the live stream.
AudioFrameRate	Float	42.9	The audio frame rate of the live stream. Unit: FPS.
BitRate	Float	30693.96	The bitrate of the live stream. Unit: bit/s.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainFrameRateAndBitRateData
&DomainName=demo.aliyundoc.com
&QueryTime=2019-02-21T08:00:00Z
&<Common request parameters>

Sample success responses

XML format

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

<DescribeLiveDomainFrameRateAndBitRateDataResponse>
    <RequestId>C3F2C2C4-59BB-4B62-81FF-345BE557E3E3</RequestId>
    <FrameRateAndBitRateInfos>
        <FrameRateAndBitRateInfo>
            <VideoFrameRate>24.9</VideoFrameRate>
            <BitRate>30693.96</BitRate>
            <AudioFrameRate>42.9</AudioFrameRate>
            <StreamUrl>rtmp://demo.aliyundoc.com/test/liveStream****_3_4</StreamUrl>
        </FrameRateAndBitRateInfo>
    </FrameRateAndBitRateInfos>
</DescribeLiveDomainFrameRateAndBitRateDataResponse>

JSON format

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

{
  "RequestId" : "C3F2C2C4-59BB-4B62-81FF-345BE557E3E3",
  "FrameRateAndBitRateInfos" : {
    "FrameRateAndBitRateInfo" : {
      "VideoFrameRate" : 24.9,
      "BitRate" : 30693.96,
      "AudioFrameRate" : 42.9,
      "StreamUrl" : "rtmp://demo.aliyundoc.com/test/liveStream****_3_4"
    }
  }
}

Error codes

For a list of error codes, see Service error codes.