All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveStreamTranscodeInfo

Last Updated:Nov 14, 2024

Queries the transcoding configurations of live streams under a main streaming domain.

Operation description

This operation is applicable to the main streaming domains.

QPS limit

A single user can perform a maximum of 60 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

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:DescribeLiveStreamTranscodeInfoget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainTranscodeNamestringYes

The main streaming domain name.

example.com
AppNamestringNo

The name of the application to which the streaming belongs.

myapp

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

62136AE6-7793-45ED-B14A-60D19A9486D3
DomainTranscodeListarray<object>

The transcoding configurations.

DomainTranscodeInfoobject

Transcoding configuration information.

TranscodeAppstring

The name of the application.

liveApp****
TranscodeTemplatestring

The transcoding template. Valid values:

  • Standard transcoding templates

    • lld
    • lsd
    • lhd
    • lud
  • Narrowband HD™ transcoding templates

    • ld
    • sd
    • hd
    • ud
lld
IsLazyboolean

Specifies whether to enable forced transcoding. Values:

  • true: Delayed transcoding.
  • false: Forced transcoding.
true
TranscodeNamestring

The main streaming domain.

example.com
CustomTranscodeParametersobject

The custom transcoding configuration.

BitrateWithSourceobject

Bitrate configuration that adapts to the source.

{\"UpLimit\":2500,\"LowerLimit\":800,\"Factor\":1}
VideoProfilestring

The video codec profile. Valid values:

  • baseline: suitable for mobile devices
  • main: suitable for standard-definition devices
  • high: suitable for high-definition devices
high
AudioBitrateinteger

The bitrate of the output audio. Unit: Kbit/s. Valid values: 1 to 1000.

64
Heightinteger

The height of the output video.

1200
RtsFlagstring

Indicates whether real-time transcoding is enabled. The value is true.

true
TemplateTypestring

The type of the custom transcoding template. Valid values:

  • h264: H.264
  • h264-nbhd: H.264 Narrowband HD™
  • h265: H.265
  • h265-nbhd: H.265 Narrowband HD™
  • audio: audio-only
h264
Bframesstring

Indicates whether B-frame removal is enabled. The value is 0.

0
ExtWithSourceobject

Other source configuration.

{\"KeyFrameOpen\":\"yes\",\"Copyts\":\"yes\",\"SeiMode\":1}
AudioRateinteger

The audio sampling rate. Valid values: 22050 to 96000.

Note If the value of AudioProfile is aac_ld, the audio sampling rate cannot exceed 44100.
44100
FpsWithSourceobject

Frame rate varies with source configuration.

{\"UpLimit\":60,\"LowerLimit\":1}
AudioCodecstring

The audio encoding format.

ACC
FPSinteger

The frame rate of the output video. Unit: FPS.

15
Gopstring

The group of pictures (GOP) of the output video. Unit: frame. Valid values: 1 to 3000.

10
Widthinteger

The width of the output video.

1000
VideoBitrateinteger

The bitrate of the output video. Unit: Kbit/s.

3000
AudioChannelNuminteger

The number of audio channels. Valid values:

  • 1: mono
  • 2: binaural
2
AudioProfilestring

The audio codec profile. Valid values:

  • aac_low
  • aac_he
  • aac_he_v2
  • aac_ld
aac_low
ResWithSourceobject

Resolution follows source configuration.

{\"Type\":\"short\",\"Value\":\"1080\"}
EncryptParametersobject

The encryption configuration.

EncryptTypestring

The type of the encryption. The value is aliyun.

aliyun
KmsKeyIDstring

The ID of the KMS CMK.

afce5722-81d2-43c3-9930-7601da11****
KmsKeyExpireIntervalstring

The validity period of the Key Management Service (KMS) customer master key (CMK). Valid values: 60 to 3600. Unit: seconds.

3600

Examples

Sample success responses

JSONformat

{
  "RequestId": "62136AE6-7793-45ED-B14A-60D19A9486D3",
  "DomainTranscodeList": {
    "DomainTranscodeInfo": [
      {
        "TranscodeApp": "liveApp****",
        "TranscodeTemplate": "lld",
        "IsLazy": true,
        "TranscodeName": "example.com",
        "CustomTranscodeParameters": {
          "BitrateWithSource": {
            "test": "test",
            "test2": 1
          },
          "VideoProfile": "high",
          "AudioBitrate": 64,
          "Height": 1200,
          "RtsFlag": "true",
          "TemplateType": "h264",
          "Bframes": "0",
          "ExtWithSource": {
            "test": "test",
            "test2": 1
          },
          "AudioRate": 44100,
          "FpsWithSource": {
            "test": "test",
            "test2": 1
          },
          "AudioCodec": "ACC",
          "FPS": 15,
          "Gop": "10",
          "Width": 1000,
          "VideoBitrate": 3000,
          "AudioChannelNum": 2,
          "AudioProfile": "aac_low",
          "ResWithSource": {
            "test": "test",
            "test2": 1
          }
        },
        "EncryptParameters": {
          "EncryptType": "aliyun",
          "KmsKeyID": "afce5722-81d2-43c3-9930-7601da11****",
          "KmsKeyExpireInterval": "3600"
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
400InvalidParameters%s

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