DocsICP FilingConsole
Documentation

StartRtcCloudTranscode

Updated at:
Copy as MD
Product
My Favorites

Creates a cloud transcoding task.

Operation description

Service registration endpoints

The active service registration endpoints for this operation include:

Region nameRegion IDPublic endpoint
Singaporeap-southeast-1live.ap-southeast-1.aliyuncs.com

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:StartRtcCloudTranscode

none

*All Resource

*

 None None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
AppId

string

Yes

The ID of the application to which the channel belongs. The ID can be up to 64 characters in length and can contain letters, digits, underscores (_), and hyphens (-).

********-7074-****-9ef5-85c19a4*****
ChannelId

string

Yes

The ID of the channel to which the user to be transcoded belongs. The ID can be up to 64 characters in length and can contain letters, digits, underscores (_), and hyphens (-).

myChannel
InputParam

object

Yes

The parameters related to subscription input.

SingleSubUserParam

object

Yes

The input parameters for single-stream subscription.

UserId

string

Yes

The ID of the subscribed user.

userA
StreamType

integer

No

The media type of the subscribed user. Valid values:

  • 0: Original stream, which includes both audio and video streams. This is the default value.

  • 1: Audio stream only. This value is not supported and takes no effect.

  • 2: Video stream only. This value is not supported and takes no effect.

0
SourceType

integer

No

The type of the subscribed video input stream. This parameter is valid only when the subscribed media type includes a video stream. Valid values:

  • 0: Camera. This is the default value.

  • 1: Screen sharing. This value is not supported and takes no effect.

0
OutputParams

array<object>

Yes

The parameters related to transcoding output.

object

No

The transcoding output parameters.

ChannelId

string

Yes

The ID of the channel to which the transcoded stream is pushed. The ID can be up to 64 characters in length and can contain letters, digits, underscores (_), and hyphens (-). Pushing streams to a different channel is not supported, and this setting takes no effect.

myChannel
UserId

string

Yes

The ID of the user that pushes the transcoded stream to the channel. Make sure that the user ID is different from the IDs of other users in the channel.

userA_360p
UserToken

string

Yes

The user token required for pushing the transcoded stream to the channel. For more information, see Token-based authentication.

eyJhcHBpZCI********
TranscodeTemplate

string

Yes

The name of the transcoding template. Valid values:

  • alimcopy

  • lld

  • lsd

  • lhd

  • lud

lhd
MaxIdleTime

integer

No

The idle timeout period. If the task remains idle (fails to subscribe to the specified streamer stream) for a duration exceeding this period, the task automatically stops. Unit: seconds. Valid values: 10 to 14400, which is up to 4 hours. Default value: 300.

600

Response elements

Element

Type

Description

Example

object

The response content.

RequestId

string

The request ID.

******3B-0E1A-586A-AC29-742247******
TaskId

string

The ID of the cloud transcoding task.

******73-8501-****-8ac1-72295a******

Examples

Success response

JSON format

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "TaskId": "******73-8501-****-8ac1-72295a******"
}

Error codes

HTTP status code

Error code

Error message

Description
400 InvalidParameter%s %s.
400 MissingParameter%s %s.
400 TooManyRequests %s.
500 InternalError %s. error on the live liveapi server.
403 Forbidden %s.
404 NotFound%s %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.