com.tencentcloudapi.live.v20180801.models

Class CommonMixLayoutParams

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.live.v20180801.models.CommonMixLayoutParams

public class CommonMixLayoutParams
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CommonMixLayoutParams()
CommonMixLayoutParams(CommonMixLayoutParams 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
String	getColor() Get When `InputType` is 3 (canvas), this value indicates the canvas color.
Float	getImageHeight() Get Output height of input video image.
Long	getImageLayer() Get Input layer.
Float	getImageWidth() Get Output width of input video image.
Long	getInputType() Get Input type.
Float	getLocationX() Get X-axis offset of input in output video image.
Float	getLocationY() Get Y-axis offset of input in output video image.
Long	getWatermarkId() Get When `InputType` is 2 (image), this value is the watermark ID.
void	setColor(String Color) Set When `InputType` is 3 (canvas), this value indicates the canvas color.
void	setImageHeight(Float ImageHeight) Set Output height of input video image.
void	setImageLayer(Long ImageLayer) Set Input layer.
void	setImageWidth(Float ImageWidth) Set Output width of input video image.
void	setInputType(Long InputType) Set Input type.
void	setLocationX(Float LocationX) Set X-axis offset of input in output video image.
void	setLocationY(Float LocationY) Set Y-axis offset of input in output video image.
void	setWatermarkId(Long WatermarkId) Set When `InputType` is 2 (image), this value is the watermark ID.
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

CommonMixLayoutParams

public CommonMixLayoutParams()

CommonMixLayoutParams

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

getImageLayer

public Long getImageLayer()

Get Input layer. Value range: [1,16]. 1) For `image_layer` of background stream (i.e., main host video image or canvas), enter 1. 2) For audio stream mix, this parameter is also required.

Returns:

ImageLayer Input layer. Value range: [1,16]. 1) For `image_layer` of background stream (i.e., main host video image or canvas), enter 1. 2) For audio stream mix, this parameter is also required.

setImageLayer

public void setImageLayer(Long ImageLayer)

Set Input layer. Value range: [1,16]. 1) For `image_layer` of background stream (i.e., main host video image or canvas), enter 1. 2) For audio stream mix, this parameter is also required.

Parameters:

ImageLayer - Input layer. Value range: [1,16]. 1) For `image_layer` of background stream (i.e., main host video image or canvas), enter 1. 2) For audio stream mix, this parameter is also required.

getInputType

public Long getInputType()

Get Input type. Value range: [0,5]. If this parameter is left empty, 0 will be used by default. 0: the input stream is audio/video. 2: the input stream is image. 3: the input stream is canvas. 4: the input stream is audio. 5: the input stream is pure video.

Returns:

InputType Input type. Value range: [0,5]. If this parameter is left empty, 0 will be used by default. 0: the input stream is audio/video. 2: the input stream is image. 3: the input stream is canvas. 4: the input stream is audio. 5: the input stream is pure video.

setInputType

public void setInputType(Long InputType)

Set Input type. Value range: [0,5]. If this parameter is left empty, 0 will be used by default. 0: the input stream is audio/video. 2: the input stream is image. 3: the input stream is canvas. 4: the input stream is audio. 5: the input stream is pure video.

Parameters:

InputType - Input type. Value range: [0,5]. If this parameter is left empty, 0 will be used by default. 0: the input stream is audio/video. 2: the input stream is image. 3: the input stream is canvas. 4: the input stream is audio. 5: the input stream is pure video.

getImageWidth

public Float getImageWidth()

Get Output width of input video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, the input stream width will be used by default. If percentage is used, the expected output is (percentage * background width).

Returns:

ImageWidth Output width of input video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, the input stream width will be used by default. If percentage is used, the expected output is (percentage * background width).

setImageWidth

public void setImageWidth(Float ImageWidth)

Set Output width of input video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, the input stream width will be used by default. If percentage is used, the expected output is (percentage * background width).

Parameters:

ImageWidth - Output width of input video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, the input stream width will be used by default. If percentage is used, the expected output is (percentage * background width).

getImageHeight

public Float getImageHeight()

Get Output height of input video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, the input stream height will be used by default. If percentage is used, the expected output is (percentage * background height).

Returns:

ImageHeight Output height of input video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, the input stream height will be used by default. If percentage is used, the expected output is (percentage * background height).

setImageHeight

public void setImageHeight(Float ImageHeight)

Set Output height of input video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, the input stream height will be used by default. If percentage is used, the expected output is (percentage * background height).

Parameters:

ImageHeight - Output height of input video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, the input stream height will be used by default. If percentage is used, the expected output is (percentage * background height).

getLocationX

public Float getLocationX()

Get X-axis offset of input in output video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, 0 will be used by default. Horizontal offset from the top-left corner of main host background video image. If percentage is used, the expected output is (percentage * background width).

Returns:

LocationX X-axis offset of input in output video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, 0 will be used by default. Horizontal offset from the top-left corner of main host background video image. If percentage is used, the expected output is (percentage * background width).

setLocationX

public void setLocationX(Float LocationX)

Set X-axis offset of input in output video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, 0 will be used by default. Horizontal offset from the top-left corner of main host background video image. If percentage is used, the expected output is (percentage * background width).

Parameters:

LocationX - X-axis offset of input in output video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, 0 will be used by default. Horizontal offset from the top-left corner of main host background video image. If percentage is used, the expected output is (percentage * background width).

getLocationY

public Float getLocationY()

Get Y-axis offset of input in output video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, 0 will be used by default. Vertical offset from the top-left corner of main host background video image. If percentage is used, the expected output is (percentage * background width)

Returns:

LocationY Y-axis offset of input in output video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, 0 will be used by default. Vertical offset from the top-left corner of main host background video image. If percentage is used, the expected output is (percentage * background width)

setLocationY

public void setLocationY(Float LocationY)

Set Y-axis offset of input in output video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, 0 will be used by default. Vertical offset from the top-left corner of main host background video image. If percentage is used, the expected output is (percentage * background width)

Parameters:

LocationY - Y-axis offset of input in output video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, 0 will be used by default. Vertical offset from the top-left corner of main host background video image. If percentage is used, the expected output is (percentage * background width)

getColor

public String getColor()

Get When `InputType` is 3 (canvas), this value indicates the canvas color. Commonly used colors include: Red: 0xcc0033. Yellow: 0xcc9900. Green: 0xcccc33. Blue: 0x99CCFF. Black: 0x000000. White: 0xFFFFFF. Gray: 0x999999

Returns:

Color When `InputType` is 3 (canvas), this value indicates the canvas color. Commonly used colors include: Red: 0xcc0033. Yellow: 0xcc9900. Green: 0xcccc33. Blue: 0x99CCFF. Black: 0x000000. White: 0xFFFFFF. Gray: 0x999999

setColor

public void setColor(String Color)

Set When `InputType` is 3 (canvas), this value indicates the canvas color. Commonly used colors include: Red: 0xcc0033. Yellow: 0xcc9900. Green: 0xcccc33. Blue: 0x99CCFF. Black: 0x000000. White: 0xFFFFFF. Gray: 0x999999

Parameters:

Color - When `InputType` is 3 (canvas), this value indicates the canvas color. Commonly used colors include: Red: 0xcc0033. Yellow: 0xcc9900. Green: 0xcccc33. Blue: 0x99CCFF. Black: 0x000000. White: 0xFFFFFF. Gray: 0x999999

getWatermarkId

public Long getWatermarkId()

Get When `InputType` is 2 (image), this value is the watermark ID.

Returns:

WatermarkId When `InputType` is 2 (image), this value is the watermark ID.

setWatermarkId

public void setWatermarkId(Long WatermarkId)

Set When `InputType` is 2 (image), this value is the watermark ID.

Parameters:

WatermarkId - When `InputType` is 2 (image), this value is the watermark ID.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel