StartView-阿里云帮助中心

Start stream composition.

Operation description

QPS limit

This API supports a maximum of 10 calls per second per user. Exceeding this limit triggers rate limiting, which may impact your business operations. Call this API only when necessary.

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

rtc:StartView

create

*App

acs:rtc::{#accountId}:app/{#AppId}

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	Application ID. Create and view it in the console. Pass only one ID.	eo85****
ChannelId	string	Yes	Existing channel ID. Pass only one ID.	testid
TemplateId	string	Yes	Template ID.	567
TaskId	string	Yes	Task ID for this request. Pass only one ID. Use uppercase letters, lowercase letters, digits, underscores (_), or hyphens (-). Maximum length: 55 bytes.	123
CropMode	integer	No	Cropping mode. Valid values: 1: Crop while preserving aspect ratio. 2: Pad while preserving aspect ratio (default). 3: Stretch to fill.	2
StartWithoutChannel	boolean	No	Whether to start the task even if the channel does not exist. true: Yes false: No (default)
StartWithoutChannelWaitTime	integer	No	Time to wait for the channel to become available, in seconds. This parameter applies only when StartWithoutChannel is true. Valid range: 30 to 120 seconds.	30
RegionColor	object	No	Background color of the global frame.
R	integer	No	Red component value.	255
G	integer	No	Green component value.	255
B	integer	No	B	255
BgColor	object	No	Global background color.
R	integer	No	R	255
G	integer	No	Green component value.	255
B	integer	No	B.	255
ViewSubscribers	array	No	List of user IDs for SIP devices that can view the main stream or screen-sharing stream.
	string	No	User ID.	12
ViewContent	string	No	Stream type. main: Main stream screen-cast: Screen-sharing stream	main

Response elements

Element	Type	Description	Example
	object
TaskId	string	Task ID for this request.	123
RequestId	string	Request ID.	FA2F9DE9-8EAD-580E-87DF-A3D25EE87C37

Examples

Success response

JSON format

{
  "TaskId": "123",
  "RequestId": "FA2F9DE9-8EAD-580E-87DF-A3D25EE87C37"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.