/AWS1/CL_IVSTHUMBNAILCONF

An object representing a configuration of thumbnails for recorded video.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_recordingmode TYPE /AWS1/IVSRECORDINGMODE /AWS1/IVSRECORDINGMODE

Thumbnail recording mode. Default: INTERVAL.

iv_targetintervalseconds TYPE /AWS1/IVSTARGETINTERVALSECONDS /AWS1/IVSTARGETINTERVALSECONDS

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, or the STANDARD channel type with multitrack input, 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.

iv_resolution TYPE /AWS1/IVSTHUMBNAILCONFRESOLU00 /AWS1/IVSTHUMBNAILCONFRESOLU00

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).

it_storage TYPE /AWS1/CL_IVSTHUMBNAILCONFSTR00=>TT_THUMBNAILCONFSTORAGELIST TT_THUMBNAILCONFSTORAGELIST

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.

---

Queryable Attributes

recordingMode

Thumbnail recording mode. Default: INTERVAL.

Accessible with the following methods

Method	Description
GET_RECORDINGMODE()	Getter for RECORDINGMODE, with configurable default
ASK_RECORDINGMODE()	Getter for RECORDINGMODE w/ exceptions if field has no value
HAS_RECORDINGMODE()	Determine if RECORDINGMODE has a value

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, or the STANDARD channel type with multitrack input, 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.

Accessible with the following methods

Method	Description
GET_TARGETINTERVALSECONDS()	Getter for TARGETINTERVALSECONDS, with configurable default
ASK_TARGETINTERVALSECONDS()	Getter for TARGETINTERVALSECONDS w/ exceptions if field has
HAS_TARGETINTERVALSECONDS()	Determine if TARGETINTERVALSECONDS has a value

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).

Accessible with the following methods

Method	Description
GET_RESOLUTION()	Getter for RESOLUTION, with configurable default
ASK_RESOLUTION()	Getter for RESOLUTION w/ exceptions if field has no value
HAS_RESOLUTION()	Determine if RESOLUTION has a value

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.

Accessible with the following methods

Method	Description
GET_STORAGE()	Getter for STORAGE, with configurable default
ASK_STORAGE()	Getter for STORAGE w/ exceptions if field has no value
HAS_STORAGE()	Determine if STORAGE has a value