ThumbnailConfiguration
An object representing a configuration of thumbnails for recorded video.
Contents
- recordingMode
-
Thumbnail recording mode. Default:
INTERVAL.Type: String
Valid Values:
DISABLED | INTERVALRequired: 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:
SD | HD | FULL_HD | LOWEST_RESOLUTIONRequired: No
- storage
-
Indicates the format in which thumbnails are recorded.
SEQUENTIALrecords all generated thumbnails in a serial manner, to the media/thumbnails directory.LATESTsaves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified bytargetIntervalSeconds. You can enable bothSEQUENTIALandLATEST. Default:SEQUENTIAL.Type: Array of strings
Valid Values:
SEQUENTIAL | LATESTRequired: No
- targetIntervalSeconds
-
The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if
recordingModeisINTERVAL. Default: 60.Important: For the
BASICchannel type, or theSTANDARDchannel type with multitrack input, setting a value fortargetIntervalSecondsdoes not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at thetargetIntervalSecondsinterval, theIDR/Keyframevalue for the input video must be less than thetargetIntervalSecondsvalue. See Amazon IVS Streaming Configuration for information on settingIDR/Keyframeto 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: