ThumbnailConfiguration

class aws_cdk.aws_ivs_alpha.ThumbnailConfiguration(*args: Any, **kwargs)

Bases: object

(experimental) Thumbnail configuration for IVS Recording configuration.

Stability:: experimental
ExampleMetadata:: infused

Example:

# recording_bucket: s3.Bucket


recording_configuration = ivs.RecordingConfiguration(self, "RecordingConfiguration",
    bucket=recording_bucket,

    # set thumbnail settings
    thumbnail_configuration=ivs.ThumbnailConfiguration.interval(ivs.Resolution.HD, [ivs.Storage.LATEST, ivs.Storage.SEQUENTIAL], Duration.seconds(30))
)

Attributes

recording_mode

(experimental) Thumbnail recording mode.

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

Stability:: experimental

resolution

(experimental) The desired resolution of recorded thumbnails for a stream.

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

Stability:: experimental

storage

(experimental) The format in which thumbnails are recorded for a stream.

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

Stability:: experimental

target_interval

(experimental) The targeted thumbnail-generation interval.

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

Stability:: experimental

Static Methods

classmethod disable()

(experimental) Disable the generation of thumbnails for recorded video.

Stability:: experimental
Return type:: ThumbnailConfiguration

classmethod interval(resolution=None, storage=None, target_interval=None)

(experimental) Enable the generation of thumbnails for recorded video at a time interval.

Parameters:

resolution (Optional[Resolution]) – The desired resolution of recorded thumbnails for a stream. If you do not specify this property, same resolution as Input stream is used.
storage (Optional[Sequence[Storage]]) – The format in which thumbnails are recorded for a stream. If you do not specify this property, ThumbnailStorage.SEQUENTIAL is set.
target_interval (Optional[Duration]) – The targeted thumbnail-generation interval. If you do not specify this property, Duration.seconds(60) is set.

Stability:

experimental

Return type:

ThumbnailConfiguration