ModifyPicture

最后更新时间:2021-10-27 16:01:45

1. API Description

Domain name for API request: trtc.tencentcloudapi.com.

This API is used to modify custom background or watermark images during On-Cloud MixTranscoding. If you do not need to modify such images frequently, we recommend you modify them in the console via Application Management > Material Management.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: ModifyPicture.
Version Yes String Common parameter. The value used for this API: 2019-07-22.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou
PictureId Yes Integer Image ID
SdkAppId Yes Integer Application ID
Height No Integer Image height
Width No Integer Image width
XPosition No Integer X-axis value of the image’s position
YPosition No Integer Y-axis value of the image’s position

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying image parameters

Input Example

https://trtc.tencentcloudapi.com/?Action=ModifyPicture
&PictureId=123456
&Height=12
&Width=15
&XPosition=15
&YPosition=36
&SdkAppId=30
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "049461e6-f2f5-4168-887e-aca4fbfa5fae"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InternalError.DBError An error occurred while querying the database.
InvalidParameter Invalid parameter.
InvalidParameter.SdkAppId SdkAppId is incorrect.
MissingParameter Missing parameter.
UnknownParameter Unknown parameter error.