com.tencentcloudapi.mps.v20190612.models

Class MediaSampleSnapshotItem

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.mps.v20190612.models.MediaSampleSnapshotItem

public class MediaSampleSnapshotItem
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
MediaSampleSnapshotItem()
MediaSampleSnapshotItem(MediaSampleSnapshotItem 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	getDefinition() Get Sampled screenshot specification ID.
String[]	getImagePathSet() Get List of paths to generated screenshots.
Long	getInterval() Get Sampling interval If `SampleType` is `Percent`, this value means taking a screenshot at an interval of the specified percentage. If `SampleType` is `Time`, this value means taking a screenshot at an interval of the specified time (in seconds).
String	getSampleType() Get Sample type.
TaskOutputStorage	getStorage() Get Storage location of a generated screenshot file.
Long[]	getWaterMarkDefinition() Get List of watermarking template IDs if the screenshots are watermarked.
void	setDefinition(Long Definition) Set Sampled screenshot specification ID.
void	setImagePathSet(String[] ImagePathSet) Set List of paths to generated screenshots.
void	setInterval(Long Interval) Set Sampling interval If `SampleType` is `Percent`, this value means taking a screenshot at an interval of the specified percentage. If `SampleType` is `Time`, this value means taking a screenshot at an interval of the specified time (in seconds).
void	setSampleType(String SampleType) Set Sample type.
void	setStorage(TaskOutputStorage Storage) Set Storage location of a generated screenshot file.
void	setWaterMarkDefinition(Long[] WaterMarkDefinition) Set List of watermarking template IDs if the screenshots are watermarked.
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

MediaSampleSnapshotItem

public MediaSampleSnapshotItem()

MediaSampleSnapshotItem

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

getDefinition

public Long getDefinition()

Get Sampled screenshot specification ID. For more information, please see [Sampled Screenshot Parameter Template](https://intl.cloud.tencent.com/document/product/266/33480?from_cn_redirect=1#.E9.87.87.E6.A0.B7.E6.88.AA.E5.9B.BE.E6.A8.A1.E6.9D.BF).

Returns:

Definition Sampled screenshot specification ID. For more information, please see [Sampled Screenshot Parameter Template](https://intl.cloud.tencent.com/document/product/266/33480?from_cn_redirect=1#.E9.87.87.E6.A0.B7.E6.88.AA.E5.9B.BE.E6.A8.A1.E6.9D.BF).

setDefinition

public void setDefinition(Long Definition)

Set Sampled screenshot specification ID. For more information, please see [Sampled Screenshot Parameter Template](https://intl.cloud.tencent.com/document/product/266/33480?from_cn_redirect=1#.E9.87.87.E6.A0.B7.E6.88.AA.E5.9B.BE.E6.A8.A1.E6.9D.BF).

Parameters:

Definition - Sampled screenshot specification ID. For more information, please see [Sampled Screenshot Parameter Template](https://intl.cloud.tencent.com/document/product/266/33480?from_cn_redirect=1#.E9.87.87.E6.A0.B7.E6.88.AA.E5.9B.BE.E6.A8.A1.E6.9D.BF).

getSampleType

public String getSampleType()

Get Sample type. Valid values:

Percent: Samples at the specified percentage interval. Time: Samples at the specified time interval.

Returns:

SampleType Sample type. Valid values:

Percent: Samples at the specified percentage interval.

Time: Samples at the specified time interval.

setSampleType

public void setSampleType(String SampleType)

Set Sample type. Valid values:

Percent: Samples at the specified percentage interval. Time: Samples at the specified time interval.