DescribeLiveStreamTranscodeInfo - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries transcoding configurations.

Operation description

You must obtain the streaming domain before you 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 may experience service interruptions.

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 main streaming domain.	example.com
AppName	string	No	The AppName of the live stream.	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 AppName.	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 main streaming domain.	example.com
CustomTranscodeParameters	object	The custom transcoding configurations.
BitrateWithSource	object	The configuration for adaptive bitrate.	{\"UpLimit\":2500,\"LowerLimit\":800,\"Factor\":1}
VideoProfile	string	The video codec profile. Valid values: baseline: suitable for mobile devices. main: suitable for SD devices. high: suitable for HD devices.	high
AudioBitrate	integer	The audio bitrate. Unit: kbps. Valid values: 1 to 1000.	64
Height	integer	The output video height.	1200
RtsFlag	string	The tag for Real-Time Streaming (RTS). The value is fixed to true. Note This parameter is returned only when RTS is used.	true
TemplateType	string	The type of the custom transcoding template. Valid values: h264: H.264 standard transcoding. h264-nbhd: H.264 Narrowband HD™ transcoding. h265: H.265 standard transcoding. h265-nbhd: H.265 Narrowband HD™ transcoding. audio: audio-only transcoding.	h264
Bframes	string	Controls whether to remove B-frames from the transcoded output video. The value is fixed to 0.	0
ExtWithSource	object	Other adaptive settings that align the transcoded stream with 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	Adapts the output frame rate based on the source's frame rate, while keeping it within a specified range.	{\"UpLimit\":60,\"LowerLimit\":1}
AudioCodec	string	The audio codec.	ACC
FPS	integer	The output video frame rate. 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 output video width.	1000
VideoBitrate	integer	The video bitrate. Unit: kbps.	3000
AudioChannelNum	integer	The number of audio channels. Valid values: 1: mono. 2: stereo.	2
AudioProfile	string	The audio codec 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	Indicates whether to automatically detect and remove interlacing during transcoding. This converts interlaced content to progressive content. true: Deinterlacing is enabled. false: The source format is retained. No processing is performed. This is the default value.
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 period. 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.