com.tencentcloudapi.trtc.v20190722.models

Class McuLayoutParams

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.trtc.v20190722.models.McuLayoutParams

public class McuLayoutParams
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
McuLayoutParams()
McuLayoutParams(McuLayoutParams 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
MaxVideoUser	getMaxVideoUser() Get The information of the large video in screen sharing or floating layout mode.
McuLayout[]	getMixLayoutList() Get The details of a custom layout.
Long	getMixLayoutMode() Get The layout mode.
Long	getPureAudioHoldPlaceMode() Get Whether to display users who publish only audio.
Long	getRenderMode() Get The image fill mode.
void	setMaxVideoUser(MaxVideoUser MaxVideoUser) Set The information of the large video in screen sharing or floating layout mode.
void	setMixLayoutList(McuLayout[] MixLayoutList) Set The details of a custom layout.
void	setMixLayoutMode(Long MixLayoutMode) Set The layout mode.
void	setPureAudioHoldPlaceMode(Long PureAudioHoldPlaceMode) Set Whether to display users who publish only audio.
void	setRenderMode(Long RenderMode) Set The image fill mode.
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, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, 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

McuLayoutParams

public McuLayoutParams()

McuLayoutParams

public McuLayoutParams(McuLayoutParams 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 The layout mode. Valid values: 1 (floating), 2 (screen sharing), 3 (grid), 4 (custom). Floating, screen sharing, and grid are dynamic layouts. Custom layouts are static layouts.

Returns:

MixLayoutMode The layout mode. Valid values: 1 (floating), 2 (screen sharing), 3 (grid), 4 (custom). Floating, screen sharing, and grid are dynamic layouts. Custom layouts are static layouts.

setMixLayoutMode

public void setMixLayoutMode(Long MixLayoutMode)

Set The layout mode. Valid values: 1 (floating), 2 (screen sharing), 3 (grid), 4 (custom). Floating, screen sharing, and grid are dynamic layouts. Custom layouts are static layouts.

Parameters:

MixLayoutMode - The layout mode. Valid values: 1 (floating), 2 (screen sharing), 3 (grid), 4 (custom). Floating, screen sharing, and grid are dynamic layouts. Custom layouts are static layouts.

getPureAudioHoldPlaceMode

public Long getPureAudioHoldPlaceMode()

Get Whether to display users who publish only audio. 0: No; 1: Yes. This parameter is valid only if a dynamic layout is used. If you do not pass this parameter, 0 will be used.

Returns:

PureAudioHoldPlaceMode Whether to display users who publish only audio. 0: No; 1: Yes. This parameter is valid only if a dynamic layout is used. If you do not pass this parameter, 0 will be used.

setPureAudioHoldPlaceMode

public void setPureAudioHoldPlaceMode(Long PureAudioHoldPlaceMode)

Set Whether to display users who publish only audio. 0: No; 1: Yes. This parameter is valid only if a dynamic layout is used. If you do not pass this parameter, 0 will be used.

Parameters:

PureAudioHoldPlaceMode - Whether to display users who publish only audio. 0: No; 1: Yes. This parameter is valid only if a dynamic layout is used. If you do not pass this parameter, 0 will be used.

getMixLayoutList

public McuLayout[] getMixLayoutList()

Get The details of a custom layout.

Returns:

MixLayoutList The details of a custom layout.

setMixLayoutList

public void setMixLayoutList(McuLayout[] MixLayoutList)

Set The details of a custom layout.

Parameters:

MixLayoutList - The details of a custom layout.

getMaxVideoUser

public MaxVideoUser getMaxVideoUser()

Get The information of the large video in screen sharing or floating layout mode.

Returns:

MaxVideoUser The information of the large video in screen sharing or floating layout mode.

setMaxVideoUser

public void setMaxVideoUser(MaxVideoUser MaxVideoUser)

Set The information of the large video in screen sharing or floating layout mode.

Parameters:

MaxVideoUser - The information of the large video in screen sharing or floating layout mode.

getRenderMode

public Long getRenderMode()

Get The image fill mode. This parameter is valid if the layout mode is screen sharing, floating, or grid. `0`: The image will be cropped. `1`: The image will be scaled. `2`: The image will be scaled and there may be black bars.

Returns:

RenderMode The image fill mode. This parameter is valid if the layout mode is screen sharing, floating, or grid. `0`: The image will be cropped. `1`: The image will be scaled. `2`: The image will be scaled and there may be black bars.

setRenderMode

public void setRenderMode(Long RenderMode)

Set The image fill mode. This parameter is valid if the layout mode is screen sharing, floating, or grid. `0`: The image will be cropped. `1`: The image will be scaled. `2`: The image will be scaled and there may be black bars.

Parameters:

RenderMode - The image fill mode. This parameter is valid if the layout mode is screen sharing, floating, or grid. `0`: The image will be cropped. `1`: The image will be scaled. `2`: The image will be scaled and there may be black bars.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.