ivs/aws.sdk.kotlin.services.ivs.model/ThumbnailConfiguration

ThumbnailConfiguration

class ThumbnailConfiguration

An object representing a configuration of thumbnails for recorded video.

Types

Builder

class Builder

Companion

object Companion

Properties

recordingMode

val recordingMode: RecordingMode?

Thumbnail recording mode. Default: INTERVAL.

resolution

val resolution: ThumbnailConfigurationResolution?

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

val storage: List<ThumbnailConfigurationStorage>?

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

val targetIntervalSeconds: Long?

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

Functions

copy

inline fun copy(block: ThumbnailConfiguration.Builder.() -> Unit = {}): ThumbnailConfiguration

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String