aws-cdk-lib.aws_ivs.CfnRecordingConfiguration.ThumbnailConfigurationProperty

interface ThumbnailConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Ivs.CfnRecordingConfiguration.ThumbnailConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsivs#CfnRecordingConfiguration_ThumbnailConfigurationProperty
Javasoftware.amazon.awscdk.services.ivs.CfnRecordingConfiguration.ThumbnailConfigurationProperty
Pythonaws_cdk.aws_ivs.CfnRecordingConfiguration.ThumbnailConfigurationProperty
TypeScript aws-cdk-lib » aws_ivs » CfnRecordingConfiguration » ThumbnailConfigurationProperty

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 { aws_ivs as ivs } from 'aws-cdk-lib';
const thumbnailConfigurationProperty: ivs.CfnRecordingConfiguration.ThumbnailConfigurationProperty = {
  recordingMode: 'recordingMode',

  // the properties below are optional
  targetIntervalSeconds: 123,
};

Properties

NameTypeDescription
recordingModestringThumbnail recording mode. Valid values:.
targetIntervalSeconds?numberThe targeted thumbnail-generation interval in seconds. This is configurable (and required) only if RecordingMode is INTERVAL .

recordingMode

Type: string

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


targetIntervalSeconds?

Type: number (optional)

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.