PipConfiguration ¶

class PipConfiguration(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_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). Default: <code>COVER</code>.</p>"""
    grid_gap: "capo_ivs_realtime.types.grid_gap.GridGap"
    """<p>Specifies the spacing between participant tiles in pixels. Default: <code>0</code>.</p>"""
    pip_participant_attribute: NotRequired[
        "capo_ivs_realtime.types.attribute_key.AttributeKey"
    ]
    """<p>Specifies the participant for the PiP window. A participant with this attribute set to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the PiP slot. Default: <code>""</code> (no PiP participant).</p>"""
    pip_behavior: NotRequired["capo_ivs_realtime.types.pip_behavior.PipBehavior"]
    """<p>Defines PiP behavior when all participants have left: <code>STATIC</code> (maintains original position/size) or <code>DYNAMIC</code> (expands to full composition). Default: <code>STATIC</code>.</p>"""
    pip_offset: "capo_ivs_realtime.types.pip_offset.PipOffset"
    """<p>Sets the PiP window’s offset position in pixels from the closest edges determined by <code>PipPosition</code>. Default: <code>0</code>.</p>"""
    pip_position: NotRequired["capo_ivs_realtime.types.pip_position.PipPosition"]
    """<p>Determines the corner position of the PiP window. Default: <code>BOTTOM_RIGHT</code>.</p>"""
    pip_width: NotRequired["capo_ivs_realtime.types.pip_width.PipWidth"]
    """<p>Specifies the width of the PiP window in pixels. When this is not set explicitly, <code>pipWidth</code>’s value will be based on the size of the composition and the aspect ratio of the participant’s video.</p>"""
    pip_height: NotRequired["capo_ivs_realtime.types.pip_height.PipHeight"]
    """<p>Specifies the height of the PiP window in pixels. When this is not set explicitly, <code>pipHeight</code>’s value will be based on the size of the composition and the aspect ratio of the participant’s video.</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>"""