tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

SetWatermark

Last updated: 2024-04-01 19:34:43

    1. API Description

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

    This API is used to configure watermarks.
    A maximum of 20 requests can be initiated per second for this API.

    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 Params. The value used for this API: SetWatermark.
    Version Yes String Common Params. The value used for this API: 2022-08-17.
    Region No String Common Params. This parameter is not required.
    SdkAppId Yes Integer The SDKAppID assigned by LCIC.
    TeacherUrl No String The URL of the watermark for the teacher’s video. If you pass in an empty string, the teacher’s video will not have a watermark.
    BoardUrl No String The URL of the watermark for the whiteboard. If you pass in an empty string, the whiteboard video will not have a watermark.
    VideoUrl No String The image displayed when there is no video. If you pass in an empty string, no images will be displayed.
    BoardW No Float The width of the whiteboard’s watermark, which is expressed as a percentage of the video width. The value range is 0-100, and the default value is 0.
    BoardH No Float The height of the whiteboard’s watermark, which is expressed as a percentage of the video height. The value range is 0-100, and the default value is 0.
    BoardX No Float The horizontal offset of the whiteboard’s watermark, which is expressed as a percentage of the video width. For example, 50 indicates that the watermark will appear in the middle horizontally. Value range: 0-100.
    BoardY No Float The vertical offset of the whiteboard’s watermark, which is expressed as a percentage of the video width. For example, 50 indicates that the watermark will appear in the middle vertically. Value range: 0-100.
    TeacherW No Float The width of the watermark for the teacher’s video, which is expressed as a percentage of the video width. The value range is 0-100, and the default value is 0.
    TeacherH No Float The height of the watermark for the teacher’s video, which is expressed as a percentage of the video height. The value range is 0-100, and the default value is 0.
    TeacherX No Float The horizontal offset of the watermark for the teacher’s video, which is expressed as a percentage of the video width. For example, 50 indicates that the watermark will appear in the middle horizontally. Value range: 0-100.
    TeacherY No Float The vertical offset of the watermark for the teacher’s video, which is expressed as a percentage of the video width. For example, 50 indicates that the watermark will appear in the middle vertically. Value range: 0-100.
    Text No String The watermark text. If you pass in an empty string, there will be no text.
    TextColor No String The watermark text color.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Configuring watermarks

    This example shows you how to configure watermarks.

    Input Example

    {
  "SdkAppId": 1,
  "TeacherUrl": "xx",
  "BoardUrl": "xx",
  "VideoUrl": "xx",
  "BoardW": 0,
  "BoardH": 0,
  "BoardX": 0,
  "BoardY": 0,
  "TeacherW": 0,
  "TeacherH": 0,
  "TeacherX": 0,
  "TeacherY": 0,
  "Text": "xx",
  "TextColor": "xx"
}

    Output Example

    {
    "Response": {
        "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 Invalid parameter.
    InvalidParameter.Content Prohibited content (pornographic, terrorist, politically sensitive) detected.
    InvalidParameter.SdkAppId SdkAppId is incorrect.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter.
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy