ThumbnailConfiguration - Amazon IVS

ThumbnailConfiguration

An object representing a configuration of thumbnails for recorded video.

Contents

recordingMode

Thumbnail recording mode. Default: INTERVAL.

Type: String

Valid Values: DISABLED | INTERVAL

Required: No

resolution

Indicates the desired resolution of recorded thumbnails. 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. Default: Null (source resolution is returned).

Type: String

Valid Values: FULL_HD | HD | SD | LOWEST_RESOLUTION

Required: No

storage

Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

Type: Array of strings

Valid Values: SEQUENTIAL | LATEST

Required: No

targetIntervalSeconds

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: For the BASIC channel type, 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.

Type: Long

Valid Range: Minimum value of 1. Maximum value of 60.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: