com.tencentcloudapi.mps.v20190612.models

Class WatermarkInput

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.mps.v20190612.models.WatermarkInput

public class WatermarkInput
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
WatermarkInput()
WatermarkInput(WatermarkInput source) 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.

Method Summary

Modifier and Type	Method and Description
Long	getDefinition() Get ID of a watermarking template.
Float	getEndTimeOffset() Get End time offset of a watermark, in seconds.
RawWatermarkParameter	getRawParameter() Get Custom watermark parameter, which is valid if `Definition` is 0.
Float	getStartTimeOffset() Get Start time offset of a watermark, in seconds.
String	getSvgContent() Get SVG content of up to 2,000,000 characters.
String	getTextContent() Get Text content of up to 100 characters.
void	setDefinition(Long Definition) Set ID of a watermarking template.
void	setEndTimeOffset(Float EndTimeOffset) Set End time offset of a watermark, in seconds.
void	setRawParameter(RawWatermarkParameter RawParameter) Set Custom watermark parameter, which is valid if `Definition` is 0.
void	setStartTimeOffset(Float StartTimeOffset) Set Start time offset of a watermark, in seconds.
void	setSvgContent(String SvgContent) Set SVG content of up to 2,000,000 characters.
void	setTextContent(String TextContent) Set Text content of up to 100 characters.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WatermarkInput

public WatermarkInput()

WatermarkInput

public WatermarkInput(WatermarkInput source)

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.

Method Detail

getDefinition

public Long getDefinition()

Get ID of a watermarking template.

Returns:

Definition ID of a watermarking template.

setDefinition

public void setDefinition(Long Definition)

Set ID of a watermarking template.

Parameters:

Definition - ID of a watermarking template.

getRawParameter

public RawWatermarkParameter getRawParameter()

Get Custom watermark parameter, which is valid if `Definition` is 0. This parameter is used in highly customized scenarios. We recommend you use `Definition` to specify the watermark parameter preferably. Custom watermark parameter is not available for screenshot.

Returns:

RawParameter Custom watermark parameter, which is valid if `Definition` is 0. This parameter is used in highly customized scenarios. We recommend you use `Definition` to specify the watermark parameter preferably. Custom watermark parameter is not available for screenshot.

setRawParameter

public void setRawParameter(RawWatermarkParameter RawParameter)

Set Custom watermark parameter, which is valid if `Definition` is 0. This parameter is used in highly customized scenarios. We recommend you use `Definition` to specify the watermark parameter preferably. Custom watermark parameter is not available for screenshot.

Parameters:

RawParameter - Custom watermark parameter, which is valid if `Definition` is 0. This parameter is used in highly customized scenarios. We recommend you use `Definition` to specify the watermark parameter preferably. Custom watermark parameter is not available for screenshot.

getTextContent

public String getTextContent()

Get Text content of up to 100 characters. This field is required only when the watermark type is text. Text watermark is not available for screenshot.

Returns:

TextContent Text content of up to 100 characters. This field is required only when the watermark type is text. Text watermark is not available for screenshot.

setTextContent

public void setTextContent(String TextContent)

Set Text content of up to 100 characters. This field is required only when the watermark type is text. Text watermark is not available for screenshot.

Parameters:

TextContent - Text content of up to 100 characters. This field is required only when the watermark type is text. Text watermark is not available for screenshot.

getSvgContent

public String getSvgContent()

Get SVG content of up to 2,000,000 characters. This field is required only when the watermark type is `SVG`. SVG watermark is not available for screenshot.

Returns:

SvgContent SVG content of up to 2,000,000 characters. This field is required only when the watermark type is `SVG`. SVG watermark is not available for screenshot.

setSvgContent

public void setSvgContent(String SvgContent)

Set SVG content of up to 2,000,000 characters. This field is required only when the watermark type is `SVG`. SVG watermark is not available for screenshot.

Parameters:

SvgContent - SVG content of up to 2,000,000 characters. This field is required only when the watermark type is `SVG`. SVG watermark is not available for screenshot.

getStartTimeOffset

public Float getStartTimeOffset()

Get Start time offset of a watermark, in seconds. If not set or set to 0, a watermark starts appearing when a video starts.

If not set or set to 0, a watermark starts appearing when a video starts. If the value is greater than 0 (for example, n), a watermark will appear at second n of a video. If the value is less than 0 (for example, -n), a watermark will appear n seconds before the end of a video. Note: It is only used for video scenarios. Screenshots are not supported.

Returns:

StartTimeOffset Start time offset of a watermark, in seconds. If not set or set to 0, a watermark starts appearing when a video starts.

If not set or set to 0, a watermark starts appearing when a video starts.

If the value is greater than 0 (for example, n), a watermark will appear at second n of a video.

If the value is less than 0 (for example, -n), a watermark will appear n seconds before the end of a video.

Note: It is only used for video scenarios. Screenshots are not supported.

setStartTimeOffset

public void setStartTimeOffset(Float StartTimeOffset)

Set Start time offset of a watermark, in seconds. If not set or set to 0, a watermark starts appearing when a video starts.

If not set or set to 0, a watermark starts appearing when a video starts. If the value is greater than 0 (for example, n), a watermark will appear at second n of a video. If the value is less than 0 (for example, -n), a watermark will appear n seconds before the end of a video. Note: It is only used for video scenarios. Screenshots are not supported.