McuLayout (tencentcloud-sdk-java 3.1.834 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.trtc.v20190722.models.McuLayout

public class McuLayout
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  skipSign

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBackGroundColor()` Get 【此参数配置无效，暂不支持】子画面的背景颜色，常用的颜色有：红色：0xcc0033。黄色：0xcc9900。绿色：0xcccc33。蓝色：0x99CCFF。黑色：0x000000。白色：0xFFFFFF。灰色：0x999999。
`String`	`getBackgroundImageUrl()` Get 子画面的背景图url，填写该参数，当用户关闭摄像头或未进入TRTC房间时，会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致，则会对图片进行拉伸处理，优先级高于BackGroundColor。
`Long`	`getBackgroundRenderMode()` Get 子背景图在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底，3为变比例伸缩。不填默认为3。
`McuCustomCrop`	`getCustomCrop()` Get 客户自定义裁剪，针对原始输入流裁剪
`Long`	`getImageHeight()` Get 子画面在输出时的高度，单位为像素值，不填默认为0。
`Long`	`getImageWidth()` Get 子画面在输出时的宽度，单位为像素值，不填默认为0。
`Long`	`getLocationX()` Get 子画面在输出时的X偏移，单位为像素值，LocationX与ImageWidth之和不能超过混流输出的总宽度，不填默认为0。
`Long`	`getLocationY()` Get 子画面在输出时的Y偏移，单位为像素值，LocationY与ImageHeight之和不能超过混流输出的总高度，不填默认为0。
`Long`	`getRenderMode()` Get 子画面在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底。不填默认为0。
`UserMediaStream`	`getUserMediaStream()` Get 用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。
`Long`	`getZOrder()` Get 子画面在输出时的层级，不填默认为0。
`void`	`setBackGroundColor(String BackGroundColor)` Set 【此参数配置无效，暂不支持】子画面的背景颜色，常用的颜色有：红色：0xcc0033。黄色：0xcc9900。绿色：0xcccc33。蓝色：0x99CCFF。黑色：0x000000。白色：0xFFFFFF。灰色：0x999999。
`void`	`setBackgroundImageUrl(String BackgroundImageUrl)` Set 子画面的背景图url，填写该参数，当用户关闭摄像头或未进入TRTC房间时，会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致，则会对图片进行拉伸处理，优先级高于BackGroundColor。
`void`	`setBackgroundRenderMode(Long BackgroundRenderMode)` Set 子背景图在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底，3为变比例伸缩。不填默认为3。
`void`	`setCustomCrop(McuCustomCrop CustomCrop)` Set 客户自定义裁剪，针对原始输入流裁剪
`void`	`setImageHeight(Long ImageHeight)` Set 子画面在输出时的高度，单位为像素值，不填默认为0。
`void`	`setImageWidth(Long ImageWidth)` Set 子画面在输出时的宽度，单位为像素值，不填默认为0。
`void`	`setLocationX(Long LocationX)` Set 子画面在输出时的X偏移，单位为像素值，LocationX与ImageWidth之和不能超过混流输出的总宽度，不填默认为0。
`void`	`setLocationY(Long LocationY)` Set 子画面在输出时的Y偏移，单位为像素值，LocationY与ImageHeight之和不能超过混流输出的总高度，不填默认为0。
`void`	`setRenderMode(Long RenderMode)` Set 子画面在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底。不填默认为0。
`void`	`setUserMediaStream(UserMediaStream UserMediaStream)` Set 用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。
`void`	`setZOrder(Long ZOrder)` Set 子画面在输出时的层级，不填默认为0。
`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, getSkipSign, set, 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
  - 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 用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。
    
    Returns:
    
    UserMediaStream 用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。
  - setUserMediaStream
```
public void setUserMediaStream(UserMediaStream UserMediaStream)
```
    Set 用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。
    
    Parameters:
    
    UserMediaStream - 用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。
  - getImageWidth
```
public Long getImageWidth()
```
    Get 子画面在输出时的宽度，单位为像素值，不填默认为0。
    
    Returns:
    
    ImageWidth 子画面在输出时的宽度，单位为像素值，不填默认为0。
  - setImageWidth
```
public void setImageWidth(Long ImageWidth)
```
    Set 子画面在输出时的宽度，单位为像素值，不填默认为0。
    
    Parameters:
    
    ImageWidth - 子画面在输出时的宽度，单位为像素值，不填默认为0。
  - getImageHeight
```
public Long getImageHeight()
```
    Get 子画面在输出时的高度，单位为像素值，不填默认为0。
    
    Returns:
    
    ImageHeight 子画面在输出时的高度，单位为像素值，不填默认为0。
  - setImageHeight
```
public void setImageHeight(Long ImageHeight)
```
    Set 子画面在输出时的高度，单位为像素值，不填默认为0。
    
    Parameters:
    
    ImageHeight - 子画面在输出时的高度，单位为像素值，不填默认为0。
  - getLocationX
```
public Long getLocationX()
```
    Get 子画面在输出时的X偏移，单位为像素值，LocationX与ImageWidth之和不能超过混流输出的总宽度，不填默认为0。
    
    Returns:
    
    LocationX 子画面在输出时的X偏移，单位为像素值，LocationX与ImageWidth之和不能超过混流输出的总宽度，不填默认为0。
  - setLocationX
```
public void setLocationX(Long LocationX)
```
    Set 子画面在输出时的X偏移，单位为像素值，LocationX与ImageWidth之和不能超过混流输出的总宽度，不填默认为0。
    
    Parameters:
    
    LocationX - 子画面在输出时的X偏移，单位为像素值，LocationX与ImageWidth之和不能超过混流输出的总宽度，不填默认为0。
  - getLocationY
```
public Long getLocationY()
```
    Get 子画面在输出时的Y偏移，单位为像素值，LocationY与ImageHeight之和不能超过混流输出的总高度，不填默认为0。
    
    Returns:
    
    LocationY 子画面在输出时的Y偏移，单位为像素值，LocationY与ImageHeight之和不能超过混流输出的总高度，不填默认为0。
  - setLocationY
```
public void setLocationY(Long LocationY)
```
    Set 子画面在输出时的Y偏移，单位为像素值，LocationY与ImageHeight之和不能超过混流输出的总高度，不填默认为0。
    
    Parameters:
    
    LocationY - 子画面在输出时的Y偏移，单位为像素值，LocationY与ImageHeight之和不能超过混流输出的总高度，不填默认为0。
  - getZOrder
```
public Long getZOrder()
```
    Get 子画面在输出时的层级，不填默认为0。
    
    Returns:
    
    ZOrder 子画面在输出时的层级，不填默认为0。
  - setZOrder
```
public void setZOrder(Long ZOrder)
```
    Set 子画面在输出时的层级，不填默认为0。
    
    Parameters:
    
    ZOrder - 子画面在输出时的层级，不填默认为0。
  - getRenderMode
```
public Long getRenderMode()
```
    Get 子画面在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底。不填默认为0。
    
    Returns:
    
    RenderMode 子画面在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底。不填默认为0。
  - setRenderMode
```
public void setRenderMode(Long RenderMode)
```
    Set 子画面在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底。不填默认为0。
    
    Parameters:
    
    RenderMode - 子画面在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底。不填默认为0。
  - getBackGroundColor
```
public String getBackGroundColor()
```
    Get 【此参数配置无效，暂不支持】子画面的背景颜色，常用的颜色有：红色：0xcc0033。黄色：0xcc9900。绿色：0xcccc33。蓝色：0x99CCFF。黑色：0x000000。白色：0xFFFFFF。灰色：0x999999。
    
    Returns:
    
    BackGroundColor 【此参数配置无效，暂不支持】子画面的背景颜色，常用的颜色有：红色：0xcc0033。黄色：0xcc9900。绿色：0xcccc33。蓝色：0x99CCFF。黑色：0x000000。白色：0xFFFFFF。灰色：0x999999。
  - setBackGroundColor
```
public void setBackGroundColor(String BackGroundColor)
```
    Set 【此参数配置无效，暂不支持】子画面的背景颜色，常用的颜色有：红色：0xcc0033。黄色：0xcc9900。绿色：0xcccc33。蓝色：0x99CCFF。黑色：0x000000。白色：0xFFFFFF。灰色：0x999999。
    
    Parameters:
    
    BackGroundColor - 【此参数配置无效，暂不支持】子画面的背景颜色，常用的颜色有：红色：0xcc0033。黄色：0xcc9900。绿色：0xcccc33。蓝色：0x99CCFF。黑色：0x000000。白色：0xFFFFFF。灰色：0x999999。
  - getBackgroundImageUrl
```
public String getBackgroundImageUrl()
```
    Get 子画面的背景图url，填写该参数，当用户关闭摄像头或未进入TRTC房间时，会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致，则会对图片进行拉伸处理，优先级高于BackGroundColor。
    
    Returns:
    
    BackgroundImageUrl 子画面的背景图url，填写该参数，当用户关闭摄像头或未进入TRTC房间时，会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致，则会对图片进行拉伸处理，优先级高于BackGroundColor。
  - setBackgroundImageUrl
```
public void setBackgroundImageUrl(String BackgroundImageUrl)
```
    Set 子画面的背景图url，填写该参数，当用户关闭摄像头或未进入TRTC房间时，会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致，则会对图片进行拉伸处理，优先级高于BackGroundColor。
    
    Parameters:
    
    BackgroundImageUrl - 子画面的背景图url，填写该参数，当用户关闭摄像头或未进入TRTC房间时，会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致，则会对图片进行拉伸处理，优先级高于BackGroundColor。
  - getCustomCrop
```
public McuCustomCrop getCustomCrop()
```
    Get 客户自定义裁剪，针对原始输入流裁剪
    
    Returns:
    
    CustomCrop 客户自定义裁剪，针对原始输入流裁剪
  - setCustomCrop
```
public void setCustomCrop(McuCustomCrop CustomCrop)
```
    Set 客户自定义裁剪，针对原始输入流裁剪
    
    Parameters:
    
    CustomCrop - 客户自定义裁剪，针对原始输入流裁剪
  - getBackgroundRenderMode
```
public Long getBackgroundRenderMode()
```
    Get 子背景图在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底，3为变比例伸缩。不填默认为3。
    
    Returns:
    
    BackgroundRenderMode 子背景图在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底，3为变比例伸缩。不填默认为3。
  - setBackgroundRenderMode
```
public void setBackgroundRenderMode(Long BackgroundRenderMode)
```
    Set 子背景图在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底，3为变比例伸缩。不填默认为3。
    
    Parameters:
    
    BackgroundRenderMode - 子背景图在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底，3为变比例伸缩。不填默认为3。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class McuLayout

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

McuLayout

McuLayout

Method Detail

getUserMediaStream

setUserMediaStream

getImageWidth

setImageWidth

getImageHeight

setImageHeight

getLocationX

setLocationX

getLocationY

setLocationY

getZOrder

setZOrder

getRenderMode

setRenderMode

getBackGroundColor

setBackGroundColor

getBackgroundImageUrl

setBackgroundImageUrl

getCustomCrop

setCustomCrop

getBackgroundRenderMode

setBackgroundRenderMode

toMap