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

Usage note

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

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 DescribeLiveStreamTranscodeInfo

The operation that you want to perform. Set the value to DescribeLiveStreamTranscodeInfo.

DomainTranscodeName String Yes example.com

The main streaming domain name.

Response parameters

Parameter Type Example Description
DomainTranscodeList Array of DomainTranscodeInfo

The transcoding configurations.
DomainTranscodeInfo
TranscodeName String example.com

The main streaming domain.
TranscodeApp String liveApp****

The name of the application.
TranscodeTemplate String lld

The transcoding template. Valid values:

  • Standard transcoding templates

    • lld
    • lsd
    • lhd
    • lud
  • Narrowband HD™ transcoding templates
    • ld
    • sd
    • hd
    • ud
CustomTranscodeParameters Struct

The custom transcoding configuration.
AudioBitrate Integer 64

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

AudioChannelNum Integer 2

The number of audio channels. Valid values:

  • 1: mono
  • 2: binaural
AudioCodec String ACC

The audio encoding format.
AudioProfile String aac_low

The audio codec profile. Valid values:

  • aac_low
  • aac_he
  • aac_he_v2
  • aac_ld
AudioRate Integer 44100

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.
Bframes String 0

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

FPS Integer 15

The frame rate of the output video. Unit: FPS.
Gop String 10

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

The height of the output video.
RtsFlag String true

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

TemplateType String h264

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
VideoBitrate Integer 3000

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

The video codec profile. Valid values:

  • baseline: suitable for mobile devices
  • main: suitable for standard-definition devices
  • high: suitable for high-definition devices
Width Integer 1000

The width of the output video.
EncryptParameters Struct

The encryption configuration.
EncryptType String aliyun

The type of the encryption. The value is aliyun.

KmsKeyExpireInterval String 3600

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

KmsKeyID String afce5722-81d2-43c3-9930-7601da11****

The ID of the KMS CMK.
RequestId String 62136AE6-7793-45ED-B14A-60D19A9486D3

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamTranscodeInfo
&DomainTranscodeName=example.com
&<Common request parameters>

Sample success responses

XML format 

<DescribeLiveStreamTranscodeInfoResponse>
  <RequestId>62136AE6-7793-45ED-B14A-60D19A9486D3</RequestId>
  <DomainTranscodeList>
        <DomainTranscodeInfo>
              <TranscodeTemplate>lld</TranscodeTemplate>
              <TranscodeApp>liveApp****</TranscodeApp>
              <TranscodeName>example.com</TranscodeName>
        </DomainTranscodeInfo>
        <DomainTranscodeInfo>
              <EncryptParameters>
                    <KmsKeyID>afce5722-81d2-43c3-9930-7601da11****</KmsKeyID>
                    <EncryptType>aliyun</EncryptType>
                    <KmsKeyExpireInterval>3600</KmsKeyExpireInterval>
              </EncryptParameters>
              <CustomTranscodeParameters>
                    <FPS>15</FPS>
                    <Gop>10</Gop>
                    <TemplateType>h264</TemplateType>
                    <AudioBitrate>64</AudioBitrate>
                    <Bframes>0</Bframes>
                    <AudioProfile>aac_low</AudioProfile>
                    <AudioChannelNum>2</AudioChannelNum>
                    <VideoProfile>high</VideoProfile>
                    <Height>1200</Height>
                    <RtsFlag>true</RtsFlag>
                    <Width>1000</Width>
                    <AudioRate>44100</AudioRate>
                    <AudioCodec>ACC</AudioCodec>
                    <VideoBitrate>3000</VideoBitrate>
              </CustomTranscodeParameters>
        </DomainTranscodeInfo>
  </DomainTranscodeList>
</DescribeLiveStreamTranscodeInfoResponse>

JSON format 

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

Error codes

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