tencent cloud

Feedback

CreateStreamLiveWatermark

Last updated: 2022-03-15 10:34:44

1. API Description

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

This API is used to add a watermark.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: CreateStreamLiveWatermark.
Version Yes String Common parameter. The value used for this API: 2020-03-26.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Name Yes String Watermark name
Type Yes String Watermark type. Valid values: STATIC_IMAGE, TEXT.
ImageSettings No CreateImageSettings Watermark image settings. This parameter is valid if Type is STATIC_IMAGE.
TextSettings No CreateTextSettings Watermark text settings. This parameter is valid if Type is TEXT.

3. Output Parameters

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

4. Example

Example1 Sample request

Input Example

POST / HTTP/1.1
Host: mdl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateStreamLiveWatermark
<Common request parameters>

{
    "TextSettings": {
        "XPos": 10,
        "Text": "watermark",
        "YPos": 10,
        "FontSize": 10,
        "Location": "TOP_LEFT",
        "FontColor": "0x000000"
    },
    "Type": "STATIC_IMAGE",
    "Name": "test",
    "ImageSettings": {
        "XPos": 10,
        "YPos": 10,
        "Height": 10,
        "Width": 10,
        "ImageContent": "d2F0ZXJtYXJr",
        "Location": "TOP_LEFT",
        "ImageType": "png"
    }
}

Output Example

{
  "Response": {
    "Id": "123",
    "RequestId": "xx"
  }
}

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.
InvalidParameter.ExceededQuantityLimit The quantity exceeds the limit.
InvalidParameter.ImageSettings Watermark image configuration error.
InvalidParameter.Name Invalid Name.
InvalidParameter.TextSettings Watermark text configuration error.
InvalidParameter.Type Invalid Type.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support