com.tencentcloudapi.live.v20180801.models

Class CreateLiveSnapshotTemplateRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.live.v20180801.models.CreateLiveSnapshotTemplateRequest

public class CreateLiveSnapshotTemplateRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateLiveSnapshotTemplateRequest()
CreateLiveSnapshotTemplateRequest(CreateLiveSnapshotTemplateRequest 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	getCosAppId() Get COS application ID.
String	getCosBucket() Get COS bucket name.
String	getCosFileName() Get COS filename.
String	getCosPrefix() Get COS Bucket folder prefix.
String	getCosRegion() Get COS region.
String	getDescription() Get Description.
Long	getHeight() Get Screenshot height.
Long	getPornFlag() Get Whether to enable porn detection.
Long	getSnapshotInterval() Get Screencapturing interval (s).
String	getTemplateName() Get Template name.
Long	getWidth() Get Screenshot width.
void	setCosAppId(Long CosAppId) Set COS application ID.
void	setCosBucket(String CosBucket) Set COS bucket name.
void	setCosFileName(String CosFileName) Set COS filename.
void	setCosPrefix(String CosPrefix) Set COS Bucket folder prefix.
void	setCosRegion(String CosRegion) Set COS region.
void	setDescription(String Description) Set Description.
void	setHeight(Long Height) Set Screenshot height.
void	setPornFlag(Long PornFlag) Set Whether to enable porn detection.
void	setSnapshotInterval(Long SnapshotInterval) Set Screencapturing interval (s).
void	setTemplateName(String TemplateName) Set Template name.
void	setWidth(Long Width) Set Screenshot width.
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

CreateLiveSnapshotTemplateRequest

public CreateLiveSnapshotTemplateRequest()

CreateLiveSnapshotTemplateRequest

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

getTemplateName

public String getTemplateName()

Get Template name. Maximum length: 255 bytes. Only letters, digits, underscores, and hyphens can be contained.

Returns:

TemplateName Template name. Maximum length: 255 bytes. Only letters, digits, underscores, and hyphens can be contained.

setTemplateName

public void setTemplateName(String TemplateName)

Set Template name. Maximum length: 255 bytes. Only letters, digits, underscores, and hyphens can be contained.

Parameters:

TemplateName - Template name. Maximum length: 255 bytes. Only letters, digits, underscores, and hyphens can be contained.

getCosAppId

public Long getCosAppId()

Get COS application ID.

Returns:

CosAppId COS application ID.

setCosAppId

public void setCosAppId(Long CosAppId)

Set COS application ID.

Parameters:

CosAppId - COS application ID.

getCosBucket

public String getCosBucket()

Get COS bucket name. Note: the value of `CosBucket` cannot contain `-[appid]`.

Returns:

CosBucket COS bucket name. Note: the value of `CosBucket` cannot contain `-[appid]`.

setCosBucket

public void setCosBucket(String CosBucket)

Set COS bucket name. Note: the value of `CosBucket` cannot contain `-[appid]`.

Parameters:

CosBucket - COS bucket name. Note: the value of `CosBucket` cannot contain `-[appid]`.

getCosRegion

public String getCosRegion()

Get COS region.

Returns:

CosRegion COS region.

setCosRegion

public void setCosRegion(String CosRegion)

Set COS region.

Parameters:

CosRegion - COS region.

getDescription

public String getDescription()

Get Description. Maximum length: 1,024 bytes. Only letters, digits, underscores, and hyphens can be contained.

Returns:

Description Description. Maximum length: 1,024 bytes. Only letters, digits, underscores, and hyphens can be contained.

setDescription

public void setDescription(String Description)

Set Description. Maximum length: 1,024 bytes. Only letters, digits, underscores, and hyphens can be contained.

Parameters:

Description - Description. Maximum length: 1,024 bytes. Only letters, digits, underscores, and hyphens can be contained.

getSnapshotInterval

public Long getSnapshotInterval()

Get Screencapturing interval (s). Default value: 10 Value range: 2-300

Returns:

SnapshotInterval Screencapturing interval (s). Default value: 10 Value range: 2-300

setSnapshotInterval

public void setSnapshotInterval(Long SnapshotInterval)

Set Screencapturing interval (s). Default value: 10 Value range: 2-300

Parameters:

SnapshotInterval - Screencapturing interval (s). Default value: 10 Value range: 2-300

getWidth

public Long getWidth()

Get Screenshot width. Default value: `0` (original width) Value range: 0-3000

Returns:

Width Screenshot width. Default value: `0` (original width) Value range: 0-3000

setWidth

public void setWidth(Long Width)

Set Screenshot width. Default value: `0` (original width) Value range: 0-3000

Parameters:

Width - Screenshot width. Default value: `0` (original width) Value range: 0-3000

getHeight

public Long getHeight()

Get Screenshot height. Default value: `0` (original height) Value range: 0-2000

Returns:

Height Screenshot height. Default value: `0` (original height) Value range: 0-2000

setHeight

public void setHeight(Long Height)

Set Screenshot height. Default value: `0` (original height) Value range: 0-2000

Parameters:

Height - Screenshot height. Default value: `0` (original height) Value range: 0-2000

getPornFlag

public Long getPornFlag()

Get Whether to enable porn detection. 0: no, 1: yes. Default value: 0

Returns:

PornFlag Whether to enable porn detection. 0: no, 1: yes. Default value: 0

setPornFlag

public void setPornFlag(Long PornFlag)

Set Whether to enable porn detection. 0: no, 1: yes. Default value: 0

Parameters:

PornFlag - Whether to enable porn detection. 0: no, 1: yes. Default value: 0

getCosPrefix

public String getCosPrefix()

Get COS Bucket folder prefix. If no value is entered, the default value `/{Year}-{Month}-{Day}` will be used.

Returns:

CosPrefix COS Bucket folder prefix. If no value is entered, the default value `/{Year}-{Month}-{Day}` will be used.

setCosPrefix

public void setCosPrefix(String CosPrefix)

Set COS Bucket folder prefix. If no value is entered, the default value `/{Year}-{Month}-{Day}` will be used.

Parameters:

CosPrefix - COS Bucket folder prefix. If no value is entered, the default value `/{Year}-{Month}-{Day}` will be used.

getCosFileName

public String getCosFileName()

Get COS filename. If no value is entered, the default value `{StreamID}-screenshot-{Hour}-{Minute}-{Second}-{Width}x{Height}{Ext}` will be used.

Returns:

CosFileName COS filename. If no value is entered, the default value `{StreamID}-screenshot-{Hour}-{Minute}-{Second}-{Width}x{Height}{Ext}` will be used.

setCosFileName

public void setCosFileName(String CosFileName)

Set COS filename. If no value is entered, the default value `{StreamID}-screenshot-{Hour}-{Minute}-{Second}-{Width}x{Height}{Ext}` will be used.

Parameters:

CosFileName - COS filename. If no value is entered, the default value `{StreamID}-screenshot-{Hour}-{Minute}-{Second}-{Width}x{Height}{Ext}` will be used.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel