/AWS1/CL_IVRGRIDCONFIGURATION

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

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_featuredparticipantattr TYPE /AWS1/IVRATTRIBUTEKEY /AWS1/IVRATTRIBUTEKEY

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

iv_omitstoppedvideo TYPE /AWS1/IVROMITSTOPPEDVIDEO /AWS1/IVROMITSTOPPEDVIDEO

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

iv_videoaspectratio TYPE /AWS1/IVRVIDEOASPECTRATIO /AWS1/IVRVIDEOASPECTRATIO

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.

iv_videofillmode TYPE /AWS1/IVRVIDEOFILLMODE /AWS1/IVRVIDEOFILLMODE

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.

iv_gridgap TYPE /AWS1/IVRGRIDGAP /AWS1/IVRGRIDGAP

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

iv_participantorderattribute TYPE /AWS1/IVRATTRIBUTEKEY /AWS1/IVRATTRIBUTEKEY

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.

---

Queryable Attributes

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

Accessible with the following methods

Method	Description
GET_FEATUREDPARTICIPANTATTR()	Getter for FEATUREDPARTICIPANTATTRIBUTE, with configurable d
ASK_FEATUREDPARTICIPANTATTR()	Getter for FEATUREDPARTICIPANTATTRIBUTE w/ exceptions if fie
HAS_FEATUREDPARTICIPANTATTR()	Determine if FEATUREDPARTICIPANTATTRIBUTE has a value

omitStoppedVideo

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

Accessible with the following methods

Method	Description
GET_OMITSTOPPEDVIDEO()	Getter for OMITSTOPPEDVIDEO

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.

Accessible with the following methods

Method	Description
GET_VIDEOASPECTRATIO()	Getter for VIDEOASPECTRATIO, with configurable default
ASK_VIDEOASPECTRATIO()	Getter for VIDEOASPECTRATIO w/ exceptions if field has no va
HAS_VIDEOASPECTRATIO()	Determine if VIDEOASPECTRATIO has a value

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.

Accessible with the following methods

Method	Description
GET_VIDEOFILLMODE()	Getter for VIDEOFILLMODE, with configurable default
ASK_VIDEOFILLMODE()	Getter for VIDEOFILLMODE w/ exceptions if field has no value
HAS_VIDEOFILLMODE()	Determine if VIDEOFILLMODE has a value

gridGap

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

Accessible with the following methods

Method	Description
GET_GRIDGAP()	Getter for GRIDGAP

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.

Accessible with the following methods

Method	Description
GET_PARTICIPANTORDERATTR()	Getter for PARTICIPANTORDERATTRIBUTE, with configurable defa
ASK_PARTICIPANTORDERATTR()	Getter for PARTICIPANTORDERATTRIBUTE w/ exceptions if field
HAS_PARTICIPANTORDERATTR()	Determine if PARTICIPANTORDERATTRIBUTE has a value