PipConfiguration

Configuration information specific to Picture-in-Picture (PiP) layout, for server-side composition.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: PipConfiguration.Builder.() -> Unit = {}): PipConfiguration
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String