{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-interactive-video-service/refs/heads/main/json-schema/ivs-thumbnail-configuration-schema.json",
"title": "ThumbnailConfiguration",
"description": "An object representing a configuration of thumbnails for recorded video.",
"type": "object",
"properties": {
"recordingMode": {
"allOf": [
{
"$ref": "#/components/schemas/RecordingMode"
},
{
"description": "Thumbnail recording mode. Default: INTERVAL."
}
]
},
"resolution": {
"allOf": [
{
"$ref": "#/components/schemas/ThumbnailConfigurationResolution"
},
{
"description": "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)."
}
]
},
"storage": {
"allOf": [
{
"$ref": "#/components/schemas/ThumbnailConfigurationStorageList"
},
{
"description": "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."
}
]
},
"targetIntervalSeconds": {
"allOf": [
{
"$ref": "#/components/schemas/TargetIntervalSeconds"
},
{
"description": "
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.