Package software.amazon.awscdk.services.ivs

Interface CfnRecordingConfiguration.ThumbnailConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRecordingConfiguration.ThumbnailConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnRecordingConfiguration

@Stability(Stable)
public static interface CfnRecordingConfiguration.ThumbnailConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The ThumbnailConfiguration property type describes a configuration of thumbnails for recorded video.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ivs.*;
 ThumbnailConfigurationProperty thumbnailConfigurationProperty = ThumbnailConfigurationProperty.builder()
         .recordingMode("recordingMode")
         // the properties below are optional
         .targetIntervalSeconds(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder	A builder for CfnRecordingConfiguration.ThumbnailConfigurationProperty
static final class	CfnRecordingConfiguration.ThumbnailConfigurationProperty.Jsii$Proxy	An implementation for CfnRecordingConfiguration.ThumbnailConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder	builder()
String	getRecordingMode()	Thumbnail recording mode.
default Number	getTargetIntervalSeconds()	The targeted thumbnail-generation interval in seconds.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRecordingMode

@Stability(Stable)
@NotNull
String getRecordingMode()

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

getTargetIntervalSeconds

@Stability(Stable)
@Nullable
default Number getTargetIntervalSeconds()

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

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

builder

@Stability(Stable)
static CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder builder()

Returns:

a CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder of CfnRecordingConfiguration.ThumbnailConfigurationProperty