com.tencentcloudapi.trtc.v20190722.models

Class McuLayout

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.trtc.v20190722.models.McuLayout

public class McuLayout
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
McuLayout()
McuLayout(McuLayout 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 of the video.
String	getBackgroundImageUrl() Get The URL of the background image for the video.
McuCustomCrop	getCustomCrop() Get Custom cropping.
Long	getImageHeight() Get The video height (pixels).
Long	getImageWidth() Get The video width (pixels).
Long	getLocationX() Get The horizontal offset (pixels) of the video.
Long	getLocationY() Get The vertical offset of the video.
Long	getRenderMode() Get The rendering mode of the video.
UserMediaStream	getUserMediaStream() Get The information of the stream that is displayed.
Long	getZOrder() Get The image layer of the video.
void	setBackGroundColor(String BackGroundColor) Set The background color of the video.
void	setBackgroundImageUrl(String BackgroundImageUrl) Set The URL of the background image for the video.
void	setCustomCrop(McuCustomCrop CustomCrop) Set Custom cropping.
void	setImageHeight(Long ImageHeight) Set The video height (pixels).
void	setImageWidth(Long ImageWidth) Set The video width (pixels).
void	setLocationX(Long LocationX) Set The horizontal offset (pixels) of the video.
void	setLocationY(Long LocationY) Set The vertical offset of the video.
void	setRenderMode(Long RenderMode) Set The rendering mode of the video.
void	setUserMediaStream(UserMediaStream UserMediaStream) Set The information of the stream that is displayed.
void	setZOrder(Long ZOrder) Set The image layer of the video.
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

McuLayout

public McuLayout()

McuLayout

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

getUserMediaStream

public UserMediaStream getUserMediaStream()

Get The information of the stream that is displayed. If you do not pass this parameter, TRTC will display the videos of anchors in the room according to their room entry sequence.

Returns:

UserMediaStream The information of the stream that is displayed. If you do not pass this parameter, TRTC will display the videos of anchors in the room according to their room entry sequence.

setUserMediaStream

public void setUserMediaStream(UserMediaStream UserMediaStream)

Set The information of the stream that is displayed. If you do not pass this parameter, TRTC will display the videos of anchors in the room according to their room entry sequence.

Parameters:

UserMediaStream - The information of the stream that is displayed. If you do not pass this parameter, TRTC will display the videos of anchors in the room according to their room entry sequence.

getImageWidth

public Long getImageWidth()

Get The video width (pixels). If you do not pass this parameter, 0 will be used.

Returns:

ImageWidth The video width (pixels). If you do not pass this parameter, 0 will be used.

setImageWidth

public void setImageWidth(Long ImageWidth)

Set The video width (pixels). If you do not pass this parameter, 0 will be used.

Parameters:

ImageWidth - The video width (pixels). If you do not pass this parameter, 0 will be used.

getImageHeight

public Long getImageHeight()

Get The video height (pixels). If you do not pass this parameter, 0 will be used.

Returns:

ImageHeight The video height (pixels). If you do not pass this parameter, 0 will be used.

setImageHeight

public void setImageHeight(Long ImageHeight)

Set The video height (pixels). If you do not pass this parameter, 0 will be used.

Parameters:

ImageHeight - The video height (pixels). If you do not pass this parameter, 0 will be used.

getLocationX

public Long getLocationX()

Get The horizontal offset (pixels) of the video. The sum of `LocationX` and `ImageWidth` cannot exceed the width of the canvas. If you do not pass this parameter, 0 will be used.

Returns:

LocationX The horizontal offset (pixels) of the video. The sum of `LocationX` and `ImageWidth` cannot exceed the width of the canvas. If you do not pass this parameter, 0 will be used.

setLocationX

public void setLocationX(Long LocationX)

Set The horizontal offset (pixels) of the video. The sum of `LocationX` and `ImageWidth` cannot exceed the width of the canvas. If you do not pass this parameter, 0 will be used.

Parameters:

LocationX - The horizontal offset (pixels) of the video. The sum of `LocationX` and `ImageWidth` cannot exceed the width of the canvas. If you do not pass this parameter, 0 will be used.

getLocationY

public Long getLocationY()

Get The vertical offset of the video. The sum of `LocationY` and `ImageHeight` cannot exceed the height of the canvas. If you do not pass this parameter, 0 will be used.

Returns:

LocationY The vertical offset of the video. The sum of `LocationY` and `ImageHeight` cannot exceed the height of the canvas. If you do not pass this parameter, 0 will be used.

setLocationY

public void setLocationY(Long LocationY)

Set The vertical offset of the video. The sum of `LocationY` and `ImageHeight` cannot exceed the height of the canvas. If you do not pass this parameter, 0 will be used.

Parameters:

LocationY - The vertical offset of the video. The sum of `LocationY` and `ImageHeight` cannot exceed the height of the canvas. If you do not pass this parameter, 0 will be used.

getZOrder

public Long getZOrder()

Get The image layer of the video. If you do not pass this parameter, 0 will be used.

Returns:

ZOrder The image layer of the video. If you do not pass this parameter, 0 will be used.

setZOrder

public void setZOrder(Long ZOrder)

Set The image layer of the video. If you do not pass this parameter, 0 will be used.

Parameters:

ZOrder - The image layer of the video. If you do not pass this parameter, 0 will be used.

getRenderMode

public Long getRenderMode()

Get The rendering mode of the video. 0 (the video is scaled and the excess parts are cropped), 1 (the video is scaled), 2 (the video is scaled and the blank spaces are filled with black bars). If you do not pass this parameter, 0 will be used.

Returns:

RenderMode The rendering mode of the video. 0 (the video is scaled and the excess parts are cropped), 1 (the video is scaled), 2 (the video is scaled and the blank spaces are filled with black bars). If you do not pass this parameter, 0 will be used.

setRenderMode

public void setRenderMode(Long RenderMode)

Set The rendering mode of the video. 0 (the video is scaled and the excess parts are cropped), 1 (the video is scaled), 2 (the video is scaled and the blank spaces are filled with black bars). If you do not pass this parameter, 0 will be used.

Parameters:

RenderMode - The rendering mode of the video. 0 (the video is scaled and the excess parts are cropped), 1 (the video is scaled), 2 (the video is scaled and the blank spaces are filled with black bars). If you do not pass this parameter, 0 will be used.

getBackGroundColor

public String getBackGroundColor()

Get The background color of the video. Below are the values for some common colors: Red: 0xcc0033 Yellow: 0xcc9900 Green: 0xcccc33 Blue: 0x99CCFF Black: 0x000000 White: 0xFFFFFF Grey: 0x999999

Returns:

BackGroundColor The background color of the video. Below are the values for some common colors: Red: 0xcc0033 Yellow: 0xcc9900 Green: 0xcccc33 Blue: 0x99CCFF Black: 0x000000 White: 0xFFFFFF Grey: 0x999999

setBackGroundColor

public void setBackGroundColor(String BackGroundColor)

Set The background color of the video. Below are the values for some common colors: Red: 0xcc0033 Yellow: 0xcc9900 Green: 0xcccc33 Blue: 0x99CCFF Black: 0x000000 White: 0xFFFFFF Grey: 0x999999

Parameters:

BackGroundColor - The background color of the video. Below are the values for some common colors: Red: 0xcc0033 Yellow: 0xcc9900 Green: 0xcccc33 Blue: 0x99CCFF Black: 0x000000 White: 0xFFFFFF Grey: 0x999999

getBackgroundImageUrl

public String getBackgroundImageUrl()

Get The URL of the background image for the video. This parameter allows you to specify an image to display when the user’s camera is turned off or before the user enters the room. If the dimensions of the image specified are different from those of the video window, the image will be stretched to fit the space. This parameter has a higher priority than `BackGroundColor`.

Returns:

BackgroundImageUrl The URL of the background image for the video. This parameter allows you to specify an image to display when the user’s camera is turned off or before the user enters the room. If the dimensions of the image specified are different from those of the video window, the image will be stretched to fit the space. This parameter has a higher priority than `BackGroundColor`.

setBackgroundImageUrl

public void setBackgroundImageUrl(String BackgroundImageUrl)

Set The URL of the background image for the video. This parameter allows you to specify an image to display when the user’s camera is turned off or before the user enters the room. If the dimensions of the image specified are different from those of the video window, the image will be stretched to fit the space. This parameter has a higher priority than `BackGroundColor`.

Parameters:

BackgroundImageUrl - The URL of the background image for the video. This parameter allows you to specify an image to display when the user’s camera is turned off or before the user enters the room. If the dimensions of the image specified are different from those of the video window, the image will be stretched to fit the space. This parameter has a higher priority than `BackGroundColor`.

getCustomCrop

public McuCustomCrop getCustomCrop()

Get Custom cropping.

Returns:

CustomCrop Custom cropping.

setCustomCrop

public void setCustomCrop(McuCustomCrop CustomCrop)

Set Custom cropping.

Parameters:

CustomCrop - Custom cropping.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel