Package software.amazon.awscdk.services.ivs

Class CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.ivs.CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRecordingConfiguration.ThumbnailConfigurationProperty>

Enclosing interface:

CfnRecordingConfiguration.ThumbnailConfigurationProperty

@Stability(Stable)
public static final class CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnRecordingConfiguration.ThumbnailConfigurationProperty>

A builder for CfnRecordingConfiguration.ThumbnailConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnRecordingConfiguration.ThumbnailConfigurationProperty	build()	Builds the configured instance.
CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder	recordingMode(String recordingMode)	Sets the value of CfnRecordingConfiguration.ThumbnailConfigurationProperty.getRecordingMode()
CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder	resolution(String resolution)	Sets the value of CfnRecordingConfiguration.ThumbnailConfigurationProperty.getResolution()
CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder	storage(List<String> storage)	Sets the value of CfnRecordingConfiguration.ThumbnailConfigurationProperty.getStorage()
CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder	targetIntervalSeconds(Number targetIntervalSeconds)	Sets the value of CfnRecordingConfiguration.ThumbnailConfigurationProperty.getTargetIntervalSeconds()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

recordingMode

@Stability(Stable)
public CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder recordingMode(String recordingMode)

Sets the value of CfnRecordingConfiguration.ThumbnailConfigurationProperty.getRecordingMode()

Parameters:

recordingMode - Thumbnail recording mode. Valid values:.

• DISABLED : Use DISABLED to disable the generation of thumbnails for recorded video.
• INTERVAL : Use INTERVAL to enable the generation of thumbnails for recorded video at a time interval controlled by the TargetIntervalSeconds property.

Default : INTERVAL

Returns:

this

resolution

@Stability(Stable)
public CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder resolution(String resolution)

Sets the value of CfnRecordingConfiguration.ThumbnailConfigurationProperty.getResolution()

Parameters:

resolution - The desired resolution of recorded thumbnails for a stream. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3 .

Returns:

this

storage

@Stability(Stable)
public CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder storage(List<String> storage)

Sets the value of CfnRecordingConfiguration.ThumbnailConfigurationProperty.getStorage()

Parameters:

storage - The format in which thumbnails are recorded for a stream. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/thumbnails/latest/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds . You can enable both SEQUENTIAL and LATEST . Default: SEQUENTIAL .

Returns:

this

targetIntervalSeconds

@Stability(Stable)
public CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder targetIntervalSeconds(Number targetIntervalSeconds)

Sets the value of CfnRecordingConfiguration.ThumbnailConfigurationProperty.getTargetIntervalSeconds()

Parameters:

targetIntervalSeconds - The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if RecordingMode is INTERVAL .

Setting a value for TargetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the TargetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the TargetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

Default : 60

Returns:

this

build

@Stability(Stable)
public CfnRecordingConfiguration.ThumbnailConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnRecordingConfiguration.ThumbnailConfigurationProperty>

Returns:

a new instance of CfnRecordingConfiguration.ThumbnailConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided