GridConfiguration
Configuration information specific to Grid layout, for server-side composition. See "Layouts" in Server-Side Composition.
Contents
- 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.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
- videoAspectRatio
-
Sets the non-featured participant display mode. Default:
VIDEO.Type: String
Valid Values:
AUTO | VIDEO | SQUARE | PORTRAITRequired: No
- videoFillMode
-
Defines how video fits within the participant tile. When not set,
videoFillModedefaults toCOVERfill mode for participants in the grid and toCONTAINfill mode for featured participants.Type: String
Valid Values:
FILL | COVER | CONTAINRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
