com.tencentcloudapi.trtc.v20190722.models

Class LayoutParams

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()

Method Summary

Modifier and Type	Method and Description
Long	getMainVideoRightAlign() Get You can set the layout parameter as 1 or 0 in the screen sharing template.
Long	getMainVideoStreamType() Get Stream type of the big image, which takes effect in a screen sharing, floating, or picture-in-picture template.
String	getMainVideoUserId() Get ID of the user in the big image, which takes effect in a screen sharing, floating, or picture-in-picture template.
SmallVideoLayoutParams	getSmallVideoLayoutParams() Get Layout parameter of the small image, which takes effect in a picture-in-picture template.
Long	getTemplate() Get On-cloud stream mix layout template ID.
void	setMainVideoRightAlign(Long MainVideoRightAlign) Set You can set the layout parameter as 1 or 0 in the screen sharing template.
void	setMainVideoStreamType(Long MainVideoStreamType) Set Stream type of the big image, which takes effect in a screen sharing, floating, or picture-in-picture template.
void	setMainVideoUserId(String MainVideoUserId) Set ID of the user in the big image, which takes effect in a screen sharing, floating, or picture-in-picture template.
void	setSmallVideoLayoutParams(SmallVideoLayoutParams SmallVideoLayoutParams) Set Layout parameter of the small image, which takes effect in a picture-in-picture template.
void	setTemplate(Long Template) Set On-cloud stream mix layout template ID.
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()

Method Detail

getTemplate

public Long getTemplate()

Get On-cloud stream mix layout template ID. 0: floating template (default value); 1: grid template; 2: screen sharing template; 3: picture-in-picture template.

Returns:

Template On-cloud stream mix layout template ID. 0: floating template (default value); 1: grid template; 2: screen sharing template; 3: picture-in-picture template.

setTemplate

public void setTemplate(Long Template)

Set On-cloud stream mix layout template ID. 0: floating template (default value); 1: grid template; 2: screen sharing template; 3: picture-in-picture template.

Parameters:

Template - On-cloud stream mix layout template ID. 0: floating template (default value); 1: grid template; 2: screen sharing template; 3: picture-in-picture template.

getMainVideoUserId

public String getMainVideoUserId()

Get ID of the user in the big image, which takes effect in a screen sharing, floating, or picture-in-picture template.

Returns:

MainVideoUserId ID of the user in the big image, which takes effect in a screen sharing, floating, or picture-in-picture template.

setMainVideoUserId

public void setMainVideoUserId(String MainVideoUserId)

Set ID of the user in the big image, which takes effect in a screen sharing, floating, or picture-in-picture template.

Parameters:

MainVideoUserId - ID of the user in the big image, which takes effect in a screen sharing, floating, or picture-in-picture template.

getMainVideoStreamType

public Long getMainVideoStreamType()

Get Stream type of the big image, which takes effect in a screen sharing, floating, or picture-in-picture template. 0: camera; 1: screen sharing. If a web user's stream is displayed in the big image on the left, enter 0 for this parameter.

Returns:

MainVideoStreamType Stream type of the big image, which takes effect in a screen sharing, floating, or picture-in-picture template. 0: camera; 1: screen sharing. If a web user's stream is displayed in the big image on the left, enter 0 for this parameter.

setMainVideoStreamType

public void setMainVideoStreamType(Long MainVideoStreamType)

Set Stream type of the big image, which takes effect in a screen sharing, floating, or picture-in-picture template. 0: camera; 1: screen sharing. If a web user's stream is displayed in the big image on the left, enter 0 for this parameter.

Parameters:

MainVideoStreamType - Stream type of the big image, which takes effect in a screen sharing, floating, or picture-in-picture template. 0: camera; 1: screen sharing. If a web user's stream is displayed in the big image on the left, enter 0 for this parameter.

getSmallVideoLayoutParams

public SmallVideoLayoutParams getSmallVideoLayoutParams()

Get Layout parameter of the small image, which takes effect in a picture-in-picture template.

Returns:

SmallVideoLayoutParams Layout parameter of the small image, which takes effect in a picture-in-picture template.

setSmallVideoLayoutParams

public void setSmallVideoLayoutParams(SmallVideoLayoutParams SmallVideoLayoutParams)

Set Layout parameter of the small image, which takes effect in a picture-in-picture template.

Parameters:

SmallVideoLayoutParams - Layout parameter of the small image, which takes effect in a picture-in-picture template.

getMainVideoRightAlign

public Long getMainVideoRightAlign()

Get You can set the layout parameter as 1 or 0 in the screen sharing template. 1: big image on the right and small images on the left, 0: big image on the left and small images on the right. The default value is 0.

Returns:

MainVideoRightAlign You can set the layout parameter as 1 or 0 in the screen sharing template. 1: big image on the right and small images on the left, 0: big image on the left and small images on the right. The default value is 0.

setMainVideoRightAlign

public void setMainVideoRightAlign(Long MainVideoRightAlign)

Set You can set the layout parameter as 1 or 0 in the screen sharing template. 1: big image on the right and small images on the left, 0: big image on the left and small images on the right. The default value is 0.

Parameters:

MainVideoRightAlign - You can set the layout parameter as 1 or 0 in the screen sharing template. 1: big image on the right and small images on the left, 0: big image on the left and small images on the right. The default value is 0.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel