LayoutParams (tencentcloud-sdk-java 3.1.784 API)

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

public class LayoutParams
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description
`LayoutParams()`
`LayoutParams(LayoutParams 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`	`getMainVideoRightAlign()` Get 屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。
`Long`	`getMainVideoStreamType()` Get 屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的流类型，0为摄像头，1为屏幕分享。左侧大画面为web用户时此值填0。
`String`	`getMainVideoUserId()` Get 屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的用户ID。
`String[]`	`getMixVideoUids()` Get 指定混视频的用户ID列表。设置此参数后，输出流混合此参数中包含用户的音视频，以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效，最多可设置16个用户。
`Long`	`getPlaceHolderMode()` Get 自定义模板中有效，设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。
`PresetLayoutConfig[]`	`getPresetLayoutConfig()` Get 自定义模板中有效，指定用户视频在混合画面中的位置。
`Long`	`getPureAudioHoldPlaceMode()` Get 悬浮模板、九宫格、屏幕分享模板生效，用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式，悬浮小画面占布局位置，九宫格画面占布局位置、屏幕分享小画面不占布局位置；设置为1时代表纯音频上行占布局位置；设置为2时代表纯音频上行不占布局位置。默认为0。
`Long`	`getRenderMode()` Get 屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底，不填采用后台的默认渲染方式（屏幕分享大画面为缩放，其他为裁剪）。若此参数不生效，请提交工单寻求帮助。
`SmallVideoLayoutParams`	`getSmallVideoLayoutParams()` Get 画中画模板中有效，代表小画面的布局参数。
`Long`	`getTemplate()` Get 混流布局模板ID，0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
`WaterMarkParams`	`getWaterMarkParams()` Get 水印参数。
`void`	`setMainVideoRightAlign(Long MainVideoRightAlign)` Set 屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。
`void`	`setMainVideoStreamType(Long MainVideoStreamType)` Set 屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的流类型，0为摄像头，1为屏幕分享。左侧大画面为web用户时此值填0。
`void`	`setMainVideoUserId(String MainVideoUserId)` Set 屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的用户ID。
`void`	`setMixVideoUids(String[] MixVideoUids)` Set 指定混视频的用户ID列表。设置此参数后，输出流混合此参数中包含用户的音视频，以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效，最多可设置16个用户。
`void`	`setPlaceHolderMode(Long PlaceHolderMode)` Set 自定义模板中有效，设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。
`void`	`setPresetLayoutConfig(PresetLayoutConfig[] PresetLayoutConfig)` Set 自定义模板中有效，指定用户视频在混合画面中的位置。
`void`	`setPureAudioHoldPlaceMode(Long PureAudioHoldPlaceMode)` Set 悬浮模板、九宫格、屏幕分享模板生效，用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式，悬浮小画面占布局位置，九宫格画面占布局位置、屏幕分享小画面不占布局位置；设置为1时代表纯音频上行占布局位置；设置为2时代表纯音频上行不占布局位置。默认为0。
`void`	`setRenderMode(Long RenderMode)` Set 屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底，不填采用后台的默认渲染方式（屏幕分享大画面为缩放，其他为裁剪）。若此参数不生效，请提交工单寻求帮助。
`void`	`setSmallVideoLayoutParams(SmallVideoLayoutParams SmallVideoLayoutParams)` Set 画中画模板中有效，代表小画面的布局参数。
`void`	`setTemplate(Long Template)` Set 混流布局模板ID，0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
`void`	`setWaterMarkParams(WaterMarkParams WaterMarkParams)` Set 水印参数。
`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
  - LayoutParams
```
public LayoutParams()
```
  - LayoutParams
```
public LayoutParams(LayoutParams 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
  - getTemplate
```
public Long getTemplate()
```
    Get 混流布局模板ID，0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
    
    Returns:
    
    Template 混流布局模板ID，0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
  - setTemplate
```
public void setTemplate(Long Template)
```
    Set 混流布局模板ID，0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
    
    Parameters:
    
    Template - 混流布局模板ID，0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。
  - getMainVideoUserId
```
public String getMainVideoUserId()
```
    Get 屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的用户ID。
    
    Returns:
    
    MainVideoUserId 屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的用户ID。
  - setMainVideoUserId
```
public void setMainVideoUserId(String MainVideoUserId)
```
    Set 屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的用户ID。
    
    Parameters:
    
    MainVideoUserId - 屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的用户ID。
  - getMainVideoStreamType
```
public Long getMainVideoStreamType()
```
    Get 屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的流类型，0为摄像头，1为屏幕分享。左侧大画面为web用户时此值填0。
    
    Returns:
    
    MainVideoStreamType 屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的流类型，0为摄像头，1为屏幕分享。左侧大画面为web用户时此值填0。
  - setMainVideoStreamType
```
public void setMainVideoStreamType(Long MainVideoStreamType)
```
    Set 屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的流类型，0为摄像头，1为屏幕分享。左侧大画面为web用户时此值填0。
    
    Parameters:
    
    MainVideoStreamType - 屏幕分享模板、悬浮模板、画中画模板中有效，代表大画面对应的流类型，0为摄像头，1为屏幕分享。左侧大画面为web用户时此值填0。
  - getSmallVideoLayoutParams
```
public SmallVideoLayoutParams getSmallVideoLayoutParams()
```
    Get 画中画模板中有效，代表小画面的布局参数。
    
    Returns:
    
    SmallVideoLayoutParams 画中画模板中有效，代表小画面的布局参数。
  - setSmallVideoLayoutParams
```
public void setSmallVideoLayoutParams(SmallVideoLayoutParams SmallVideoLayoutParams)
```
    Set 画中画模板中有效，代表小画面的布局参数。
    
    Parameters:
    
    SmallVideoLayoutParams - 画中画模板中有效，代表小画面的布局参数。
  - getMainVideoRightAlign
```
public Long getMainVideoRightAlign()
```
    Get 屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。
    
    Returns:
    
    MainVideoRightAlign 屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。
  - setMainVideoRightAlign
```
public void setMainVideoRightAlign(Long MainVideoRightAlign)
```
    Set 屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。
    
    Parameters:
    
    MainVideoRightAlign - 屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。
  - getMixVideoUids
```
public String[] getMixVideoUids()
```
    Get 指定混视频的用户ID列表。设置此参数后，输出流混合此参数中包含用户的音视频，以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效，最多可设置16个用户。
    
    Returns:
    
    MixVideoUids 指定混视频的用户ID列表。设置此参数后，输出流混合此参数中包含用户的音视频，以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效，最多可设置16个用户。
  - setMixVideoUids
```
public void setMixVideoUids(String[] MixVideoUids)
```
    Set 指定混视频的用户ID列表。设置此参数后，输出流混合此参数中包含用户的音视频，以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效，最多可设置16个用户。
    
    Parameters:
    
    MixVideoUids - 指定混视频的用户ID列表。设置此参数后，输出流混合此参数中包含用户的音视频，以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效，最多可设置16个用户。
  - getPresetLayoutConfig
```
public PresetLayoutConfig[] getPresetLayoutConfig()
```
    Get 自定义模板中有效，指定用户视频在混合画面中的位置。
    
    Returns:
    
    PresetLayoutConfig 自定义模板中有效，指定用户视频在混合画面中的位置。
  - setPresetLayoutConfig
```
public void setPresetLayoutConfig(PresetLayoutConfig[] PresetLayoutConfig)
```
    Set 自定义模板中有效，指定用户视频在混合画面中的位置。
    
    Parameters:
    
    PresetLayoutConfig - 自定义模板中有效，指定用户视频在混合画面中的位置。
  - getPlaceHolderMode
```
public Long getPlaceHolderMode()
```
    Get 自定义模板中有效，设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。
    
    Returns:
    
    PlaceHolderMode 自定义模板中有效，设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。
  - setPlaceHolderMode
```
public void setPlaceHolderMode(Long PlaceHolderMode)
```
    Set 自定义模板中有效，设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。
    
    Parameters:
    
    PlaceHolderMode - 自定义模板中有效，设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。
  - getPureAudioHoldPlaceMode
```
public Long getPureAudioHoldPlaceMode()
```
    Get 悬浮模板、九宫格、屏幕分享模板生效，用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式，悬浮小画面占布局位置，九宫格画面占布局位置、屏幕分享小画面不占布局位置；设置为1时代表纯音频上行占布局位置；设置为2时代表纯音频上行不占布局位置。默认为0。
    
    Returns:
    
    PureAudioHoldPlaceMode 悬浮模板、九宫格、屏幕分享模板生效，用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式，悬浮小画面占布局位置，九宫格画面占布局位置、屏幕分享小画面不占布局位置；设置为1时代表纯音频上行占布局位置；设置为2时代表纯音频上行不占布局位置。默认为0。
  - setPureAudioHoldPlaceMode
```
public void setPureAudioHoldPlaceMode(Long PureAudioHoldPlaceMode)
```
    Set 悬浮模板、九宫格、屏幕分享模板生效，用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式，悬浮小画面占布局位置，九宫格画面占布局位置、屏幕分享小画面不占布局位置；设置为1时代表纯音频上行占布局位置；设置为2时代表纯音频上行不占布局位置。默认为0。
    
    Parameters:
    
    PureAudioHoldPlaceMode - 悬浮模板、九宫格、屏幕分享模板生效，用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式，悬浮小画面占布局位置，九宫格画面占布局位置、屏幕分享小画面不占布局位置；设置为1时代表纯音频上行占布局位置；设置为2时代表纯音频上行不占布局位置。默认为0。
  - getWaterMarkParams
```
public WaterMarkParams getWaterMarkParams()
```
    Get 水印参数。
    
    Returns:
    
    WaterMarkParams 水印参数。
  - setWaterMarkParams
```
public void setWaterMarkParams(WaterMarkParams WaterMarkParams)
```
    Set 水印参数。
    
    Parameters:
    
    WaterMarkParams - 水印参数。
  - getRenderMode
```
public Long getRenderMode()
```
    Get 屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底，不填采用后台的默认渲染方式（屏幕分享大画面为缩放，其他为裁剪）。若此参数不生效，请提交工单寻求帮助。
    
    Returns:
    
    RenderMode 屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底，不填采用后台的默认渲染方式（屏幕分享大画面为缩放，其他为裁剪）。若此参数不生效，请提交工单寻求帮助。
  - setRenderMode
```
public void setRenderMode(Long RenderMode)
```
    Set 屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底，不填采用后台的默认渲染方式（屏幕分享大画面为缩放，其他为裁剪）。若此参数不生效，请提交工单寻求帮助。
    
    Parameters:
    
    RenderMode - 屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底，不填采用后台的默认渲染方式（屏幕分享大画面为缩放，其他为裁剪）。若此参数不生效，请提交工单寻求帮助。
  - 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 LayoutParams

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

LayoutParams

LayoutParams

Method Detail

getTemplate

setTemplate

getMainVideoUserId

setMainVideoUserId

getMainVideoStreamType

setMainVideoStreamType

getSmallVideoLayoutParams

setSmallVideoLayoutParams

getMainVideoRightAlign

setMainVideoRightAlign

getMixVideoUids

setMixVideoUids

getPresetLayoutConfig

setPresetLayoutConfig

getPlaceHolderMode

setPlaceHolderMode

getPureAudioHoldPlaceMode

setPureAudioHoldPlaceMode

getWaterMarkParams

setWaterMarkParams

getRenderMode

setRenderMode

toMap