public class SnapshotByTimeOffsetTaskInput extends AbstractModel
Constructor and Description |
---|
SnapshotByTimeOffsetTaskInput() |
SnapshotByTimeOffsetTaskInput(SnapshotByTimeOffsetTaskInput 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.
|
Modifier and Type | Method and Description |
---|---|
Long |
getDefinition()
Get ID of a time point screencapturing template.
|
String[] |
getExtTimeOffsetSet()
Get List of screenshot time points in the format of `s` or `%`:
If the string ends in `s`, it means that the time point is in seconds; for example, `3.5s` means that the time point is the 3.5th second;
If the string ends in `%`, it means that the time point is the specified percentage of the video duration; for example, `10%` means that the time point is 10% of the video duration.
|
NumberFormat |
getObjectNumberFormat()
Get Rule of the `{number}` variable in the time point screenshot output path.
|
String |
getOutputObjectPath()
Get Output path to a generated time point screenshot, which can be a relative path or an absolute path.
|
TaskOutputStorage |
getOutputStorage()
Get Target bucket of a generated time point screenshot file.
|
Float[] |
getTimeOffsetSet()
Get List of time points of screenshots in seconds.
|
WatermarkInput[] |
getWatermarkSet()
Get List of up to 10 image or text watermarks.
|
void |
setDefinition(Long Definition)
Set ID of a time point screencapturing template.
|
void |
setExtTimeOffsetSet(String[] ExtTimeOffsetSet)
Set List of screenshot time points in the format of `s` or `%`:
If the string ends in `s`, it means that the time point is in seconds; for example, `3.5s` means that the time point is the 3.5th second;
If the string ends in `%`, it means that the time point is the specified percentage of the video duration; for example, `10%` means that the time point is 10% of the video duration.
|
void |
setObjectNumberFormat(NumberFormat ObjectNumberFormat)
Set Rule of the `{number}` variable in the time point screenshot output path.
|
void |
setOutputObjectPath(String OutputObjectPath)
Set Output path to a generated time point screenshot, which can be a relative path or an absolute path.
|
void |
setOutputStorage(TaskOutputStorage OutputStorage)
Set Target bucket of a generated time point screenshot file.
|
void |
setTimeOffsetSet(Float[] TimeOffsetSet)
Set List of time points of screenshots in seconds.
|
void |
setWatermarkSet(WatermarkInput[] WatermarkSet)
Set List of up to 10 image or text watermarks.
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString
public SnapshotByTimeOffsetTaskInput()
public SnapshotByTimeOffsetTaskInput(SnapshotByTimeOffsetTaskInput source)
public Long getDefinition()
public void setDefinition(Long Definition)
Definition
- ID of a time point screencapturing template.public String[] getExtTimeOffsetSet()
public void setExtTimeOffsetSet(String[] ExtTimeOffsetSet)
ExtTimeOffsetSet
- List of screenshot time points in the format of `s` or `%`:
public Float[] getTimeOffsetSet()
public void setTimeOffsetSet(Float[] TimeOffsetSet)
TimeOffsetSet
- List of time points of screenshots in seconds.public WatermarkInput[] getWatermarkSet()
public void setWatermarkSet(WatermarkInput[] WatermarkSet)
WatermarkSet
- List of up to 10 image or text watermarks.
Note: This field may return null, indicating that no valid values can be obtained.public TaskOutputStorage getOutputStorage()
public void setOutputStorage(TaskOutputStorage OutputStorage)
OutputStorage
- Target bucket of a generated time point screenshot file. If this parameter is left empty, the `OutputStorage` value of the upper folder will be inherited.
Note: This field may return null, indicating that no valid values can be obtained.public String getOutputObjectPath()
public void setOutputObjectPath(String OutputObjectPath)
OutputObjectPath
- Output path to a generated time point screenshot, which can be a relative path or an absolute path. If this parameter is left empty, the following relative path will be used by default: `{inputName}_snapshotByTimeOffset_{definition}_{number}.{format}`.public NumberFormat getObjectNumberFormat()
public void setObjectNumberFormat(NumberFormat ObjectNumberFormat)
ObjectNumberFormat
- Rule of the `{number}` variable in the time point screenshot output path.
Note: This field may return null, indicating that no valid values can be obtained.Copyright © 2023. All rights reserved.