com.tencentcloudapi.trtc.v20190722.models

Class PresetLayoutConfig

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

Modifier and Type	Method and Description
Long	getImageHeight() Get Height of the output image in pixels.
Long	getImageWidth() Get Width of the output image in pixels.
Long	getLocationX() Get X offset of the output image in pixels.
Long	getLocationY() Get Y offset of the output image in pixels.
Long	getMixInputType() Get Media type of the mixed stream of the user occupying the current position.
Long	getPlaceImageId() Get ID of the placeholder image.
Long	getRenderMode() Get Render mode of the output image.
Long	getStreamType() Get Stream type of the user when a specified user is assigned to the image.
String	getUserId() Get Used to assign users to preset positions; if not assigned, users will occupy the positions set in `PresetLayoutConfig` in room entry sequence.
Long	getZOrder() Get Output order of the image.
void	setImageHeight(Long ImageHeight) Set Height of the output image in pixels.
void	setImageWidth(Long ImageWidth) Set Width of the output image in pixels.
void	setLocationX(Long LocationX) Set X offset of the output image in pixels.
void	setLocationY(Long LocationY) Set Y offset of the output image in pixels.
void	setMixInputType(Long MixInputType) Set Media type of the mixed stream of the user occupying the current position.
void	setPlaceImageId(Long PlaceImageId) Set ID of the placeholder image.
void	setRenderMode(Long RenderMode) Set Render mode of the output image.
void	setStreamType(Long StreamType) Set Stream type of the user when a specified user is assigned to the image.
void	setUserId(String UserId) Set Used to assign users to preset positions; if not assigned, users will occupy the positions set in `PresetLayoutConfig` in room entry sequence.
void	setZOrder(Long ZOrder) Set Output order of the image.
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 Used to assign users to preset positions; if not assigned, users will occupy the positions set in `PresetLayoutConfig` in room entry sequence.

Returns:

UserId Used to assign users to preset positions; if not assigned, users will occupy the positions set in `PresetLayoutConfig` in room entry sequence.

setUserId

public void setUserId(String UserId)

Set Used to assign users to preset positions; if not assigned, users will occupy the positions set in `PresetLayoutConfig` in room entry sequence.

Parameters:

UserId - Used to assign users to preset positions; if not assigned, users will occupy the positions set in `PresetLayoutConfig` in room entry sequence.

getStreamType

public Long getStreamType()

Get Stream type of the user when a specified user is assigned to the image. 0: camera; 1: screen sharing. Set this parameter to 0 when the small image is occupied by a web user.

Returns:

StreamType Stream type of the user when a specified user is assigned to the image. 0: camera; 1: screen sharing. Set this parameter to 0 when the small image is occupied by a web user.

setStreamType

public void setStreamType(Long StreamType)

Set Stream type of the user when a specified user is assigned to the image. 0: camera; 1: screen sharing. Set this parameter to 0 when the small image is occupied by a web user.

Parameters:

StreamType - Stream type of the user when a specified user is assigned to the image. 0: camera; 1: screen sharing. Set this parameter to 0 when the small image is occupied by a web user.

getImageWidth

public Long getImageWidth()

Get Width of the output image in pixels. If this parameter is not set, 0 is used by default.

Returns:

ImageWidth Width of the output image in pixels. If this parameter is not set, 0 is used by default.

setImageWidth

public void setImageWidth(Long ImageWidth)

Set Width of the output image in pixels. If this parameter is not set, 0 is used by default.

Parameters:

ImageWidth - Width of the output image in pixels. If this parameter is not set, 0 is used by default.

getImageHeight

public Long getImageHeight()

Get Height of the output image in pixels. If this parameter is not set, 0 is used by default.

Returns:

ImageHeight Height of the output image in pixels. If this parameter is not set, 0 is used by default.

setImageHeight

public void setImageHeight(Long ImageHeight)

Set Height of the output image in pixels. If this parameter is not set, 0 is used by default.

Parameters:

ImageHeight - Height of the output image in pixels. If this parameter is not set, 0 is used by default.

getLocationX

public Long getLocationX()

Get X offset of the output image in pixels. The sum of `LocationX` and `ImageWidth` cannot exceed the total width of the mixed stream. If this parameter is not set, 0 is used by default.

Returns:

LocationX X offset of the output image in pixels. The sum of `LocationX` and `ImageWidth` cannot exceed the total width of the mixed stream. If this parameter is not set, 0 is used by default.

setLocationX

public void setLocationX(Long LocationX)

Set X offset of the output image in pixels. The sum of `LocationX` and `ImageWidth` cannot exceed the total width of the mixed stream. If this parameter is not set, 0 is used by default.

Parameters:

LocationX - X offset of the output image in pixels. The sum of `LocationX` and `ImageWidth` cannot exceed the total width of the mixed stream. If this parameter is not set, 0 is used by default.

getLocationY

public Long getLocationY()

Get Y offset of the output image in pixels. The sum of `LocationY` and `ImageHeight` cannot exceed the total height of the mixed stream. If this parameter is not set, 0 is used by default.

Returns:

LocationY Y offset of the output image in pixels. The sum of `LocationY` and `ImageHeight` cannot exceed the total height of the mixed stream. If this parameter is not set, 0 is used by default.

setLocationY

public void setLocationY(Long LocationY)

Set Y offset of the output image in pixels. The sum of `LocationY` and `ImageHeight` cannot exceed the total height of the mixed stream. If this parameter is not set, 0 is used by default.

Parameters:

LocationY - Y offset of the output image in pixels. The sum of `LocationY` and `ImageHeight` cannot exceed the total height of the mixed stream. If this parameter is not set, 0 is used by default.

getZOrder

public Long getZOrder()

Get Output order of the image. `0` is used if it is left empty.

Returns:

ZOrder Output order of the image. `0` is used if it is left empty.

setZOrder

public void setZOrder(Long ZOrder)

Set Output order of the image. `0` is used if it is left empty.

Parameters:

ZOrder - Output order of the image. `0` is used if it is left empty.

getRenderMode

public Long getRenderMode()

Get Render mode of the output image. 0: cropping; 1: scaling; 2: scaling on a black background. If this parameter is not set, 0 is used by default.

Returns:

RenderMode Render mode of the output image. 0: cropping; 1: scaling; 2: scaling on a black background. If this parameter is not set, 0 is used by default.

setRenderMode

public void setRenderMode(Long RenderMode)

Set Render mode of the output image. 0: cropping; 1: scaling; 2: scaling on a black background. If this parameter is not set, 0 is used by default.

Parameters:

RenderMode - Render mode of the output image. 0: cropping; 1: scaling; 2: scaling on a black background. If this parameter is not set, 0 is used by default.

getMixInputType

public Long getMixInputType()

Get Media type of the mixed stream of the user occupying the current position. 0 (default): audio and video; 1: audio; 2: video. You are advised to specify a user ID when using this parameter.

Returns:

MixInputType Media type of the mixed stream of the user occupying the current position. 0 (default): audio and video; 1: audio; 2: video. You are advised to specify a user ID when using this parameter.

setMixInputType

public void setMixInputType(Long MixInputType)

Set Media type of the mixed stream of the user occupying the current position. 0 (default): audio and video; 1: audio; 2: video. You are advised to specify a user ID when using this parameter.

Parameters:

MixInputType - Media type of the mixed stream of the user occupying the current position. 0 (default): audio and video; 1: audio; 2: video. You are advised to specify a user ID when using this parameter.

getPlaceImageId

public Long getPlaceImageId()

Get ID of the placeholder image. If the placeholding feature is enabled, and a user for whom an image position is reserved is not sending video data, the position will show the placeholder image. The ID is generated after the placeholder image is uploaded in the TRTC console. https://intl.cloud.tencent.com/document/product/647/50769?from_cn_redirect=1

Returns:

PlaceImageId ID of the placeholder image. If the placeholding feature is enabled, and a user for whom an image position is reserved is not sending video data, the position will show the placeholder image. The ID is generated after the placeholder image is uploaded in the TRTC console. https://intl.cloud.tencent.com/document/product/647/50769?from_cn_redirect=1

setPlaceImageId

public void setPlaceImageId(Long PlaceImageId)

Set ID of the placeholder image. If the placeholding feature is enabled, and a user for whom an image position is reserved is not sending video data, the position will show the placeholder image. The ID is generated after the placeholder image is uploaded in the TRTC console. https://intl.cloud.tencent.com/document/product/647/50769?from_cn_redirect=1

Parameters:

PlaceImageId - ID of the placeholder image. If the placeholding feature is enabled, and a user for whom an image position is reserved is not sending video data, the position will show the placeholder image. The ID is generated after the placeholder image is uploaded in the TRTC console. https://intl.cloud.tencent.com/document/product/647/50769?from_cn_redirect=1

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel