com.aliyun.sdk.service.vod20170321.models

类 SubmitSnapshotJobRequest.Builder

java.lang.Object

com.aliyun.sdk.service.vod20170321.models.SubmitSnapshotJobRequest.Builder

所有已实现的接口:

darabonba.core.RequestModel.Builder<SubmitSnapshotJobRequest,SubmitSnapshotJobRequest.Builder>

封闭类:

SubmitSnapshotJobRequest

public static final class SubmitSnapshotJobRequest.Builder
extends Object

方法概要

限定符和类型	方法和说明
SubmitSnapshotJobRequest	build()
SubmitSnapshotJobRequest.Builder	count(Long count) The maximum number of snapshots.
SubmitSnapshotJobRequest.Builder	height(String height) The height of each snapshot.
SubmitSnapshotJobRequest.Builder	interval(Long interval) The snapshot interval.
SubmitSnapshotJobRequest.Builder	snapshotTemplateId(String snapshotTemplateId) The ID of the snapshot template.
SubmitSnapshotJobRequest.Builder	specifiedOffsetTime(Long specifiedOffsetTime) The point in time when the first snapshot is captured.
SubmitSnapshotJobRequest.Builder	specifiedOffsetTimes(List<Long> specifiedOffsetTimes) The playback positions at which you want to capture snapshots.
SubmitSnapshotJobRequest.Builder	spriteSnapshotConfig(String spriteSnapshotConfig) The sprite snapshot configuration.
SubmitSnapshotJobRequest.Builder	userData(String userData) The custom configurations including the configuration of transparent data transmission and callback configurations.
SubmitSnapshotJobRequest.Builder	videoId(String videoId) The ID of the video.
SubmitSnapshotJobRequest.Builder	width(String width) The width of each snapshot.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细资料

count

public SubmitSnapshotJobRequest.Builder count(Long count)

The maximum number of snapshots. Default value: **1**.

height

public SubmitSnapshotJobRequest.Builder height(String height)

The height of each snapshot. Valid values: `[8,4096]`. By default, the height of the video source is used. Unit: pixels.

interval

public SubmitSnapshotJobRequest.Builder interval(Long interval)

The snapshot interval. The value must be **greater than or equal to 0**.

* Unit: seconds. * Default value: **1**. * If you set this parameter to **0**, snapshots are captured at even intervals based on the video duration divided by the value of the Count parameter.

snapshotTemplateId

public SubmitSnapshotJobRequest.Builder snapshotTemplateId(String snapshotTemplateId)

The ID of the snapshot template.

* We recommend that you create a snapshot template before you specify the template ID. For more information about how to create a snapshot template, see [AddVodTemplate](~~99406~~). * If you set the SnapshotTemplateId parameter, all the other request parameters except the Action and VideoId parameters are ignored.

specifiedOffsetTime

public SubmitSnapshotJobRequest.Builder specifiedOffsetTime(Long specifiedOffsetTime)

The point in time when the first snapshot is captured.

* Unit: milliseconds. * Default value: **0**.

specifiedOffsetTimes

public SubmitSnapshotJobRequest.Builder specifiedOffsetTimes(List<Long> specifiedOffsetTimes)

The playback positions at which you want to capture snapshots. Unit: milliseconds. You can specify up to 30 playback positions in a request.

spriteSnapshotConfig

public SubmitSnapshotJobRequest.Builder spriteSnapshotConfig(String spriteSnapshotConfig)

The sprite snapshot configuration. If you set this parameter, sprite snapshots are generated. For more information, see [SpriteSnapshotConfig](~~86952~~).

userData

public SubmitSnapshotJobRequest.Builder userData(String userData)

The custom configurations including the configuration of transparent data transmission and callback configurations. The value must be a JSON string. For more information, see [UserData](~~86952~~).

> To use the message callback feature, you must specify an HTTP callback URL and the callback events in the ApsaraVideo VOD console. Otherwise, the callback settings do not take effect.

videoId

public SubmitSnapshotJobRequest.Builder videoId(String videoId)

The ID of the video. You can use one of the following methods to obtain the ID:

* After you upload a video in the ApsaraVideo VOD console, you can log on to the [ApsaraVideo VOD console](https://vod.console.aliyun.com) and choose **Media Files** > **Audio/Video** to view the ID of the video. * Obtain the video ID from the response to the [CreateUploadVideo](~~55407~~) operation that you called to obtain the upload URL and credential. * Obtain the video ID from the response to the [SearchMedia](~~86044~~) operation that you called to query media information after the audio or video file is uploaded.

width

public SubmitSnapshotJobRequest.Builder width(String width)

The width of each snapshot. Valid values: `[8,4096]`. By default, the width of the video source is used. Unit: pixels.

build

public SubmitSnapshotJobRequest build()