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")
         .resolution("resolution")
         .storage(List.of("storage"))
         .targetIntervalSeconds(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html

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()
default String	getRecordingMode()	Thumbnail recording mode.
default String	getResolution()	The desired resolution of recorded thumbnails for a stream.
default List<String>	getStorage()	The format in which thumbnails are recorded for a stream.
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)
@Nullable
default 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

Default: - "INTERVAL"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-recordingmode

getResolution

@Stability(Stable)
@Nullable
default String getResolution()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-resolution

getStorage

@Stability(Stable)
@Nullable
default List<String> getStorage()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-storage

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

Default: - 60

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-targetintervalseconds

builder

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

Returns:

a CfnRecordingConfiguration.ThumbnailConfigurationProperty.Builder of CfnRecordingConfiguration.ThumbnailConfigurationProperty