Skip to content

CompositionThumbnailConfiguration

Source code in docs_src/capo_ivs_realtime/types/composition_thumbnail_configuration.py
class CompositionThumbnailConfiguration(TypedDict, closed=True):
    target_interval_seconds: NotRequired[
        "capo_ivs_realtime.types.thumbnail_interval_seconds.ThumbnailIntervalSeconds"
    ]
    """<p>The targeted thumbnail-generation interval in seconds. Default: 60.</p>"""
    storage: NotRequired[
        "capo_ivs_realtime.types.thumbnail_storage_type_list.ThumbnailStorageTypeList"
    ]
    """<p>Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records all generated thumbnails in a serial manner, to the media/thumbnails/(width)x(height) directory, where (width) and (height) are the width and height of the thumbnail. <code>LATEST</code> saves the latest thumbnail in media/latest_thumbnail/(width)x(height)/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>"""

storage instance-attribute

storage: NotRequired[ThumbnailStorageTypeList]

Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails/(width)x(height) directory, where (width) and (height) are the width and height of the thumbnail. LATEST saves the latest thumbnail in media/latest_thumbnail/(width)x(height)/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

target_interval_seconds instance-attribute

target_interval_seconds: NotRequired[ThumbnailIntervalSeconds]

The targeted thumbnail-generation interval in seconds. Default: 60.