PresetLayoutConfig (tencentcloud-sdk-java 3.1.684 API)

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

public class PresetLayoutConfig
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description
`PresetLayoutConfig()`
`PresetLayoutConfig(PresetLayoutConfig 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
`Long`	`getImageHeight()` Get 该画面在输出时的高度，单位为像素值，不填默认为0。
`Long`	`getImageWidth()` Get 该画面在输出时的宽度，单位为像素值，不填默认为0。
`Long`	`getLocationX()` Get 该画面在输出时的X偏移，单位为像素值，LocationX与ImageWidth之和不能超过混流输出的总宽度，不填默认为0。
`Long`	`getLocationY()` Get 该画面在输出时的Y偏移，单位为像素值，LocationY与ImageHeight之和不能超过混流输出的总高度，不填默认为0。
`Long`	`getMixInputType()` Get 该当前位置用户混入的流类型：0为混入音视频，1为只混入视频，2为只混入音频。默认为0，建议配合指定用户ID使用。
`Long`	`getPlaceImageId()` Get 占位图ID。启用占位图功能时，在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M，在实时音视频控制台上传并生成，https://cloud.tencent.com/document/product/647/50769
`Long`	`getRenderMode()` Get 该画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底。不填默认为0。
`Long`	`getStreamType()` Get 当该画面指定用户时，代表用户的流类型。0为摄像头，1为屏幕分享。小画面为web用户时此值填0。
`String`	`getUserId()` Get 指定显示在该画面上的用户ID。如果不指定用户ID，会按照用户加入房间的顺序自动匹配PresetLayoutConfig中的画面设置。
`Long`	`getZOrder()` Get 该画面在输出时的层级，不填默认为0。
`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`	`setMixInputType(Long MixInputType)` Set 该当前位置用户混入的流类型：0为混入音视频，1为只混入视频，2为只混入音频。默认为0，建议配合指定用户ID使用。
`void`	`setPlaceImageId(Long PlaceImageId)` Set 占位图ID。启用占位图功能时，在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M，在实时音视频控制台上传并生成，https://cloud.tencent.com/document/product/647/50769
`void`	`setRenderMode(Long RenderMode)` Set 该画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底。不填默认为0。
`void`	`setStreamType(Long StreamType)` Set 当该画面指定用户时，代表用户的流类型。0为摄像头，1为屏幕分享。小画面为web用户时此值填0。
`void`	`setUserId(String UserId)` Set 指定显示在该画面上的用户ID。如果不指定用户ID，会按照用户加入房间的顺序自动匹配PresetLayoutConfig中的画面设置。
`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, 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
  - PresetLayoutConfig
```
public PresetLayoutConfig()
```
  - PresetLayoutConfig
```
public PresetLayoutConfig(PresetLayoutConfig 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
  - getUserId
```
public String getUserId()
```
    Get 指定显示在该画面上的用户ID。如果不指定用户ID，会按照用户加入房间的顺序自动匹配PresetLayoutConfig中的画面设置。
    
    Returns:
    
    UserId 指定显示在该画面上的用户ID。如果不指定用户ID，会按照用户加入房间的顺序自动匹配PresetLayoutConfig中的画面设置。
  - setUserId
```
public void setUserId(String UserId)
```
    Set 指定显示在该画面上的用户ID。如果不指定用户ID，会按照用户加入房间的顺序自动匹配PresetLayoutConfig中的画面设置。
    
    Parameters:
    
    UserId - 指定显示在该画面上的用户ID。如果不指定用户ID，会按照用户加入房间的顺序自动匹配PresetLayoutConfig中的画面设置。
  - getStreamType
```
public Long getStreamType()
```
    Get 当该画面指定用户时，代表用户的流类型。0为摄像头，1为屏幕分享。小画面为web用户时此值填0。
    
    Returns:
    
    StreamType 当该画面指定用户时，代表用户的流类型。0为摄像头，1为屏幕分享。小画面为web用户时此值填0。
  - setStreamType
```
public void setStreamType(Long StreamType)
```
    Set 当该画面指定用户时，代表用户的流类型。0为摄像头，1为屏幕分享。小画面为web用户时此值填0。
    
    Parameters:
    
    StreamType - 当该画面指定用户时，代表用户的流类型。0为摄像头，1为屏幕分享。小画面为web用户时此值填0。
  - 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。
  - getMixInputType
```
public Long getMixInputType()
```
    Get 该当前位置用户混入的流类型：0为混入音视频，1为只混入视频，2为只混入音频。默认为0，建议配合指定用户ID使用。
    
    Returns:
    
    MixInputType 该当前位置用户混入的流类型：0为混入音视频，1为只混入视频，2为只混入音频。默认为0，建议配合指定用户ID使用。
  - setMixInputType
```
public void setMixInputType(Long MixInputType)
```
    Set 该当前位置用户混入的流类型：0为混入音视频，1为只混入视频，2为只混入音频。默认为0，建议配合指定用户ID使用。
    
    Parameters:
    
    MixInputType - 该当前位置用户混入的流类型：0为混入音视频，1为只混入视频，2为只混入音频。默认为0，建议配合指定用户ID使用。
  - getPlaceImageId
```
public Long getPlaceImageId()
```
    Get 占位图ID。启用占位图功能时，在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M，在实时音视频控制台上传并生成，https://cloud.tencent.com/document/product/647/50769
    
    Returns:
    
    PlaceImageId 占位图ID。启用占位图功能时，在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M，在实时音视频控制台上传并生成，https://cloud.tencent.com/document/product/647/50769
  - setPlaceImageId
```
public void setPlaceImageId(Long PlaceImageId)
```
    Set 占位图ID。启用占位图功能时，在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M，在实时音视频控制台上传并生成，https://cloud.tencent.com/document/product/647/50769
    
    Parameters:
    
    PlaceImageId - 占位图ID。启用占位图功能时，在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M，在实时音视频控制台上传并生成，https://cloud.tencent.com/document/product/647/50769
  - 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 PresetLayoutConfig

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

PresetLayoutConfig

PresetLayoutConfig

Method Detail

getUserId

setUserId

getStreamType

setStreamType

getImageWidth

setImageWidth

getImageHeight

setImageHeight

getLocationX

setLocationX

getLocationY

setLocationY

getZOrder

setZOrder

getRenderMode

setRenderMode

getMixInputType

setMixInputType

getPlaceImageId

setPlaceImageId

toMap