com.tencentcloudapi.live.v20180801.models

Class CreateScreenshotTaskRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.live.v20180801.models.CreateScreenshotTaskRequest

public class CreateScreenshotTaskRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateScreenshotTaskRequest()
CreateScreenshotTaskRequest(CreateScreenshotTaskRequest 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 The push path.
String	getDomainName() Get The push domain.
Long	getEndTime() Get The task end time, which must be a Unix timestamp and later than `StartTime` and the current time.
String	getExtension() Get An extension field, which is not defined currently and is empty by default.
Long	getStartTime() Get The task start time, which must be a Unix timestamp and cannot be later than six days from the current time.
String	getStreamName() Get The stream name.
Long	getStreamType() Get The publishing type.
Long	getTemplateId() Get The ID of the screencapturing template, which is returned by `CreateLiveSnapshotTemplate`.
void	setAppName(String AppName) Set The push path.
void	setDomainName(String DomainName) Set The push domain.
void	setEndTime(Long EndTime) Set The task end time, which must be a Unix timestamp and later than `StartTime` and the current time.
void	setExtension(String Extension) Set An extension field, which is not defined currently and is empty by default.
void	setStartTime(Long StartTime) Set The task start time, which must be a Unix timestamp and cannot be later than six days from the current time.
void	setStreamName(String StreamName) Set The stream name.
void	setStreamType(Long StreamType) Set The publishing type.
void	setTemplateId(Long TemplateId) Set The ID of the screencapturing template, which is returned by `CreateLiveSnapshotTemplate`.
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

CreateScreenshotTaskRequest

public CreateScreenshotTaskRequest()

CreateScreenshotTaskRequest

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

getStreamName

public String getStreamName()

Get The stream name.

Returns:

StreamName The stream name.

setStreamName

public void setStreamName(String StreamName)

Set The stream name.

Parameters:

StreamName - The stream name.

getDomainName

public String getDomainName()

Get The push domain.

Returns:

DomainName The push domain.

setDomainName

public void setDomainName(String DomainName)

Set The push domain.

Parameters:

DomainName - The push domain.

getAppName

public String getAppName()

Get The push path.

Returns:

AppName The push path.

setAppName

public void setAppName(String AppName)

Set The push path.

Parameters:

AppName - The push path.

getEndTime

public Long getEndTime()

Get The task end time, which must be a Unix timestamp and later than `StartTime` and the current time. The end time and start time cannot be more than 24 hours apart.

Returns:

EndTime The task end time, which must be a Unix timestamp and later than `StartTime` and the current time. The end time and start time cannot be more than 24 hours apart.

setEndTime

public void setEndTime(Long EndTime)

Set The task end time, which must be a Unix timestamp and later than `StartTime` and the current time. The end time and start time cannot be more than 24 hours apart.

Parameters:

EndTime - The task end time, which must be a Unix timestamp and later than `StartTime` and the current time. The end time and start time cannot be more than 24 hours apart.

getTemplateId

public Long getTemplateId()

Get The ID of the screencapturing template, which is returned by `CreateLiveSnapshotTemplate`. If an incorrect template ID is passed in, the screencapturing task will fail.

Returns:

TemplateId The ID of the screencapturing template, which is returned by `CreateLiveSnapshotTemplate`. If an incorrect template ID is passed in, the screencapturing task will fail.

setTemplateId

public void setTemplateId(Long TemplateId)

Set The ID of the screencapturing template, which is returned by `CreateLiveSnapshotTemplate`. If an incorrect template ID is passed in, the screencapturing task will fail.

Parameters:

TemplateId - The ID of the screencapturing template, which is returned by `CreateLiveSnapshotTemplate`. If an incorrect template ID is passed in, the screencapturing task will fail.

getStartTime

public Long getStartTime()

Get The task start time, which must be a Unix timestamp and cannot be later than six days from the current time. If you do not specify this parameter, the task will start immediately.

Returns:

StartTime The task start time, which must be a Unix timestamp and cannot be later than six days from the current time. If you do not specify this parameter, the task will start immediately.

setStartTime

public void setStartTime(Long StartTime)

Set The task start time, which must be a Unix timestamp and cannot be later than six days from the current time. If you do not specify this parameter, the task will start immediately.

Parameters:

StartTime - The task start time, which must be a Unix timestamp and cannot be later than six days from the current time. If you do not specify this parameter, the task will start immediately.

getStreamType

public Long getStreamType()

Get The publishing type. Valid values: `0` (default): Live stream `1`: Mixed stream

Returns:

StreamType The publishing type. Valid values: `0` (default): Live stream `1`: Mixed stream

setStreamType

public void setStreamType(Long StreamType)

Set The publishing type. Valid values: `0` (default): Live stream `1`: Mixed stream

Parameters:

StreamType - The publishing type. Valid values: `0` (default): Live stream `1`: Mixed stream

getExtension

public String getExtension()

Get An extension field, which is not defined currently and is empty by default.

Returns:

Extension An extension field, which is not defined currently and is empty by default.

setExtension

public void setExtension(String Extension)

Set An extension field, which is not defined currently and is empty by default.

Parameters:

Extension - An extension field, which is not defined currently and is empty by default.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel