Skip to content

RenditionConfiguration

Used by
Source code in docs_src/capo_ivs/types/rendition_configuration.py 
12
13
14
15
16
17
18
19
20
class RenditionConfiguration(TypedDict, closed=True):
    rendition_selection: NotRequired[
        "capo_ivs.types.rendition_configuration_rendition_selection.RenditionConfigurationRenditionSelection"
    ]
    """<p>Indicates which set of renditions are recorded for a stream. For <code>BASIC</code> channels, the <code>CUSTOM</code> value has no effect. If <code>CUSTOM</code> is specified, a set of renditions must be specified in the <code>renditions</code> field. Default: <code>ALL</code>.</p>"""
    renditions: NotRequired[
        "capo_ivs.types.rendition_configuration_rendition_list.RenditionConfigurationRenditionList"
    ]
    """<p>Indicates which renditions are recorded for a stream, if <code>renditionSelection</code> is <code>CUSTOM</code>; otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html">Auto-Record to Amazon S3</a>.</p>"""

rendition_selection instance-attribute 

rendition_selection: NotRequired[RenditionConfigurationRenditionSelection]

Indicates which set of renditions are recorded for a stream. For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be specified in the renditions field. Default: ALL.

renditions instance-attribute 

renditions: NotRequired[RenditionConfigurationRenditionList]

Indicates which renditions are recorded for a stream, if renditionSelection is CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.