All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveStreamDetailFrameRateAndBitRateData

Last Updated:Dec 05, 2024

Queries the audio and video frame rates and bitrates of a Real-Time Messaging Protocol (RTMP) stream.

Operation description

  • You can call this operation to query a set of audio and video frame rates and bitrates of an RTMP stream within a specified time range.
  • This operation is used to monitor data. The data returned by this operation cannot be used as a reference to calculate resource usage for billing.
  • You can query data in the last 90 days.
  • The data is delayed for 3 to 5 minutes.
  • The maximum time range that you can specify is 1 hour.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
live:DescribeLiveStreamDetailFrameRateAndBitRateDatanone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The ingest domain or streaming domain.

example.com
AppNamestringYes

The name of the application to which the live stream belongs. You can view the application name on the Stream Management page of the ApsaraVideo Live console.

AppName
StreamNamestringYes

The name of the live stream. You can view the stream name on the Stream Management page of the ApsaraVideo Live console.

exampleStreamName
StartTimestringNo

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2017-12-21T08:00:00Z
EndTimestringNo

The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Note If the StartTime and EndTime parameters are invalid, or if the StartTime and EndTime parameters are not specified, data in the last hour is queried by default.
2017-12-22T08:00:00Z

If the StartTime and EndTime parameters are invalid, or if the StartTime and EndTime parameters are not specified, data in the last hour is queried by default.

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

FrameRateAndBitRateInfosarray<object>

The audio and video frame rates and bitrates at each time granularity.

frabrobject
AudioBitRatefloat

The audio bitrate of the live stream. Unit: bit/s.

200
AudioFrameRatefloat

The audio frame rate of the live stream. Unit: FPS.

60
BitRatefloat

The bitrate of the live stream. Unit: bit/s.

1420
StreamUrlstring

The URL of the live stream.

rtmp://example.com/AppName/exampleStreamName
Timestring

The time when the data was collected. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2016-09-13T16:04:00Z
VideoBitRatefloat

The video bitrate of the live stream. Unit: bit/s.

1200
VideoFrameRatefloat

The video frame rate of the live stream. Unit: frames per second (FPS).

30
RequestIdstring

The request ID.

BC858082-736F-4A25-867B-E5B67C85ACF7
Note The total bitrate of the live stream is calculated differently from the audio and video bitrates. As a result, the sum of the audio and video bitrates may not be equal to the total bitrate. This operation is used to monitor data. The returned data cannot be used as a reference to calculate resource usage for billing.

Examples

Sample success responses

JSONformat

{
  "FrameRateAndBitRateInfos": [
    {
      "AudioBitRate": 200,
      "AudioFrameRate": 60,
      "BitRate": 1420,
      "StreamUrl": "rtmp://example.com/AppName/exampleStreamName",
      "Time": "2016-09-13T16:04:00Z",
      "VideoBitRate": 1200,
      "VideoFrameRate": 30
    }
  ],
  "RequestId": "BC858082-736F-4A25-867B-E5B67C85ACF7"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history