Modifies a component of a production studio.
Usage note
This interface currently supports modifying three types of components: pictures, text, and subtitles.
QPS limit
A single user can perform a maximum of 10 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ModifyCasterComponent |
The operation that you want to perform. Set the value to ModifyCasterComponent. |
CasterId | String | Yes | 9ff2d96b-37ef-40a3-8cb0-4c7b1e2e**** |
The ID of the production studio. If you create a production studio through the CreateCaster interface, check the value of the CasterId parameter in the response. If you create a production studio through the ApsaraVideo Live Console, log in to the console, then check the ID of the production studio through the following path: Production Studios > Production Studio Management Note The CasterId is reflected in the Name column on the Production Studio Management page.
|
ComponentId | String | Yes | 05ab713c-676e-49c0-96ce-cc408da1**** |
The ID of the component. It is included in the response when you call the AddCasterComponent operation. |
ComponentName | String | No | text01 |
The name of the component. By default, the name is the ID of the component. |
ComponentType | String | No | text |
The type of the component. Valid values:
|
Effect | String | No | animateV |
The effect for the component. Valid values:
|
ComponentLayer | String | No | null |
The information about the component layer, such as the size and layout, in the JSON format. This parameter contains the following fields:
|
TextLayerContent | String | No | null |
The information about the text layer, in the JSON format. This parameter contains the following fields:
Note This parameter is required when the ComponentType parameter is set to text.
|
ImageLayerContent | String | No | null |
The information about the image layer, in the JSON format. This parameter contains the following fields: MaterialId: the ID of the asset from the media asset library. Note This parameter is required when the ComponentType parameter is set to image.
|
CaptionLayerContent | String | No | null |
The information about the caption layer, in the JSON format. This parameter contains the following fields:
Note This parameter is required when the ComponentType parameter is set to caption.
|
Description of available fonts in a production studio
Font |
Value for FontName |
---|---|
KaiTi |
KaiTi |
Alibaba PuHuiTi-Regular |
AlibabaPuHuiTi-Regular |
Alibaba PuHuiTi-Bold |
AlibabaPuHuiTi-Bold |
Alibaba PuHuiTi-Light |
AlibabaPuHuiTi-Light |
Source Han Sans-Regular |
NotoSansHans-Regular |
Source Han Sans-Bold |
NotoSansHans-Bold |
Source Han Sans-Light |
NotoSansHans-Light |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
The ID of the request. |
ComponentId | String | 05ab713c-676e-49c0-96ce-cc408da1**** |
The ID of the component. |
Examples
Sample requests
http(s)://live.aliyuncs.com/?Action=ModifyCasterComponent
&CasterId=9ff2d96b-37ef-40a3-8cb0-4c7b1e2e****
&ComponentId=05ab713c-676e-49c0-96ce-cc408da1****
&<Common request parameters>
Sample success responses
XML
format
<ModifyCasterComponentResponse>
<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
<ComponentId>21926b36-7dd2-4fde-ae25-51b5bc8e5****</ComponentId>
</ModifyCasterComponentResponse>
JSON
format
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
"ComponentId": "21926b36-7dd2-4fde-ae25-51b5bc8e****"
}
Error codes
For a list of error codes, visit the API Error Center.