com.tencentcloudapi.vod.v20180717.models

Class MediaSampleSnapshotItem

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.vod.v20180717.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[]	getImageUrlSet() Get List of URLs of 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.
Long[]	getWaterMarkDefinition() Get List of watermarking template IDs if the screenshots are watermarked.
void	setDefinition(Long Definition) Set Sampled screenshot specification ID.
void	setImageUrlSet(String[] ImageUrlSet) Set List of URLs of 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	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, 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 Screencapturing 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). Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Definition Sampled screenshot specification ID. For more information, please see [Sampled Screencapturing 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). Note: this field may return null, indicating that no valid values can be obtained.

setDefinition

public void setDefinition(Long Definition)

Set Sampled screenshot specification ID. For more information, please see [Sampled Screencapturing 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). Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Definition - Sampled screenshot specification ID. For more information, please see [Sampled Screencapturing 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). Note: this field may return null, indicating that no valid values can be obtained.

getSampleType

public String getSampleType()

Get Sample type. Valid values:

Percent: samples at a specified percentage interval. Time: samples at a specified time interval. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

SampleType Sample type. Valid values:

Percent: samples at a specified percentage interval.

Time: samples at a specified time interval.

Note: this field may return null, indicating that no valid values can be obtained.

setSampleType

public void setSampleType(String SampleType)

Set Sample type. Valid values:

Percent: samples at a specified percentage interval. Time: samples at a specified time interval. Note: this field may return null, indicating that no valid values can be obtained.