ThumbnailConfiguration ¶

class ThumbnailConfiguration(TypedDict, closed=True):
    recording_mode: NotRequired["capo_ivs.types.recording_mode.RecordingMode"]
    """<p>Thumbnail recording mode. Default: <code>INTERVAL</code>.</p>"""
    target_interval_seconds: NotRequired[
        "capo_ivs.types.target_interval_seconds.TargetIntervalSeconds"
    ]
    """<p>The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if <code>recordingMode</code> is <code>INTERVAL</code>. Default: 60.</p> <p> <b>Important:</b> For the <code>BASIC</code> channel type, or the <code>STANDARD</code> channel type with multitrack input, setting a value for <code>targetIntervalSeconds</code> does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the <code>targetIntervalSeconds</code> interval, the <code>IDR/Keyframe</code> value for the input video must be less than the <code>targetIntervalSeconds</code> value. See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html"> Amazon IVS Streaming Configuration</a> for information on setting <code>IDR/Keyframe</code> to the recommended value in video-encoder settings.</p>"""
    resolution: NotRequired[
        "capo_ivs.types.thumbnail_configuration_resolution.ThumbnailConfigurationResolution"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html">Auto-Record to Amazon S3</a>. Default: Null (source resolution is returned).</p>"""
    storage: NotRequired[
        "capo_ivs.types.thumbnail_configuration_storage_list.ThumbnailConfigurationStorageList"
    ]
    """<p>Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records all generated thumbnails in a serial manner, to the media/thumbnails directory. <code>LATEST</code> saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by <code>targetIntervalSeconds</code>. You can enable both <code>SEQUENTIAL</code> and <code>LATEST</code>. Default: <code>SEQUENTIAL</code>.</p>"""