Skip to content

GridConfiguration

Source code in docs_src/capo_ivs_realtime/types/grid_configuration.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class GridConfiguration(TypedDict, closed=True):
    featured_participant_attribute: NotRequired[
        "capo_ivs_realtime.types.attribute_key.AttributeKey"
    ]
    """<p>This attribute name identifies the featured slot. A participant with this attribute set to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured slot. Default: <code>""</code> (no featured participant).</p>"""
    omit_stopped_video: "capo_ivs_realtime.types.omit_stopped_video.OmitStoppedVideo"
    """<p>Determines whether to omit participants with stopped video in the composition. Default: <code>false</code>.</p>"""
    video_aspect_ratio: NotRequired[
        "capo_ivs_realtime.types.video_aspect_ratio.VideoAspectRatio"
    ]
    """<p>Sets the non-featured participant display mode, to control the aspect ratio of video tiles. <code>VIDEO</code> is 16:9, <code>SQUARE</code> is 1:1, and <code>PORTRAIT</code> is 3:4. Default: <code>VIDEO</code>.</p>"""
    video_fill_mode: NotRequired[
        "capo_ivs_realtime.types.video_fill_mode.VideoFillMode"
    ]
    """<p>Defines how video content fits within the participant tile: <code>FILL</code> (stretched), <code>COVER</code> (cropped), or <code>CONTAIN</code> (letterboxed). When not set, <code>videoFillMode</code> defaults to <code>COVER</code> fill mode for participants in the grid and to <code>CONTAIN</code> fill mode for featured participants.</p>"""
    grid_gap: "capo_ivs_realtime.types.grid_gap.GridGap"
    """<p>Specifies the spacing between participant tiles in pixels. Default: <code>2</code>.</p>"""
    participant_order_attribute: NotRequired[
        "capo_ivs_realtime.types.attribute_key.AttributeKey"
    ]
    """<p>Attribute name in <a>ParticipantTokenConfiguration</a> identifying the participant ordering key. Participants with <code>participantOrderAttribute</code> set to <code>""</code> or not specified are ordered based on their arrival time into the stage.</p>"""

featured_participant_attribute instance-attribute 

featured_participant_attribute: NotRequired[AttributeKey]

This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: "" (no featured participant).

grid_gap instance-attribute 

grid_gap: GridGap

Specifies the spacing between participant tiles in pixels. Default: 2.

omit_stopped_video instance-attribute 

omit_stopped_video: OmitStoppedVideo

Determines whether to omit participants with stopped video in the composition. Default: false.

participant_order_attribute instance-attribute 

participant_order_attribute: NotRequired[AttributeKey]

Attribute name in ParticipantTokenConfiguration identifying the participant ordering key. Participants with participantOrderAttribute set to "" or not specified are ordered based on their arrival time into the stage.

video_aspect_ratio instance-attribute 

video_aspect_ratio: NotRequired[VideoAspectRatio]

Sets the non-featured participant display mode, to control the aspect ratio of video tiles. VIDEO is 16:9, SQUARE is 1:1, and PORTRAIT is 3:4. Default: VIDEO.

video_fill_mode instance-attribute 

video_fill_mode: NotRequired[VideoFillMode]

Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.