DescribeLiveStreamTranscodeInfo - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries transcoding configurations.

Operation description

Before you call this operation, you must obtain the streaming domain.

QPS limit

The queries per second (QPS) limit for a single user is 60. Exceeding this limit throttles API calls, which may affect your business. Call this operation at a reasonable rate to avoid throttling.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveStreamTranscodeInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainTranscodeName	string	Yes	The streaming domain.	example.com
AppName	string	No	The name of the application.	myapp

Response elements

Element	Type	Description	Example
	object	The transcoding configurations.
RequestId	string	The request ID.	62136AE6-7793-45ED-B14A-60D19A9486D3
DomainTranscodeList	object
DomainTranscodeInfo	array<object>	The transcoding configurations.
	array<object>	The transcoding configurations.
TranscodeApp	string	The application name.	liveApp****
TranscodeTemplate	string	The transcoding template. Valid values: Standard transcoding templates: lld: low definition. lsd: standard definition. lhd: high definition. lud: ultra-high definition. Narrowband HD™ transcoding templates: ld: low definition. sd: standard definition. hd: high definition. ud: ultra-high definition.	lld
IsLazy	boolean	Indicates whether on-demand transcoding is enabled. Valid values: true: Transcoding only starts when the first viewer requests this transcoded stream. false: Transcoding starts immediately after the stream is published.	true
TranscodeName	string	The streaming domain.	example.com
CustomTranscodeParameters	object	The custom transcoding configurations.
BitrateWithSource	object	The adaptive bitrate settings.	{\"UpLimit\":2500,\"LowerLimit\":800,\"Factor\":1}
VideoProfile	string	The video encoding profile. Valid values: baseline: suitable for mobile devices. main: suitable for standard definition (SD) devices. high: suitable for high definition (HD) devices.	high
AudioBitrate	integer	The audio bitrate for transcoding. Unit: kbps. Valid values: 1 to 1000.	64
Height	integer	The height of the transcoded video.	1200
RtsFlag	string	The tag for Real-Time Streaming (RTS). The value is fixed to true. Note This parameter is returned only for RTS transcoding.	true
TemplateType	string	The type of the custom transcoding template. Valid values: h264: a custom H.264 standard template. h264-nbhd: a custom H.264 Narrowband HD™ template. h265: a custom H.265 standard template. h265-nbhd: a custom H.265 Narrowband HD™ template. audio: an audio-only template.	h264
Bframes	string	The B-frame settings. The value is fixed to 0.	0
ExtWithSource	object	Other adaptive settings that follow the source stream.	{\"KeyFrameOpen\":\"yes\",\"Copyts\":\"yes\",\"SeiMode\":1}
AudioRate	integer	The audio sample rate. Valid values: 22050 to 96000. Note If AudioProfile is set to aac_ld, the sample rate cannot exceed 44100.	44100
FpsWithSource	object	The adaptive frame rate settings.	{\"UpLimit\":60,\"LowerLimit\":1}
AudioCodec	string	The audio coding format.	ACC
FPS	integer	The frame rate of the transcoded video. Unit: frames per second (fps).	15
Gop	string	The Group of Pictures (GOP) size. Unit: frames. Valid values: 1 to 3000.	10
Width	integer	The width of the transcoded video.	1000
VideoBitrate	integer	The video bitrate for transcoding. Unit: kbps.	3000
AudioChannelNum	integer	The number of audio channels. Valid values: 1: mono. 2: stereo.	2
AudioProfile	string	The audio encoding profile. Valid values: aac_low aac_he aac_he_v2 aac_ld	aac_low
ResWithSource	object	The adaptive resolution settings.	{\"Type\":\"short\",\"Value\":\"1080\"}
DeInterlaced	boolean
EncryptParameters	object	The encryption configurations.
EncryptType	string	The encryption type. The value is fixed to aliyun.	aliyun
KmsKeyID	string	The ID of the customer master key (CMK) in Key Management Service (KMS).	afce5722-81d2-43c3-9930-7601da11****
KmsKeyExpireInterval	string	The key rotation interval. Unit: seconds. Valid values: 60 to 3600.	3600

Examples

Success response

JSON format

{
  "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
          },
          "DeInterlaced": false
        },
        "EncryptParameters": {
          "EncryptType": "aliyun",
          "KmsKeyID": "afce5722-81d2-43c3-9930-7601da11****",
          "KmsKeyExpireInterval": "3600"
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameters	%s Please check and try again later.	Exception parameter exists, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.