ivsrealtime/aws.sdk.kotlin.services.ivsrealtime.model/PipConfiguration/Builder

Builder

Properties

var featuredParticipantAttribute: String?

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).

gridGap

var gridGap: Int

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

omitStoppedVideo

var omitStoppedVideo: Boolean

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

pipBehavior

var pipBehavior: PipBehavior?

Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.

pipHeight

var pipHeight: Int?

Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

pipOffset

var pipOffset: Int

Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.

pipParticipantAttribute

var pipParticipantAttribute: String?

Specifies the participant for the PiP window. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot. Default: "" (no PiP participant).

pipPosition

var pipPosition: PipPosition?

Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.

pipWidth

var pipWidth: Int?

Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

videoFillMode

var videoFillMode: VideoFillMode?

Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.