Skip to content

ParticipantThumbnailConfiguration

Source code in docs_src/capo_ivs_realtime/types/participant_thumbnail_configuration.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class ParticipantThumbnailConfiguration(TypedDict, closed=True):
    target_interval_seconds: NotRequired[
        "capo_ivs_realtime.types.thumbnail_interval_seconds.ThumbnailIntervalSeconds"
    ]
    """<p>The targeted thumbnail-generation interval in seconds. This is configurable only if <code>recordingMode</code> is <code>INTERVAL</code>. 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/high directory. <code>LATEST</code> saves the latest thumbnail in media/latest_thumbnail/high/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>"""
    recording_mode: NotRequired[
        "capo_ivs_realtime.types.thumbnail_recording_mode.ThumbnailRecordingMode"
    ]
    """<p>Thumbnail recording mode. Default: <code>DISABLED</code>.</p>"""

recording_mode instance-attribute 

recording_mode: NotRequired[ThumbnailRecordingMode]

Thumbnail recording mode. Default: DISABLED.

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/high directory. LATEST saves the latest thumbnail in media/latest_thumbnail/high/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. This is configurable only if recordingMode is INTERVAL. Default: 60.