AWS CDK Reference

Appearance

v2.273.0

Experimental

@aws-cdk/aws-ivs-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ThumbnailConfiguration Class ​

Thumbnail configuration for IVS Recording configuration.

Stability
Experimental
Source
lib/thumbnail-configuration.ts

Example ​

ts
declare const recordingBucket: s3.Bucket;

const recordingConfiguration = new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {
  bucket: recordingBucket,

  // set thumbnail settings
  thumbnailConfiguration: ivs.ThumbnailConfiguration.interval(ivs.Resolution.HD, [ivs.Storage.LATEST, ivs.Storage.SEQUENTIAL], Duration.seconds(30)),
});

Properties ​

recordingModeRecordingModerecording_modeRecordingModerecordingModeRecordingModeRecordingModeRecordingModeRecordingModeRecordingMode#
Thumbnail recording mode.

If you do not specify this property, ThumbnailRecordingMode.INTERVAL is set.

resolutionResolutionresolutionResolutionresolutionResolutionResolutionResolutionResolutionResolution#
The desired resolution of recorded thumbnails for a stream.

If you do not specify this property, same resolution as Input stream is used.

storageStorage[]storagetyping.List[Storage]storageList<Storage>StorageStorage[]Storage*[]Storage#
The format in which thumbnails are recorded for a stream.

If you do not specify this property, ThumbnailStorage.SEQUENTIAL is set.

targetIntervalDurationtarget_intervalDurationtargetIntervalDurationTargetIntervalDurationTargetIntervalDuration#
The targeted thumbnail-generation interval.

Must be between 1 and 60 seconds. If you do not specify this property, Duration.seconds(60) is set.

Methods ​

disable(): ThumbnailConfiguration // chainable@staticmethod def disable() -> ThumbnailConfigurationpublic static ThumbnailConfiguration disable()public static ThumbnailConfiguration Disable()func Disable() ThumbnailConfigurationstatic#
Disable the generation of thumbnails for recorded video.
interval(resolution?: Resolution, storage?: Storage[], targetInterval?: Duration): ThumbnailConfiguration // chainable@staticmethod def interval(resolution: typing.Optional[Resolution] = None, storage: typing.Optional[typing.List[Storage]] = None, target_interval: typing.Optional[Duration] = None) -> ThumbnailConfigurationpublic static ThumbnailConfiguration interval(Resolution resolution, List<Storage> storage, Duration targetInterval)public static ThumbnailConfiguration Interval(Resolution? resolution = null, Storage[]? storage = null, Duration? targetInterval = null)func Interval(Resolution Resolution, Storage *[]Storage, TargetInterval Duration) ThumbnailConfigurationstatic#
Enable the generation of thumbnails for recorded video at a time interval.
3 parameters

Parameters

  • resolutionresolutionresolutionresolutionResolution — The desired resolution of recorded thumbnails for a stream.
  • storagestoragestoragestorageStorage — The format in which thumbnails are recorded for a stream.
  • targetIntervaltarget_intervaltargetIntervaltargetIntervalTargetInterval — The targeted thumbnail-generation interval.