com.tencentcloudapi.trtc.v20190722.models

Class MixLayout

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.trtc.v20190722.models.MixLayout

public class MixLayout
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
MixLayout()
MixLayout(MixLayout 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	getAlpha() Get The degree of transparency of the canvas.
Long	getHeight() Get The relative height of the window.
Long	getImageLayer() Get The image layer.
Long	getLeft() Get The X axis of the window’s top-left corner.
Long	getMediaId() Get The type of the stream subscribed to.
Long	getRenderMode() Get 0: Stretch.
String	getSubBackgroundImage() Get The URL of the background image for a window.
Long	getTop() Get The Y axis of the window’s top-left corner.
String	getUserId() Get The user ID (string) of the anchor whose video is shown in the window.
Long	getWidth() Get The relative width of the window.
void	setAlpha(Long Alpha) Set The degree of transparency of the canvas.
void	setHeight(Long Height) Set The relative height of the window.
void	setImageLayer(Long ImageLayer) Set The image layer.
void	setLeft(Long Left) Set The X axis of the window’s top-left corner.
void	setMediaId(Long MediaId) Set The type of the stream subscribed to.
void	setRenderMode(Long RenderMode) Set 0: Stretch.
void	setSubBackgroundImage(String SubBackgroundImage) Set The URL of the background image for a window.
void	setTop(Long Top) Set The Y axis of the window’s top-left corner.
void	setUserId(String UserId) Set The user ID (string) of the anchor whose video is shown in the window.
void	setWidth(Long Width) Set The relative width of the window.
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

MixLayout

public MixLayout()

MixLayout

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

getTop

public Long getTop()

Get The Y axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas height.

Returns:

Top The Y axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas height.

setTop

public void setTop(Long Top)

Set The Y axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas height.

Parameters:

Top - The Y axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas height.

getLeft

public Long getLeft()

Get The X axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas width.

Returns:

Left The X axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas width.

setLeft

public void setLeft(Long Left)

Set The X axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas width.

Parameters:

Left - The X axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas width.

getWidth

public Long getWidth()

Get The relative width of the window. Value range: [0, 1920]. The sum of the values of this parameter and `Left` cannot exceed the canvas width.

Returns:

Width The relative width of the window. Value range: [0, 1920]. The sum of the values of this parameter and `Left` cannot exceed the canvas width.

setWidth

public void setWidth(Long Width)

Set The relative width of the window. Value range: [0, 1920]. The sum of the values of this parameter and `Left` cannot exceed the canvas width.

Parameters:

Width - The relative width of the window. Value range: [0, 1920]. The sum of the values of this parameter and `Left` cannot exceed the canvas width.

getHeight

public Long getHeight()

Get The relative height of the window. Value range: [0, 1920]. The sum of the values of this parameter and `Top` cannot exceed the canvas height.

Returns:

Height The relative height of the window. Value range: [0, 1920]. The sum of the values of this parameter and `Top` cannot exceed the canvas height.

setHeight

public void setHeight(Long Height)

Set The relative height of the window. Value range: [0, 1920]. The sum of the values of this parameter and `Top` cannot exceed the canvas height.

Parameters:

Height - The relative height of the window. Value range: [0, 1920]. The sum of the values of this parameter and `Top` cannot exceed the canvas height.

getUserId

public String getUserId()

Get The user ID (string) of the anchor whose video is shown in the window. If you do not set this parameter, anchors’ videos will be shown in their room entry sequence.

Returns:

UserId The user ID (string) of the anchor whose video is shown in the window. If you do not set this parameter, anchors’ videos will be shown in their room entry sequence.

setUserId

public void setUserId(String UserId)

Set The user ID (string) of the anchor whose video is shown in the window. If you do not set this parameter, anchors’ videos will be shown in their room entry sequence.

Parameters:

UserId - The user ID (string) of the anchor whose video is shown in the window. If you do not set this parameter, anchors’ videos will be shown in their room entry sequence.

getAlpha

public Long getAlpha()

Get The degree of transparency of the canvas. Value range: [0, 255]. 0 means fully opaque, and 255 means fully transparent.

Returns:

Alpha The degree of transparency of the canvas. Value range: [0, 255]. 0 means fully opaque, and 255 means fully transparent.

setAlpha

public void setAlpha(Long Alpha)

Set The degree of transparency of the canvas. Value range: [0, 255]. 0 means fully opaque, and 255 means fully transparent.

Parameters:

Alpha - The degree of transparency of the canvas. Value range: [0, 255]. 0 means fully opaque, and 255 means fully transparent.

getRenderMode

public Long getRenderMode()

Get 0: Stretch. In this mode, the image is stretched to fill the space available. The whole image is visible after scaling. However, if the original aspect ratio is different from the target, the image may be distorted. 1: Crop (default). In this mode, if the original aspect ratio is different from the target, the image will be cropped according to the target before being stretched to fill the space available. The image will not be distorted. 2: Blank. This mode stretches the image while keeping its original aspect ratio. If the original aspect ratio is different from the target, there may be blank spaces to the top and bottom or to the left and right of the window. 3: Smart stretch. This mode is similar to the crop mode, except that it restricts cropping to 20% of the image’s width or height at most.

Returns:

RenderMode 0: Stretch. In this mode, the image is stretched to fill the space available. The whole image is visible after scaling. However, if the original aspect ratio is different from the target, the image may be distorted. 1: Crop (default). In this mode, if the original aspect ratio is different from the target, the image will be cropped according to the target before being stretched to fill the space available. The image will not be distorted. 2: Blank. This mode stretches the image while keeping its original aspect ratio. If the original aspect ratio is different from the target, there may be blank spaces to the top and bottom or to the left and right of the window. 3: Smart stretch. This mode is similar to the crop mode, except that it restricts cropping to 20% of the image’s width or height at most.

setRenderMode

public void setRenderMode(Long RenderMode)

Set 0: Stretch. In this mode, the image is stretched to fill the space available. The whole image is visible after scaling. However, if the original aspect ratio is different from the target, the image may be distorted. 1: Crop (default). In this mode, if the original aspect ratio is different from the target, the image will be cropped according to the target before being stretched to fill the space available. The image will not be distorted. 2: Blank. This mode stretches the image while keeping its original aspect ratio. If the original aspect ratio is different from the target, there may be blank spaces to the top and bottom or to the left and right of the window. 3: Smart stretch. This mode is similar to the crop mode, except that it restricts cropping to 20% of the image’s width or height at most.

Parameters:

RenderMode - 0: Stretch. In this mode, the image is stretched to fill the space available. The whole image is visible after scaling. However, if the original aspect ratio is different from the target, the image may be distorted. 1: Crop (default). In this mode, if the original aspect ratio is different from the target, the image will be cropped according to the target before being stretched to fill the space available. The image will not be distorted. 2: Blank. This mode stretches the image while keeping its original aspect ratio. If the original aspect ratio is different from the target, there may be blank spaces to the top and bottom or to the left and right of the window. 3: Smart stretch. This mode is similar to the crop mode, except that it restricts cropping to 20% of the image’s width or height at most.

getMediaId

public Long getMediaId()

Get The type of the stream subscribed to. 0: Primary stream (default) 1: Substream

Returns:

MediaId The type of the stream subscribed to. 0: Primary stream (default) 1: Substream

setMediaId

public void setMediaId(Long MediaId)

Set The type of the stream subscribed to. 0: Primary stream (default) 1: Substream

Parameters:

MediaId - The type of the stream subscribed to. 0: Primary stream (default) 1: Substream

getImageLayer

public Long getImageLayer()

Get The image layer. 0 is the default value and means the bottommost layer.

Returns:

ImageLayer The image layer. 0 is the default value and means the bottommost layer.

setImageLayer

public void setImageLayer(Long ImageLayer)

Set The image layer. 0 is the default value and means the bottommost layer.

Parameters:

ImageLayer - The image layer. 0 is the default value and means the bottommost layer.

getSubBackgroundImage

public String getSubBackgroundImage()

Get The URL of the background image for a window. The image must be in JPG or PNG format and cannot be larger than 5 MB. If the image’s aspect ratio is different from that of the window, the image will be rendered according to the value of `RenderMode`.

Returns:

SubBackgroundImage The URL of the background image for a window. The image must be in JPG or PNG format and cannot be larger than 5 MB. If the image’s aspect ratio is different from that of the window, the image will be rendered according to the value of `RenderMode`.

setSubBackgroundImage

public void setSubBackgroundImage(String SubBackgroundImage)

Set The URL of the background image for a window. The image must be in JPG or PNG format and cannot be larger than 5 MB. If the image’s aspect ratio is different from that of the window, the image will be rendered according to the value of `RenderMode`.

Parameters:

SubBackgroundImage - The URL of the background image for a window. The image must be in JPG or PNG format and cannot be larger than 5 MB. If the image’s aspect ratio is different from that of the window, the image will be rendered according to the value of `RenderMode`.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel