com.tencentcloudapi.trtc.v20190722.models

Class WaterMarkParams

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.trtc.v20190722.models.WaterMarkParams

public class WaterMarkParams
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
WaterMarkParams()
WaterMarkParams(WaterMarkParams 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	getLocationX() Get Horizontal offset (px) of the watermark
Long	getLocationY() Get Vertical offset (px) of the watermark
Long	getWaterMarkHeight() Get Height (px) of the watermark for On-Cloud MixTranscoding
Long	getWaterMarkId() Get Image ID of the watermark, which is generated after the image is uploaded to the TRTC console
String	getWaterMarkUrl() Get URL of the watermark image for the mixed stream, which can be in PNG, JPG, JPEG, or BMP format and does not support the alpha channel.
Long	getWaterMarkWidth() Get Width (px) of the watermark for On-Cloud MixTranscoding
void	setLocationX(Long LocationX) Set Horizontal offset (px) of the watermark
void	setLocationY(Long LocationY) Set Vertical offset (px) of the watermark
void	setWaterMarkHeight(Long WaterMarkHeight) Set Height (px) of the watermark for On-Cloud MixTranscoding
void	setWaterMarkId(Long WaterMarkId) Set Image ID of the watermark, which is generated after the image is uploaded to the TRTC console
void	setWaterMarkUrl(String WaterMarkUrl) Set URL of the watermark image for the mixed stream, which can be in PNG, JPG, JPEG, or BMP format and does not support the alpha channel.
void	setWaterMarkWidth(Long WaterMarkWidth) Set Width (px) of the watermark for On-Cloud MixTranscoding
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

WaterMarkParams

public WaterMarkParams()

WaterMarkParams

public WaterMarkParams(WaterMarkParams 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

getWaterMarkId

public Long getWaterMarkId()

Get Image ID of the watermark, which is generated after the image is uploaded to the TRTC console

Returns:

WaterMarkId Image ID of the watermark, which is generated after the image is uploaded to the TRTC console

setWaterMarkId

public void setWaterMarkId(Long WaterMarkId)

Set Image ID of the watermark, which is generated after the image is uploaded to the TRTC console

Parameters:

WaterMarkId - Image ID of the watermark, which is generated after the image is uploaded to the TRTC console

getWaterMarkWidth

public Long getWaterMarkWidth()

Get Width (px) of the watermark for On-Cloud MixTranscoding

Returns:

WaterMarkWidth Width (px) of the watermark for On-Cloud MixTranscoding

setWaterMarkWidth

public void setWaterMarkWidth(Long WaterMarkWidth)

Set Width (px) of the watermark for On-Cloud MixTranscoding

Parameters:

WaterMarkWidth - Width (px) of the watermark for On-Cloud MixTranscoding

getWaterMarkHeight

public Long getWaterMarkHeight()

Get Height (px) of the watermark for On-Cloud MixTranscoding

Returns:

WaterMarkHeight Height (px) of the watermark for On-Cloud MixTranscoding

setWaterMarkHeight

public void setWaterMarkHeight(Long WaterMarkHeight)

Set Height (px) of the watermark for On-Cloud MixTranscoding

Parameters:

WaterMarkHeight - Height (px) of the watermark for On-Cloud MixTranscoding

getLocationX

public Long getLocationX()

Get Horizontal offset (px) of the watermark

Returns:

LocationX Horizontal offset (px) of the watermark

setLocationX

public void setLocationX(Long LocationX)

Set Horizontal offset (px) of the watermark

Parameters:

LocationX - Horizontal offset (px) of the watermark

getLocationY

public Long getLocationY()

Get Vertical offset (px) of the watermark

Returns:

LocationY Vertical offset (px) of the watermark

setLocationY

public void setLocationY(Long LocationY)

Set Vertical offset (px) of the watermark

Parameters:

LocationY - Vertical offset (px) of the watermark

getWaterMarkUrl

public String getWaterMarkUrl()

Get URL of the watermark image for the mixed stream, which can be in PNG, JPG, JPEG, or BMP format and does not support the alpha channel. The URL must not exceed 512 bytes. When both `WaterMarkUrl` and `WaterMarkId` are specified, the former will be used. The watermark image cannot exceed 10 MB.

Returns:

WaterMarkUrl URL of the watermark image for the mixed stream, which can be in PNG, JPG, JPEG, or BMP format and does not support the alpha channel. The URL must not exceed 512 bytes. When both `WaterMarkUrl` and `WaterMarkId` are specified, the former will be used. The watermark image cannot exceed 10 MB.

setWaterMarkUrl

public void setWaterMarkUrl(String WaterMarkUrl)

Set URL of the watermark image for the mixed stream, which can be in PNG, JPG, JPEG, or BMP format and does not support the alpha channel. The URL must not exceed 512 bytes. When both `WaterMarkUrl` and `WaterMarkId` are specified, the former will be used. The watermark image cannot exceed 10 MB.

Parameters:

WaterMarkUrl - URL of the watermark image for the mixed stream, which can be in PNG, JPG, JPEG, or BMP format and does not support the alpha channel. The URL must not exceed 512 bytes. When both `WaterMarkUrl` and `WaterMarkId` are specified, the former will be used. The watermark image cannot exceed 10 MB.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel