com.tencentcloudapi.mps.v20190612.models.CreateWatermarkTemplateRequest Maven / Gradle / Ivy
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tencentcloudapi.mps.v20190612.models;
import com.tencentcloudapi.common.AbstractModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class CreateWatermarkTemplateRequest extends AbstractModel{
/**
* Watermarking type. Valid values:
image: Image watermark;
text: Text watermark;
svg: SVG watermark.
*/
@SerializedName("Type")
@Expose
private String Type;
/**
* Watermarking template name. Length limit: 64 characters.
*/
@SerializedName("Name")
@Expose
private String Name;
/**
* Template description. Length limit: 256 characters.
*/
@SerializedName("Comment")
@Expose
private String Comment;
/**
* 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.
Default value: TopLeft.
*/
@SerializedName("CoordinateOrigin")
@Expose
private String CoordinateOrigin;
/**
* 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.
Default value: 0 px.
*/
@SerializedName("XPos")
@Expose
private String XPos;
/**
* 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.
Default value: 0 px.
*/
@SerializedName("YPos")
@Expose
private String YPos;
/**
* Image watermarking template. This field is required and valid only when `Type` is `image`.
*/
@SerializedName("ImageTemplate")
@Expose
private ImageWatermarkInput ImageTemplate;
/**
* Text watermarking template. This field is required and valid only when `Type` is `text`.
*/
@SerializedName("TextTemplate")
@Expose
private TextWatermarkTemplateInput TextTemplate;
/**
* SVG watermarking template. This field is required and valid only when `Type` is `svg`.
*/
@SerializedName("SvgTemplate")
@Expose
private SvgWatermarkInput SvgTemplate;
/**
* Get Watermarking type. Valid values:
image: Image watermark;
text: Text watermark;
svg: SVG watermark.
* @return Type Watermarking type. Valid values:
image: Image watermark;
text: Text watermark;
svg: SVG watermark.
*/
public String getType() {
return this.Type;
}
/**
* Set Watermarking type. Valid values:
image: Image watermark;
text: Text watermark;
svg: SVG watermark.
* @param Type Watermarking type. Valid values:
image: Image watermark;
text: Text watermark;
svg: SVG watermark.
*/
public void setType(String Type) {
this.Type = Type;
}
/**
* Get Watermarking template name. Length limit: 64 characters.
* @return Name Watermarking template name. Length limit: 64 characters.
*/
public String getName() {
return this.Name;
}
/**
* Set Watermarking template name. Length limit: 64 characters.
* @param Name Watermarking template name. Length limit: 64 characters.
*/
public void setName(String Name) {
this.Name = Name;
}
/**
* Get Template description. Length limit: 256 characters.
* @return Comment Template description. Length limit: 256 characters.
*/
public String getComment() {
return this.Comment;
}
/**
* Set Template description. Length limit: 256 characters.
* @param Comment Template description. Length limit: 256 characters.
*/
public void setComment(String Comment) {
this.Comment = Comment;
}
/**
* Get 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.
Default value: TopLeft.
* @return CoordinateOrigin 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.
Default value: TopLeft.
*/
public String getCoordinateOrigin() {
return this.CoordinateOrigin;
}
/**
* Set 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.
Default value: TopLeft.
* @param CoordinateOrigin 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.
Default value: TopLeft.
*/
public void setCoordinateOrigin(String CoordinateOrigin) {
this.CoordinateOrigin = CoordinateOrigin;
}
/**
* Get 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.
Default value: 0 px.
* @return XPos 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.
Default value: 0 px.
*/
public String getXPos() {
return this.XPos;
}
/**
* Set 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.
Default value: 0 px.
* @param XPos 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.
Default value: 0 px.
*/
public void setXPos(String XPos) {
this.XPos = XPos;
}
/**
* Get 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.
Default value: 0 px.
* @return YPos 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.
Default value: 0 px.
*/
public String getYPos() {
return this.YPos;
}
/**
* Set 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.
Default value: 0 px.
* @param YPos 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.
Default value: 0 px.
*/
public void setYPos(String YPos) {
this.YPos = YPos;
}
/**
* Get Image watermarking template. This field is required and valid only when `Type` is `image`.
* @return ImageTemplate Image watermarking template. This field is required and valid only when `Type` is `image`.
*/
public ImageWatermarkInput getImageTemplate() {
return this.ImageTemplate;
}
/**
* Set Image watermarking template. This field is required and valid only when `Type` is `image`.
* @param ImageTemplate Image watermarking template. This field is required and valid only when `Type` is `image`.
*/
public void setImageTemplate(ImageWatermarkInput ImageTemplate) {
this.ImageTemplate = ImageTemplate;
}
/**
* Get Text watermarking template. This field is required and valid only when `Type` is `text`.
* @return TextTemplate Text watermarking template. This field is required and valid only when `Type` is `text`.
*/
public TextWatermarkTemplateInput getTextTemplate() {
return this.TextTemplate;
}
/**
* Set Text watermarking template. This field is required and valid only when `Type` is `text`.
* @param TextTemplate Text watermarking template. This field is required and valid only when `Type` is `text`.
*/
public void setTextTemplate(TextWatermarkTemplateInput TextTemplate) {
this.TextTemplate = TextTemplate;
}
/**
* Get SVG watermarking template. This field is required and valid only when `Type` is `svg`.
* @return SvgTemplate SVG watermarking template. This field is required and valid only when `Type` is `svg`.
*/
public SvgWatermarkInput getSvgTemplate() {
return this.SvgTemplate;
}
/**
* Set SVG watermarking template. This field is required and valid only when `Type` is `svg`.
* @param SvgTemplate SVG watermarking template. This field is required and valid only when `Type` is `svg`.
*/
public void setSvgTemplate(SvgWatermarkInput SvgTemplate) {
this.SvgTemplate = SvgTemplate;
}
public CreateWatermarkTemplateRequest() {
}
/**
* NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
* and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
*/
public CreateWatermarkTemplateRequest(CreateWatermarkTemplateRequest source) {
if (source.Type != null) {
this.Type = new String(source.Type);
}
if (source.Name != null) {
this.Name = new String(source.Name);
}
if (source.Comment != null) {
this.Comment = new String(source.Comment);
}
if (source.CoordinateOrigin != null) {
this.CoordinateOrigin = new String(source.CoordinateOrigin);
}
if (source.XPos != null) {
this.XPos = new String(source.XPos);
}
if (source.YPos != null) {
this.YPos = new String(source.YPos);
}
if (source.ImageTemplate != null) {
this.ImageTemplate = new ImageWatermarkInput(source.ImageTemplate);
}
if (source.TextTemplate != null) {
this.TextTemplate = new TextWatermarkTemplateInput(source.TextTemplate);
}
if (source.SvgTemplate != null) {
this.SvgTemplate = new SvgWatermarkInput(source.SvgTemplate);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamSimple(map, prefix + "Type", this.Type);
this.setParamSimple(map, prefix + "Name", this.Name);
this.setParamSimple(map, prefix + "Comment", this.Comment);
this.setParamSimple(map, prefix + "CoordinateOrigin", this.CoordinateOrigin);
this.setParamSimple(map, prefix + "XPos", this.XPos);
this.setParamSimple(map, prefix + "YPos", this.YPos);
this.setParamObj(map, prefix + "ImageTemplate.", this.ImageTemplate);
this.setParamObj(map, prefix + "TextTemplate.", this.TextTemplate);
this.setParamObj(map, prefix + "SvgTemplate.", this.SvgTemplate);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy