com.tencentcloudapi.trtc.v20190722.models

Class McuVideoParams

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.trtc.v20190722.models.McuVideoParams

public class McuVideoParams
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
McuVideoParams()
McuVideoParams(McuVideoParams 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
String	getBackGroundColor() Get The canvas color.
String	getBackgroundImageUrl() Get The URL of the background image for the canvas.
Long	getBackgroundRenderMode() Get Background image display mode during output: 0 for crop, 1 for scale and display with black background, 2 for proportional scaling.
McuLayoutParams	getLayoutParams() Get The layout parameters.
VideoEncode	getVideoEncode() Get The video encoding parameters.
McuWaterMarkParams[]	getWaterMarkList() Get The watermark information for the mixed stream.
void	setBackGroundColor(String BackGroundColor) Set The canvas color.
void	setBackgroundImageUrl(String BackgroundImageUrl) Set The URL of the background image for the canvas.
void	setBackgroundRenderMode(Long BackgroundRenderMode) Set Background image display mode during output: 0 for crop, 1 for scale and display with black background, 2 for proportional scaling.
void	setLayoutParams(McuLayoutParams LayoutParams) Set The layout parameters.
void	setVideoEncode(VideoEncode VideoEncode) Set The video encoding parameters.
void	setWaterMarkList(McuWaterMarkParams[] WaterMarkList) Set The watermark information for the mixed stream.
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, 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

McuVideoParams

public McuVideoParams()

McuVideoParams

public McuVideoParams(McuVideoParams 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

getVideoEncode

public VideoEncode getVideoEncode()

Get The video encoding parameters.

Returns:

VideoEncode The video encoding parameters.

setVideoEncode

public void setVideoEncode(VideoEncode VideoEncode)

Set The video encoding parameters.

Parameters:

VideoEncode - The video encoding parameters.

getLayoutParams

public McuLayoutParams getLayoutParams()

Get The layout parameters.

Returns:

LayoutParams The layout parameters.

setLayoutParams

public void setLayoutParams(McuLayoutParams LayoutParams)

Set The layout parameters.

Parameters:

LayoutParams - The layout parameters.

getBackGroundColor

public String getBackGroundColor()

Get The canvas color. Below are the values for some common colors: Red: 0xcc0033 Yellow: 0xcc9900 Green: 0xcccc33 Blue: 0x99CCFF Black: 0x000000 White: 0xFFFFFF Grey: 0x999999

Returns:

BackGroundColor The canvas color. Below are the values for some common colors: Red: 0xcc0033 Yellow: 0xcc9900 Green: 0xcccc33 Blue: 0x99CCFF Black: 0x000000 White: 0xFFFFFF Grey: 0x999999

setBackGroundColor

public void setBackGroundColor(String BackGroundColor)

Set The canvas color. Below are the values for some common colors: Red: 0xcc0033 Yellow: 0xcc9900 Green: 0xcccc33 Blue: 0x99CCFF Black: 0x000000 White: 0xFFFFFF Grey: 0x999999

Parameters:

BackGroundColor - The canvas color. Below are the values for some common colors: Red: 0xcc0033 Yellow: 0xcc9900 Green: 0xcccc33 Blue: 0x99CCFF Black: 0x000000 White: 0xFFFFFF Grey: 0x999999

getBackgroundImageUrl

public String getBackgroundImageUrl()

Get The URL of the background image for the canvas. This parameter has a higher priority than `BackGroundColor`.

Returns:

BackgroundImageUrl The URL of the background image for the canvas. This parameter has a higher priority than `BackGroundColor`.

setBackgroundImageUrl

public void setBackgroundImageUrl(String BackgroundImageUrl)

Set The URL of the background image for the canvas. This parameter has a higher priority than `BackGroundColor`.

Parameters:

BackgroundImageUrl - The URL of the background image for the canvas. This parameter has a higher priority than `BackGroundColor`.

getWaterMarkList

public McuWaterMarkParams[] getWaterMarkList()

Get The watermark information for the mixed stream.

Returns:

WaterMarkList The watermark information for the mixed stream.

setWaterMarkList

public void setWaterMarkList(McuWaterMarkParams[] WaterMarkList)

Set The watermark information for the mixed stream.

Parameters:

WaterMarkList - The watermark information for the mixed stream.

getBackgroundRenderMode

public Long getBackgroundRenderMode()

Get Background image display mode during output: 0 for crop, 1 for scale and display with black background, 2 for proportional scaling. The backend default is proportional scaling.

Returns:

BackgroundRenderMode Background image display mode during output: 0 for crop, 1 for scale and display with black background, 2 for proportional scaling. The backend default is proportional scaling.

setBackgroundRenderMode

public void setBackgroundRenderMode(Long BackgroundRenderMode)

Set Background image display mode during output: 0 for crop, 1 for scale and display with black background, 2 for proportional scaling. The backend default is proportional scaling.

Parameters:

BackgroundRenderMode - Background image display mode during output: 0 for crop, 1 for scale and display with black background, 2 for proportional scaling. The backend default is proportional scaling.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel