All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveStreamTranscodeInfo

Last Updated:Dec 12, 2024

Queries the transcoding configurations of a streaming domain.

Operation description

Obtain the main streaming domain, and then call this operation to query the transcoding configurations.

QPS limit

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

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.

example.com
AppNamestringNo

The name of the application to which the live stream belongs.

myapp

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

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

The transcoding configurations.

DomainTranscodeInfoobject

The transcoding configuration.

TranscodeAppstring

The application name.

liveApp****
TranscodeTemplatestring

The transcoding template ID. Valid values:

  • Standard transcoding:

    • lld: low definition
    • lsd: standard definition
    • lhd: high definition
    • lud: ultra-high definition
  • Narrowband HD™ transcoding:

    • ld: low definition
    • sd: standard definition
    • hd: high definition
    • ud: ultra-high definition
lld
IsLazyboolean

Indicates whether forcible transcoding is used. Valid values:

  • true: Delayed transcoding is used.
  • false: Forcible transcoding is used.
true
TranscodeNamestring

The main streaming domain.

example.com
CustomTranscodeParametersobject

The custom transcoding configuration.

BitrateWithSourceobject

The source-based bitrate settings.

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

The video encoding 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

The Real-Time Transcoding (RTS) flag. Fixed value: true.

Note This parameter is returned only if RTS is used for transcoding.
true
TemplateTypestring

The type of the custom transcoding template. Valid values:

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

Indicates whether B-frame removal is enabled. Fixed value: 0.

0
ExtWithSourceobject

Other source-based settings.

{\"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

The source-based frame rate settings.

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

The audio encoding format.

ACC
FPSinteger

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

15
Gopstring

The group of pictures (GOP) size of the output video. Unit: frames. 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 sound channels. Valid values:

  • 1: mono
  • 2: binaural
2
AudioProfilestring

The audio encoding profile. Valid values:

  • aac_low
  • aac_he
  • aac_he_v2
  • aac_ld
aac_low
ResWithSourceobject

The source-based resolution settings.

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

The encryption settings.

EncryptTypestring

The type of encryption. Fixed value: aliyun.

aliyun
KmsKeyIDstring

The ID of the customer master key (CMK) in Key Management Service (KMS).

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

The rotation period of the 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.