GridConfiguration

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

featuredParticipantAttribute

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: [a-zA-Z0-9-_]*

Required: No

gridGap

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

Type: Integer

Valid Range: Minimum value of 0.

Required: No

omitStoppedVideo

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

Type: Boolean

Required: No

participantOrderAttribute

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: [a-zA-Z0-9-_]*

Required: No

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.

Type: String

Valid Values: AUTO | VIDEO | SQUARE | PORTRAIT

Required: No

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.

Type: String

Valid Values: FILL | COVER | CONTAIN

Required: No

GridConfiguration

Contents

See Also