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 指定动态布局中悬浮布局和屏幕分享布局的大画面信息，只在悬浮布局和屏幕分享布局有效。
McuLayout[]	getMixLayoutList() Get 自定义模板中有效，指定用户视频在混合画面中的位置，最多支持设置16个输入流。
Long	getMixLayoutMode() Get 布局模式：动态布局（1：悬浮布局（默认），2：屏幕分享布局，3：九宫格布局），静态布局（4：自定义布局）。最多支持混入16路音视频流，如果用户只上行音频，也会被算作一路；自定义布局中，如果子画面只设置占位图，也被算作一路。
Long	getPureAudioHoldPlaceMode() Get 纯音频上行是否占布局位置，只在动态布局中有效。0表示纯音频不占布局位置，1表示纯音频占布局位置，不填默认为0。
Long	getRenderMode() Get 屏幕分享模板、悬浮模板、九宫格模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底
void	setMaxVideoUser(MaxVideoUser MaxVideoUser) Set 指定动态布局中悬浮布局和屏幕分享布局的大画面信息，只在悬浮布局和屏幕分享布局有效。
void	setMixLayoutList(McuLayout[] MixLayoutList) Set 自定义模板中有效，指定用户视频在混合画面中的位置，最多支持设置16个输入流。
void	setMixLayoutMode(Long MixLayoutMode) Set 布局模式：动态布局（1：悬浮布局（默认），2：屏幕分享布局，3：九宫格布局），静态布局（4：自定义布局）。最多支持混入16路音视频流，如果用户只上行音频，也会被算作一路；自定义布局中，如果子画面只设置占位图，也被算作一路。
void	setPureAudioHoldPlaceMode(Long PureAudioHoldPlaceMode) Set 纯音频上行是否占布局位置，只在动态布局中有效。0表示纯音频不占布局位置，1表示纯音频占布局位置，不填默认为0。
void	setRenderMode(Long RenderMode) Set 屏幕分享模板、悬浮模板、九宫格模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底
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 布局模式：动态布局（1：悬浮布局（默认），2：屏幕分享布局，3：九宫格布局），静态布局（4：自定义布局）。最多支持混入16路音视频流，如果用户只上行音频，也会被算作一路；自定义布局中，如果子画面只设置占位图，也被算作一路。

Returns:

MixLayoutMode 布局模式：动态布局（1：悬浮布局（默认），2：屏幕分享布局，3：九宫格布局），静态布局（4：自定义布局）。最多支持混入16路音视频流，如果用户只上行音频，也会被算作一路；自定义布局中，如果子画面只设置占位图，也被算作一路。

setMixLayoutMode

public void setMixLayoutMode(Long MixLayoutMode)

Set 布局模式：动态布局（1：悬浮布局（默认），2：屏幕分享布局，3：九宫格布局），静态布局（4：自定义布局）。最多支持混入16路音视频流，如果用户只上行音频，也会被算作一路；自定义布局中，如果子画面只设置占位图，也被算作一路。

Parameters:

MixLayoutMode - 布局模式：动态布局（1：悬浮布局（默认），2：屏幕分享布局，3：九宫格布局），静态布局（4：自定义布局）。最多支持混入16路音视频流，如果用户只上行音频，也会被算作一路；自定义布局中，如果子画面只设置占位图，也被算作一路。

getPureAudioHoldPlaceMode

public Long getPureAudioHoldPlaceMode()

Get 纯音频上行是否占布局位置，只在动态布局中有效。0表示纯音频不占布局位置，1表示纯音频占布局位置，不填默认为0。

Returns:

PureAudioHoldPlaceMode 纯音频上行是否占布局位置，只在动态布局中有效。0表示纯音频不占布局位置，1表示纯音频占布局位置，不填默认为0。

setPureAudioHoldPlaceMode

public void setPureAudioHoldPlaceMode(Long PureAudioHoldPlaceMode)

Set 纯音频上行是否占布局位置，只在动态布局中有效。0表示纯音频不占布局位置，1表示纯音频占布局位置，不填默认为0。

Parameters:

PureAudioHoldPlaceMode - 纯音频上行是否占布局位置，只在动态布局中有效。0表示纯音频不占布局位置，1表示纯音频占布局位置，不填默认为0。

getMixLayoutList

public McuLayout[] getMixLayoutList()

Get 自定义模板中有效，指定用户视频在混合画面中的位置，最多支持设置16个输入流。

Returns:

MixLayoutList 自定义模板中有效，指定用户视频在混合画面中的位置，最多支持设置16个输入流。

setMixLayoutList

public void setMixLayoutList(McuLayout[] MixLayoutList)

Set 自定义模板中有效，指定用户视频在混合画面中的位置，最多支持设置16个输入流。

Parameters:

MixLayoutList - 自定义模板中有效，指定用户视频在混合画面中的位置，最多支持设置16个输入流。

getMaxVideoUser

public MaxVideoUser getMaxVideoUser()

Get 指定动态布局中悬浮布局和屏幕分享布局的大画面信息，只在悬浮布局和屏幕分享布局有效。

Returns:

MaxVideoUser 指定动态布局中悬浮布局和屏幕分享布局的大画面信息，只在悬浮布局和屏幕分享布局有效。

setMaxVideoUser

public void setMaxVideoUser(MaxVideoUser MaxVideoUser)

Set 指定动态布局中悬浮布局和屏幕分享布局的大画面信息，只在悬浮布局和屏幕分享布局有效。

Parameters:

MaxVideoUser - 指定动态布局中悬浮布局和屏幕分享布局的大画面信息，只在悬浮布局和屏幕分享布局有效。

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