StartRtcCloudTranscode - - Alibaba Cloud Documentation Center

Creates a cloud transcoding job.

Operation description

Endpoints

The following endpoints are available for this operation.

Region	Region ID	Public endpoint
Singapore	ap-southeast-1	live.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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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 contain uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-). The maximum length is 64 characters.	******-7074--9ef5-85c19a4***
ChannelId	string	Yes	The ID of the channel to which the user to be transcoded belongs. The ID can contain uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-). The maximum length is 64 characters.	myChannel
InputParam	object	Yes	The parameters for the input stream subscription.
SingleSubUserParam	object	Yes	The input parameters for a single-stream subscription.
UserId	string	Yes	The ID of the user whose stream you want to subscribe to.	userA
StreamType	integer	No	The media type of the subscribed stream. Valid values: 0 (default): The original stream, which includes both the audio and video streams. 1: The audio-only stream. (This value is not supported. The setting is invalid.) 2: The video-only stream. (This value is not supported. The setting is invalid.)	0
SourceType	integer	No	The type of the video input stream. This parameter is valid only if the subscribed media type includes a video stream. Valid values: 0 (default): The camera stream. 1: The screen sharing stream. (This value is not supported. The setting is invalid.)	0
OutputParams	array<object>	Yes	The parameters for the transcoded output.
	object	No	The parameters for a transcoded output stream.
ChannelId	string	Yes	The ID of the channel to which the transcoded stream is pushed. The ID can contain uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-). The maximum length is 64 characters. (Pushing streams to a different channel is not supported. This setting is invalid.)	myChannel
UserId	string	Yes	The user ID for the transcoded stream in the destination channel. This ID must be unique within the channel.	userA_360p
UserToken	string	Yes	The token required to push 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 in seconds. If a task cannot subscribe to the specified streamer's stream and remains idle for longer than this period, the task automatically stops. The value must be an integer from 10 to 14,400. The default value is 300.	600

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
TaskId	string	The ID of the cloud transcoding job.	****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.