com.tencentcloudapi.live.v20180801.models

Class SendLiveCloudEffectRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.live.v20180801.models.SendLiveCloudEffectRequest

public class SendLiveCloudEffectRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
SendLiveCloudEffectRequest()
SendLiveCloudEffectRequest(SendLiveCloudEffectRequest 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	getAppName() Get 推流路径，与推流和播放地址中的AppName保持一致，默认为 live。
String	getId() Get 云端特效 ID。
Long	getLoopTimes() Get 默认随系统配置，云端特效循环 少于5次。可自定义指定礼物循环次数，不超过100次。
String	getOperator() Get 操作人备注信息。
String	getPushDomainName() Get 您的推流域名。
String	getStreamName() Get 流名称。
String	getXPosition() Get 指定云端特效渲染位置百分比。默认居中显示。 原点为画面左上角，该参数指定特效渲染离原点的横向比例，可选值 0 - 100。
String	getYPosition() Get 指定云端特效渲染位置百分比。默认居中显示。 原点为画面左上角，该参数指定特效渲染离原点的纵向比例，可选值 0 - 100。
Long	getZoomFactor() Get 缩小比例，默认0 不缩放。 可选值：0-9， 值越大，越缩小。
void	setAppName(String AppName) Set 推流路径，与推流和播放地址中的AppName保持一致，默认为 live。
void	setId(String Id) Set 云端特效 ID。
void	setLoopTimes(Long LoopTimes) Set 默认随系统配置，云端特效循环 少于5次。可自定义指定礼物循环次数，不超过100次。
void	setOperator(String Operator) Set 操作人备注信息。
void	setPushDomainName(String PushDomainName) Set 您的推流域名。
void	setStreamName(String StreamName) Set 流名称。
void	setXPosition(String XPosition) Set 指定云端特效渲染位置百分比。默认居中显示。 原点为画面左上角，该参数指定特效渲染离原点的横向比例，可选值 0 - 100。
void	setYPosition(String YPosition) Set 指定云端特效渲染位置百分比。默认居中显示。 原点为画面左上角，该参数指定特效渲染离原点的纵向比例，可选值 0 - 100。
void	setZoomFactor(Long ZoomFactor) Set 缩小比例，默认0 不缩放。 可选值：0-9， 值越大，越缩小。
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

SendLiveCloudEffectRequest

public SendLiveCloudEffectRequest()

SendLiveCloudEffectRequest

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

getAppName

public String getAppName()

Get 推流路径，与推流和播放地址中的AppName保持一致，默认为 live。

Returns:

AppName 推流路径，与推流和播放地址中的AppName保持一致，默认为 live。

setAppName

public void setAppName(String AppName)

Set 推流路径，与推流和播放地址中的AppName保持一致，默认为 live。

Parameters:

AppName - 推流路径，与推流和播放地址中的AppName保持一致，默认为 live。

getPushDomainName

public String getPushDomainName()

Get 您的推流域名。

Returns:

PushDomainName 您的推流域名。

setPushDomainName

public void setPushDomainName(String PushDomainName)

Set 您的推流域名。

Parameters:

PushDomainName - 您的推流域名。

getStreamName

public String getStreamName()

Get 流名称。

Returns:

StreamName 流名称。

setStreamName

public void setStreamName(String StreamName)

Set 流名称。

Parameters:

StreamName - 流名称。

getId

public String getId()

Get 云端特效 ID。

Returns:

Id 云端特效 ID。

setId

public void setId(String Id)

Set 云端特效 ID。

Parameters:

Id - 云端特效 ID。

getLoopTimes

public Long getLoopTimes()

Get 默认随系统配置，云端特效循环 少于5次。可自定义指定礼物循环次数，不超过100次。

Returns:

LoopTimes 默认随系统配置，云端特效循环 少于5次。可自定义指定礼物循环次数，不超过100次。

setLoopTimes

public void setLoopTimes(Long LoopTimes)

Set 默认随系统配置，云端特效循环 少于5次。可自定义指定礼物循环次数，不超过100次。

Parameters:

LoopTimes - 默认随系统配置，云端特效循环 少于5次。可自定义指定礼物循环次数，不超过100次。

getOperator

public String getOperator()

Get 操作人备注信息。

Returns:

Operator 操作人备注信息。

setOperator

public void setOperator(String Operator)

Set 操作人备注信息。

Parameters:

Operator - 操作人备注信息。

getZoomFactor

public Long getZoomFactor()

Get 缩小比例，默认0 不缩放。 可选值：0-9， 值越大，越缩小。

Returns:

ZoomFactor 缩小比例，默认0 不缩放。 可选值：0-9， 值越大，越缩小。

setZoomFactor

public void setZoomFactor(Long ZoomFactor)

Set 缩小比例，默认0 不缩放。 可选值：0-9， 值越大，越缩小。

Parameters:

ZoomFactor - 缩小比例，默认0 不缩放。 可选值：0-9， 值越大，越缩小。

getXPosition

public String getXPosition()

Get 指定云端特效渲染位置百分比。默认居中显示。 原点为画面左上角，该参数指定特效渲染离原点的横向比例，可选值 0 - 100。

Returns:

XPosition 指定云端特效渲染位置百分比。默认居中显示。 原点为画面左上角，该参数指定特效渲染离原点的横向比例，可选值 0 - 100。

setXPosition

public void setXPosition(String XPosition)

Set 指定云端特效渲染位置百分比。默认居中显示。 原点为画面左上角，该参数指定特效渲染离原点的横向比例，可选值 0 - 100。

Parameters:

XPosition - 指定云端特效渲染位置百分比。默认居中显示。 原点为画面左上角，该参数指定特效渲染离原点的横向比例，可选值 0 - 100。

getYPosition

public String getYPosition()

Get 指定云端特效渲染位置百分比。默认居中显示。 原点为画面左上角，该参数指定特效渲染离原点的纵向比例，可选值 0 - 100。

Returns:

YPosition 指定云端特效渲染位置百分比。默认居中显示。 原点为画面左上角，该参数指定特效渲染离原点的纵向比例，可选值 0 - 100。

setYPosition

public void setYPosition(String YPosition)

Set 指定云端特效渲染位置百分比。默认居中显示。 原点为画面左上角，该参数指定特效渲染离原点的纵向比例，可选值 0 - 100。

Parameters:

YPosition - 指定云端特效渲染位置百分比。默认居中显示。 原点为画面左上角，该参数指定特效渲染离原点的纵向比例，可选值 0 - 100。

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.