SubmitSnapshotJobRequest (vod20170321 2.19.1 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.vod20170321.models.SubmitSnapshotJobRequest

public class SubmitSnapshotJobRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`Long`	`count` The maximum number of snapshots.
`String`	`height` The height of each snapshot.
`Long`	`interval` The snapshot interval.
`String`	`snapshotTemplateId` The ID of the snapshot template.
`Long`	`specifiedOffsetTime` The start time of the specified snapshot time period.
`List<Long>`	`specifiedOffsetTimes`
`String`	`spriteSnapshotConfig` The sprite snapshot configuration.
`String`	`userData` The custom configurations, including the configuration of transparent data transmission and callback configurations.
`String`	`videoId` The ID of the video.
`String`	`width` The width of each snapshot.

构造器概要

构造器
构造器和说明

SubmitSnapshotJobRequest()

构造器
构造器和说明
`SubmitSnapshotJobRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static SubmitSnapshotJobRequest`	`build(Map<String,?> map)`
`Long`	`getCount()`
`String`	`getHeight()`
`Long`	`getInterval()`
`String`	`getSnapshotTemplateId()`
`Long`	`getSpecifiedOffsetTime()`
`List<Long>`	`getSpecifiedOffsetTimes()`
`String`	`getSpriteSnapshotConfig()`
`String`	`getUserData()`
`String`	`getVideoId()`
`String`	`getWidth()`
`SubmitSnapshotJobRequest`	`setCount(Long count)`
`SubmitSnapshotJobRequest`	`setHeight(String height)`
`SubmitSnapshotJobRequest`	`setInterval(Long interval)`
`SubmitSnapshotJobRequest`	`setSnapshotTemplateId(String snapshotTemplateId)`
`SubmitSnapshotJobRequest`	`setSpecifiedOffsetTime(Long specifiedOffsetTime)`
`SubmitSnapshotJobRequest`	`setSpecifiedOffsetTimes(List<Long> specifiedOffsetTimes)`
`SubmitSnapshotJobRequest`	`setSpriteSnapshotConfig(String spriteSnapshotConfig)`
`SubmitSnapshotJobRequest`	`setUserData(String userData)`
`SubmitSnapshotJobRequest`	`setVideoId(String videoId)`
`SubmitSnapshotJobRequest`	`setWidth(String width)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - count
```
@NameInMap(value="Count")
public Long count
```
    The maximum number of snapshots. Default value: **1**.
  - height
```
@NameInMap(value="Height")
public String height
```
    The height of each snapshot. Valid values: `[8,4096]`. By default, the height of the video mezzanine file is used. Unit: pixel.
  - interval
```
@NameInMap(value="Interval")
public Long interval
```
    The snapshot interval. The value must be **greater than or equal to 0**. Unit: seconds. If you set this parameter to **0**, snapshots are taken at even intervals based on the video duration divided by the value of the Count parameter. Default value: **1**.
  - snapshotTemplateId
```
@NameInMap(value="SnapshotTemplateId")
public String snapshotTemplateId
```
    The ID of the snapshot template.
    
    * We recommend that you create a snapshot template before you specify the ID of the snapshot template.
    
    * If you set the SnapshotTemplateId parameter, all the other request parameters except the Action and VideoId parameters are ignored.
    
    * For more information about how to create a snapshot template, see [AddVodTemplate](~~99406~~).
  - specifiedOffsetTime
```
@NameInMap(value="SpecifiedOffsetTime")
public Long specifiedOffsetTime
```
    The start time of the specified snapshot time period.
    
    * Unit: milliseconds.
    
    * Default value: **0**.
  - specifiedOffsetTimes
```
@NameInMap(value="SpecifiedOffsetTimes")
public List<Long> specifiedOffsetTimes
```
  - spriteSnapshotConfig
```
@NameInMap(value="SpriteSnapshotConfig")
public String spriteSnapshotConfig
```
    The sprite snapshot configuration. If you set this parameter, sprite snapshots are generated. For more information, see [SpriteSnapshotConfig](~~86952~~).
  - userData
```
@NameInMap(value="UserData")
public String userData
```
    The custom configurations, including the configuration of transparent data transmission and callback configurations. The value is a JSON-formatted string. For more information, see [UserData](~~86952~~).
    
    **
    
    **Note** The callback configurations take effect only when you specify the HTTP callback URL and select the specific callback events in the ApsaraVideo VOD console.
  - videoId
```
@NameInMap(value="VideoId")
public String videoId
```
    The ID of the video.
  - width
```
@NameInMap(value="Width")
public String width
```
    The width of each snapshot. Valid values: `[8,4096]`. By default, the width of the video mezzanine file is used. Unit: pixel.
- 构造器详细资料
  - SubmitSnapshotJobRequest
```
public SubmitSnapshotJobRequest()
```
- 方法详细资料
  - build
```
public static SubmitSnapshotJobRequest build(Map<String,?> map)
                                      throws Exception
```
    抛出:
    
    Exception
  - setCount
```
public SubmitSnapshotJobRequest setCount(Long count)
```
  - getCount
```
public Long getCount()
```
  - setHeight
```
public SubmitSnapshotJobRequest setHeight(String height)
```
  - getHeight
```
public String getHeight()
```
  - setInterval
```
public SubmitSnapshotJobRequest setInterval(Long interval)
```
  - getInterval
```
public Long getInterval()
```
  - setSnapshotTemplateId
```
public SubmitSnapshotJobRequest setSnapshotTemplateId(String snapshotTemplateId)
```
  - getSnapshotTemplateId
```
public String getSnapshotTemplateId()
```
  - setSpecifiedOffsetTime
```
public SubmitSnapshotJobRequest setSpecifiedOffsetTime(Long specifiedOffsetTime)
```
  - getSpecifiedOffsetTime
```
public Long getSpecifiedOffsetTime()
```
  - setSpecifiedOffsetTimes
```
public SubmitSnapshotJobRequest setSpecifiedOffsetTimes(List<Long> specifiedOffsetTimes)
```
  - getSpecifiedOffsetTimes
```
public List<Long> getSpecifiedOffsetTimes()
```
  - setSpriteSnapshotConfig
```
public SubmitSnapshotJobRequest setSpriteSnapshotConfig(String spriteSnapshotConfig)
```
  - getSpriteSnapshotConfig
```
public String getSpriteSnapshotConfig()
```
  - setUserData
```
public SubmitSnapshotJobRequest setUserData(String userData)
```
  - getUserData
```
public String getUserData()
```
  - setVideoId
```
public SubmitSnapshotJobRequest setVideoId(String videoId)
```
  - getVideoId
```
public String getVideoId()
```
  - setWidth
```
public SubmitSnapshotJobRequest setWidth(String width)
```
  - getWidth
```
public String getWidth()
```

类 SubmitSnapshotJobRequest

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

count

height

interval

snapshotTemplateId

specifiedOffsetTime

specifiedOffsetTimes

spriteSnapshotConfig

userData

videoId

width

构造器详细资料

SubmitSnapshotJobRequest

方法详细资料

build

setCount

getCount

setHeight

getHeight

setInterval

getInterval

setSnapshotTemplateId

getSnapshotTemplateId

setSpecifiedOffsetTime

getSpecifiedOffsetTime

setSpecifiedOffsetTimes

getSpecifiedOffsetTimes

setSpriteSnapshotConfig

getSpriteSnapshotConfig

setUserData

getUserData

setVideoId

getVideoId

setWidth

getWidth