ivsrealtime/aws.sdk.kotlin.services.ivsrealtime.model/GridConfiguration

GridConfiguration

Configuration information specific to Grid layout, for server-side composition. See "Layouts" in Server-Side Composition.

Types

Builder

class Builder

Companion

object Companion

Properties

featuredParticipantAttribute

val 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

val gridGap: Int

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

omitStoppedVideo

val omitStoppedVideo: Boolean

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

videoAspectRatio

val videoAspectRatio: 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.

videoFillMode

val videoFillMode: 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.

Functions

copy

inline fun copy(block: GridConfiguration.Builder.() -> Unit = {}): GridConfiguration

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String