com.tencentcloudapi.trtc.v20190722.models

Class MixLayoutParams

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.trtc.v20190722.models.MixLayoutParams

public class MixLayoutParams
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
MixLayoutParams()
MixLayoutParams(MixLayoutParams 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	getBackGroundColor() Get The background color, which is a hexadecimal value (starting with "#", followed by the color value) converted from an 8-bit RGB value.
Long	getBackgroundImageRenderMode() Get The render mode to use when the aspect ratio of a video is different from that of the window.
String	getBackgroundImageUrl() Get The URL of the background image, which cannot contain Chinese characters.
String	getDefaultSubBackgroundImage() Get The URL of the background image for a window.
Long	getMaxResolutionUserAlign() Get This parameter is valid only if the screen sharing layout is used.
String	getMaxResolutionUserId() Get The user whose video is displayed in the big window.
Long	getMediaId() Get The stream type.
MixLayout[]	getMixLayoutList() Get The custom layout details.
Long	getMixLayoutMode() Get Layout mode: 1: Floating 2: Screen sharing 3: Grid (default) 4: Custom Floating: By default, the video of the first anchor (you can also specify an anchor) who enters the room is scaled to fill the screen.
Long	getPlaceHolderMode() Get `1` means to use placeholders, and `0` (default) means to not use placeholders.
Long	getRenderMode() Get The render mode to use when the aspect ratio of a video is different from that of the window.
WaterMark[]	getWaterMarkList() Get The watermark layout.
void	setBackGroundColor(String BackGroundColor) Set The background color, which is a hexadecimal value (starting with "#", followed by the color value) converted from an 8-bit RGB value.
void	setBackgroundImageRenderMode(Long BackgroundImageRenderMode) Set The render mode to use when the aspect ratio of a video is different from that of the window.
void	setBackgroundImageUrl(String BackgroundImageUrl) Set The URL of the background image, which cannot contain Chinese characters.
void	setDefaultSubBackgroundImage(String DefaultSubBackgroundImage) Set The URL of the background image for a window.
void	setMaxResolutionUserAlign(Long MaxResolutionUserAlign) Set This parameter is valid only if the screen sharing layout is used.
void	setMaxResolutionUserId(String MaxResolutionUserId) Set The user whose video is displayed in the big window.
void	setMediaId(Long MediaId) Set The stream type.
void	setMixLayoutList(MixLayout[] MixLayoutList) Set The custom layout details.
void	setMixLayoutMode(Long MixLayoutMode) Set Layout mode: 1: Floating 2: Screen sharing 3: Grid (default) 4: Custom Floating: By default, the video of the first anchor (you can also specify an anchor) who enters the room is scaled to fill the screen.
void	setPlaceHolderMode(Long PlaceHolderMode) Set `1` means to use placeholders, and `0` (default) means to not use placeholders.
void	setRenderMode(Long RenderMode) Set The render mode to use when the aspect ratio of a video is different from that of the window.
void	setWaterMarkList(WaterMark[] WaterMarkList) Set The watermark layout.
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

MixLayoutParams

public MixLayoutParams()

MixLayoutParams

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

getMixLayoutMode

public Long getMixLayoutMode()

Get Layout mode: 1: Floating 2: Screen sharing 3: Grid (default) 4: Custom Floating: By default, the video of the first anchor (you can also specify an anchor) who enters the room is scaled to fill the screen. When other anchors enter the room, their videos appear smaller and are superimposed over the large video from left to right starting from the bottom of the canvas according to their room entry sequence. If the total number of videos is 17 or less, there will be four windows in each row (4 x 4); if it is greater than 17, there will be five windows in each row (5 x 5). Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window. Screen sharing: The video of a specified anchor occupies a larger part of the canvas on the left side (if you do not specify an anchor, the left window will display the canvas background). The videos of other anchors are smaller and are positioned on the right side. If the total number of videos is 17 or less, the small videos are positioned from top to bottom in up to two columns on the right side, with eight videos per column at most. If there are more than 17 videos, the additional videos are positioned at the bottom of the canvas from left to right. Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window. Grid: The videos of anchors are scaled and positioned automatically according to the total number of anchors in a room. Each video has the same size. Up to 25 videos can be displayed. Custom: Specify the layout of videos by using the `MixLayoutList` parameter.

Returns:

MixLayoutMode Layout mode: 1: Floating 2: Screen sharing 3: Grid (default) 4: Custom Floating: By default, the video of the first anchor (you can also specify an anchor) who enters the room is scaled to fill the screen. When other anchors enter the room, their videos appear smaller and are superimposed over the large video from left to right starting from the bottom of the canvas according to their room entry sequence. If the total number of videos is 17 or less, there will be four windows in each row (4 x 4); if it is greater than 17, there will be five windows in each row (5 x 5). Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window. Screen sharing: The video of a specified anchor occupies a larger part of the canvas on the left side (if you do not specify an anchor, the left window will display the canvas background). The videos of other anchors are smaller and are positioned on the right side. If the total number of videos is 17 or less, the small videos are positioned from top to bottom in up to two columns on the right side, with eight videos per column at most. If there are more than 17 videos, the additional videos are positioned at the bottom of the canvas from left to right. Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window. Grid: The videos of anchors are scaled and positioned automatically according to the total number of anchors in a room. Each video has the same size. Up to 25 videos can be displayed. Custom: Specify the layout of videos by using the `MixLayoutList` parameter.

setMixLayoutMode

public void setMixLayoutMode(Long MixLayoutMode)

Set Layout mode: 1: Floating 2: Screen sharing 3: Grid (default) 4: Custom Floating: By default, the video of the first anchor (you can also specify an anchor) who enters the room is scaled to fill the screen. When other anchors enter the room, their videos appear smaller and are superimposed over the large video from left to right starting from the bottom of the canvas according to their room entry sequence. If the total number of videos is 17 or less, there will be four windows in each row (4 x 4); if it is greater than 17, there will be five windows in each row (5 x 5). Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window. Screen sharing: The video of a specified anchor occupies a larger part of the canvas on the left side (if you do not specify an anchor, the left window will display the canvas background). The videos of other anchors are smaller and are positioned on the right side. If the total number of videos is 17 or less, the small videos are positioned from top to bottom in up to two columns on the right side, with eight videos per column at most. If there are more than 17 videos, the additional videos are positioned at the bottom of the canvas from left to right. Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window. Grid: The videos of anchors are scaled and positioned automatically according to the total number of anchors in a room. Each video has the same size. Up to 25 videos can be displayed. Custom: Specify the layout of videos by using the `MixLayoutList` parameter.

Parameters:

MixLayoutMode - Layout mode: 1: Floating 2: Screen sharing 3: Grid (default) 4: Custom Floating: By default, the video of the first anchor (you can also specify an anchor) who enters the room is scaled to fill the screen. When other anchors enter the room, their videos appear smaller and are superimposed over the large video from left to right starting from the bottom of the canvas according to their room entry sequence. If the total number of videos is 17 or less, there will be four windows in each row (4 x 4); if it is greater than 17, there will be five windows in each row (5 x 5). Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window. Screen sharing: The video of a specified anchor occupies a larger part of the canvas on the left side (if you do not specify an anchor, the left window will display the canvas background). The videos of other anchors are smaller and are positioned on the right side. If the total number of videos is 17 or less, the small videos are positioned from top to bottom in up to two columns on the right side, with eight videos per column at most. If there are more than 17 videos, the additional videos are positioned at the bottom of the canvas from left to right. Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window. Grid: The videos of anchors are scaled and positioned automatically according to the total number of anchors in a room. Each video has the same size. Up to 25 videos can be displayed. Custom: Specify the layout of videos by using the `MixLayoutList` parameter.

getMixLayoutList

public MixLayout[] getMixLayoutList()

Get The custom layout details. This parameter is valid if `MixLayoutMode` is set to `4`. Up to 25 videos can be displayed.

Returns:

MixLayoutList The custom layout details. This parameter is valid if `MixLayoutMode` is set to `4`. Up to 25 videos can be displayed.

setMixLayoutList

public void setMixLayoutList(MixLayout[] MixLayoutList)

Set The custom layout details. This parameter is valid if `MixLayoutMode` is set to `4`. Up to 25 videos can be displayed.

Parameters:

MixLayoutList - The custom layout details. This parameter is valid if `MixLayoutMode` is set to `4`. Up to 25 videos can be displayed.

getBackGroundColor

public String getBackGroundColor()

Get The background color, which is a hexadecimal value (starting with "#", followed by the color value) converted from an 8-bit RGB value. For example, the RGB value of orange is `R:255 G:165 B:0`, and its hexadecimal value is `#FFA500`. The default color is black.

Returns:

BackGroundColor The background color, which is a hexadecimal value (starting with "#", followed by the color value) converted from an 8-bit RGB value. For example, the RGB value of orange is `R:255 G:165 B:0`, and its hexadecimal value is `#FFA500`. The default color is black.

setBackGroundColor

public void setBackGroundColor(String BackGroundColor)

Set The background color, which is a hexadecimal value (starting with "#", followed by the color value) converted from an 8-bit RGB value. For example, the RGB value of orange is `R:255 G:165 B:0`, and its hexadecimal value is `#FFA500`. The default color is black.

Parameters:

BackGroundColor - The background color, which is a hexadecimal value (starting with "#", followed by the color value) converted from an 8-bit RGB value. For example, the RGB value of orange is `R:255 G:165 B:0`, and its hexadecimal value is `#FFA500`. The default color is black.

getMaxResolutionUserId

public String getMaxResolutionUserId()

Get The user whose video is displayed in the big window. This parameter is valid if `MixLayoutMode` is set to `1` (floating) or `2` (screen sharing). If it is left empty, the first anchor entering the room is displayed in the big window in the floating mode and the canvas background is displayed in the screen sharing mode.

Returns:

MaxResolutionUserId The user whose video is displayed in the big window. This parameter is valid if `MixLayoutMode` is set to `1` (floating) or `2` (screen sharing). If it is left empty, the first anchor entering the room is displayed in the big window in the floating mode and the canvas background is displayed in the screen sharing mode.

setMaxResolutionUserId

public void setMaxResolutionUserId(String MaxResolutionUserId)

Set The user whose video is displayed in the big window. This parameter is valid if `MixLayoutMode` is set to `1` (floating) or `2` (screen sharing). If it is left empty, the first anchor entering the room is displayed in the big window in the floating mode and the canvas background is displayed in the screen sharing mode.

Parameters:

MaxResolutionUserId - The user whose video is displayed in the big window. This parameter is valid if `MixLayoutMode` is set to `1` (floating) or `2` (screen sharing). If it is left empty, the first anchor entering the room is displayed in the big window in the floating mode and the canvas background is displayed in the screen sharing mode.

getMediaId

public Long getMediaId()

Get The stream type. 0: Primary stream (default) 1: Substream (screen sharing stream) This parameter specifies the type of the stream displayed in the big window. If it appears in `MixLayoutList`, it indicates the type of the stream of a specified user.

Returns:

MediaId The stream type. 0: Primary stream (default) 1: Substream (screen sharing stream) This parameter specifies the type of the stream displayed in the big window. If it appears in `MixLayoutList`, it indicates the type of the stream of a specified user.

setMediaId

public void setMediaId(Long MediaId)

Set The stream type. 0: Primary stream (default) 1: Substream (screen sharing stream) This parameter specifies the type of the stream displayed in the big window. If it appears in `MixLayoutList`, it indicates the type of the stream of a specified user.

Parameters:

MediaId - The stream type. 0: Primary stream (default) 1: Substream (screen sharing stream) This parameter specifies the type of the stream displayed in the big window. If it appears in `MixLayoutList`, it indicates the type of the stream of a specified user.

getBackgroundImageUrl

public String getBackgroundImageUrl()

Get The URL of the background image, which cannot contain Chinese characters. The image must be in JPG or PNG format and cannot be larger than 5 MB.

Returns:

BackgroundImageUrl The URL of the background image, which cannot contain Chinese characters. The image must be in JPG or PNG format and cannot be larger than 5 MB.

setBackgroundImageUrl

public void setBackgroundImageUrl(String BackgroundImageUrl)

Set The URL of the background image, which cannot contain Chinese characters. The image must be in JPG or PNG format and cannot be larger than 5 MB.

Parameters:

BackgroundImageUrl - The URL of the background image, which cannot contain Chinese characters. The image must be in JPG or PNG format and cannot be larger than 5 MB.

getPlaceHolderMode

public Long getPlaceHolderMode()

Get `1` means to use placeholders, and `0` (default) means to not use placeholders. If this parameter is set to `1`, when a user is not publishing video, a placeholder image will be displayed in the window reserved for the user.

Returns:

PlaceHolderMode `1` means to use placeholders, and `0` (default) means to not use placeholders. If this parameter is set to `1`, when a user is not publishing video, a placeholder image will be displayed in the window reserved for the user.

setPlaceHolderMode

public void setPlaceHolderMode(Long PlaceHolderMode)

Set `1` means to use placeholders, and `0` (default) means to not use placeholders. If this parameter is set to `1`, when a user is not publishing video, a placeholder image will be displayed in the window reserved for the user.

Parameters:

PlaceHolderMode - `1` means to use placeholders, and `0` (default) means to not use placeholders. If this parameter is set to `1`, when a user is not publishing video, a placeholder image will be displayed in the window reserved for the user.

getBackgroundImageRenderMode

public Long getBackgroundImageRenderMode()

Get The render mode to use when the aspect ratio of a video is different from that of the window. This parameter is defined the same as `RenderMode` in `MixLayoufList`.

Returns:

BackgroundImageRenderMode The render mode to use when the aspect ratio of a video is different from that of the window. This parameter is defined the same as `RenderMode` in `MixLayoufList`.

setBackgroundImageRenderMode

public void setBackgroundImageRenderMode(Long BackgroundImageRenderMode)

Set The render mode to use when the aspect ratio of a video is different from that of the window. This parameter is defined the same as `RenderMode` in `MixLayoufList`.

Parameters:

BackgroundImageRenderMode - The render mode to use when the aspect ratio of a video is different from that of the window. This parameter is defined the same as `RenderMode` in `MixLayoufList`.

getDefaultSubBackgroundImage

public String getDefaultSubBackgroundImage()

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:

DefaultSubBackgroundImage 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`.

setDefaultSubBackgroundImage

public void setDefaultSubBackgroundImage(String DefaultSubBackgroundImage)

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:

DefaultSubBackgroundImage - 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`.

getWaterMarkList

public WaterMark[] getWaterMarkList()

Get The watermark layout. Up to 25 watermarks are supported.

Returns:

WaterMarkList The watermark layout. Up to 25 watermarks are supported.

setWaterMarkList

public void setWaterMarkList(WaterMark[] WaterMarkList)

Set The watermark layout. Up to 25 watermarks are supported.

Parameters:

WaterMarkList - The watermark layout. Up to 25 watermarks are supported.

getRenderMode

public Long getRenderMode()

Get The render mode to use when the aspect ratio of a video is different from that of the window. This parameter is invalid if a custom layout is used. It is defined the same as `RenderMode` in `MixLayoufList`.

Returns:

RenderMode The render mode to use when the aspect ratio of a video is different from that of the window. This parameter is invalid if a custom layout is used. It is defined the same as `RenderMode` in `MixLayoufList`.

setRenderMode

public void setRenderMode(Long RenderMode)

Set The render mode to use when the aspect ratio of a video is different from that of the window. This parameter is invalid if a custom layout is used. It is defined the same as `RenderMode` in `MixLayoufList`.

Parameters:

RenderMode - The render mode to use when the aspect ratio of a video is different from that of the window. This parameter is invalid if a custom layout is used. It is defined the same as `RenderMode` in `MixLayoufList`.

getMaxResolutionUserAlign

public Long getMaxResolutionUserAlign()

Get This parameter is valid only if the screen sharing layout is used. If you set it to `1`, the large video window will appear on the right and the small window on the left. The default value is `0`.

Returns:

MaxResolutionUserAlign This parameter is valid only if the screen sharing layout is used. If you set it to `1`, the large video window will appear on the right and the small window on the left. The default value is `0`.

setMaxResolutionUserAlign

public void setMaxResolutionUserAlign(Long MaxResolutionUserAlign)

Set This parameter is valid only if the screen sharing layout is used. If you set it to `1`, the large video window will appear on the right and the small window on the left. The default value is `0`.

Parameters:

MaxResolutionUserAlign - This parameter is valid only if the screen sharing layout is used. If you set it to `1`, the large video window will appear on the right and the small window on the left. The default value is `0`.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel