Adds a component to a production studio.
Operation description
Before you call this operation to add a component to a production studio, you must first create the production studio and learn about the production studio layouts. You can call this operation to add three types of components: image, text, and subtitle. For information about how to create a production studio, see CreateCaster .
QPS limit
You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:AddCasterComponent | create | *Caster acs:live:*:{#accountId}:caster/{#CasterId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| CasterId | string | Yes | The ID of the production studio.
Note
You can find the ID of the production studio in the Instance ID/Name column.
| LIVEPRODUCER_POST-cn-0pp1czt**** |
| ComponentName | string | No | The component name. By default, the component name is the component ID. | text01 |
| LocationId | string | Yes | The location ID of the component. Each location ID can be assigned to only one component and must be in the RC[Number] format. The values specified by this parameter must be in ascending order, such as RC01 to RC99. Note
If the ComponentType parameter is set to caption, the LocationId parameter specifies the location ID of the video source referenced by the component.
| RC01 |
| ComponentType | string | Yes | The component type. Valid values:
| text |
| Effect | string | No | The effect of the component. Valid values:
| animateH |
| ComponentLayer | string | Yes | The information about the component layer, such as the size and layout. This parameter contains the following fields:
The value is a JSON string. Use upper camel case for field names. | {"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]} |
| LayerOrder | string | No | The layer stacking order of the component. Valid values:
| cover |
| TextLayerContent | string | No | The information about the text layer. This parameter contains the following fields: Note
This parameter is available and required only when the ComponentType parameter is set to text.
The value is a JSON string. Use upper camel case for field names. | {"BorderWidthNormalized":"1","SizeNormalized":"0.2","Color":"0x000000","FontName":"KaiTi","BorderColor":"0x000000","Text":"hello world!"} |
| ImageLayerContent | string | No | The information about the image layer. This parameter contains the following fields: Note
This parameter is required when the ComponentType parameter is set to image.
MaterialId: the ID of the asset from the media asset library. The name that you set when you upload an asset is the ID of the asset. The value is a JSON string. Use upper camel case for field names. | {"MaterialId":"6cf724c6ebfd4a59b5b3cec6f10d****"} |
| CaptionLayerContent | string | No | The information about the caption layer. This parameter contains the following fields: Note
This parameter is required when the ComponentType parameter is set to caption.
The value is a JSON string. Use upper camel case for field names. | {"BorderWidthNormalized":0.01,"SizeNormalized":0.05,"Color":"0x000000","LocationId":"RV01","SourceLan":"cn","FontName":"KaiTi","BorderColor":"0xffffff"} |
| HtmlLayerContent | string | No | The information about the HTML5 layer. | {"htmlUrl":http://caster.example.com} |
Response parameters
Examples
Sample success responses
JSONformat
{
"ComponentId": "21926b36-7dd2-4fde-ae25-51b5bc8e****",
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | InvalidUserId.Malformed | %s |
| 400 | InvalidCasterId.Malformed | %s |
| 400 | MissingParameter | %s |
| 400 | InvalidParameter.Malformed | %s |
| 400 | InvalidPositionNormalized.Malformed | %s |
| 400 | DuplicateLocationID | %s |
| 401 | IllegalOperation | %s |
| 404 | InvalidCaster.NotFound | %s |
| 404 | CanvasNotExist | %s |
| 500 | InternalError | %s |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|