ModifyWatermarkTemplate

Last updated: 2020-01-13 11:44:23

    1. API Description

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

    This API is used to modify a custom watermarking template. The watermark type cannot be modified.

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

    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: ModifyWatermarkTemplate
    Version Yes String Common parameter. The value used for this API: 2019-06-12
    Region No String Common parameter. This parameter is not required for this API.
    Definition Yes Integer Unique ID of a watermarking template.
    Name No String Watermarking template name. Length limit: 64 characters.
    Comment No String Template description. Length limit: 256 characters.
    CoordinateOrigin No String Origin position. Valid values:
  • TopLeft: The origin of coordinates is in the top-left corner of the video, and the origin of the watermark is in the top-left corner of the image or text;
  • TopRight: The origin of coordinates is in the top-right corner of the video, and the origin of the watermark is in the top-right corner of the image or text;
  • BottomLeft: The origin of coordinates is in the bottom-left corner of the video, and the origin of the watermark is in the bottom-left corner of the image or text;
  • BottomRight: The origin of coordinates is in the bottom-right corner of the video, and the origin of the watermark is in the bottom-right corner of the image or text.
  • XPos No String The horizontal position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported:
  • If the string ends in %, the XPos of the watermark will be the specified percentage of the video width; for example, 10% means that XPos is 10% of the video width;
  • If the string ends in px, the XPos of the watermark will be the specified px; for example, 100px means that XPos is 100 px.
  • YPos No String The vertical position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported:
  • If the string ends in %, the YPos of the watermark will be the specified percentage of the video height; for example, 10% means that YPos is 10% of the video height;
  • If the string ends in px, the YPos of the watermark will be the specified px; for example, 100px means that YPos is 100 px.
  • ImageTemplate No ImageWatermarkInputForUpdate Image watermarking template. This field is valid only for image watermarking templates.
    TextTemplate No TextWatermarkTemplateInputForUpdate Text watermarking template. This field is valid only for text watermarking templates.
    SvgTemplate No SvgWatermarkInputForUpdate SVG watermarking template. This field is required when Type is svg and is invalid when Type is image or text.

    3. Output Parameters

    Parameter Name Type Description
    ImageUrl String Image watermark address. This field is valid only when ImageTemplate.ImageContent is non-empty.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Modifying a watermarking template

    Input Example

    https://mps.tencentcloudapi.com/?Action=ModifyWatermarkTemplate
    &Definition=1001
    &Name=Template 2
    &<Common request parameter>

    Output Example

    {
      "Response": {
        "ImageUrl": null,
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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
    FailedOperation.InvalidMpsUser Operation failed: unauthorized MPS user.
    InternalError Internal error.
    InternalError.UploadWatermarkError Internal error: failed to upload watermark image.
    InvalidParameterValue.Comment Parameter error: template description.
    InvalidParameterValue.CoordinateOrigin Incorrect parameter value: CoordinateOrigin.
    InvalidParameterValue.Height Parameter error: height.
    InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.RepeatType Parameter error: invalid RepeatType.
    InvalidParameterValue.SvgTemplateHeight Incorrect parameter value: SVG height.
    InvalidParameterValue.SvgTemplateWidth Incorrect parameter value: SVG width.
    InvalidParameterValue.TextAlpha Parameter error: text transparency.
    InvalidParameterValue.Type Parameter error: incorrect Type value.
    InvalidParameterValue.Width Parameter error: Wwdth.
    InvalidParameterValue.XPos The horizontal position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported.
    InvalidParameterValue.YPos The vertical position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported.
    ResourceNotFound.TemplateNotExist The resource does not exist: the template does not exist.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help