software.amazon.awscdk.services.ivs

Class CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder

java.lang.Object

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

Enclosing interface:

CfnRecordingConfiguration.ThumbnailConfigurationProperty

public static final class CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder
extends java.lang.Object

A builder for CfnRecordingConfiguration.ThumbnailConfigurationProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnRecordingConfiguration.ThumbnailConfigurationProperty	build() Builds the configured instance.
CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder	recordingMode(java.lang.String recordingMode) Sets the value of CfnRecordingConfiguration.ThumbnailConfigurationProperty.getRecordingMode()
CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder	targetIntervalSeconds(java.lang.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 Detail

Builder

public Builder()

Method Detail

recordingMode

public CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder recordingMode(java.lang.String recordingMode)

Sets the value of CfnRecordingConfiguration.ThumbnailConfigurationProperty.getRecordingMode()

Parameters:

recordingMode - Thumbnail recording mode. Valid values:. This parameter is required.

• 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

targetIntervalSeconds

public CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder targetIntervalSeconds(java.lang.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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-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

Valid Range : Minumum value of 5. Maximum value of 60.

Returns:

this

build

public CfnRecordingConfiguration.ThumbnailConfigurationProperty build()

Builds the configured instance.

Returns:

a new instance of CfnRecordingConfiguration.ThumbnailConfigurationProperty

Throws:

java.lang.NullPointerException - if any required attribute was not provided