/AWS1/CL_IVRPIPCONFIGURATION

Configuration information specific to Picture-in-Picture (PiP) layout, for 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_videofillmode TYPE /AWS1/IVRVIDEOFILLMODE /AWS1/IVRVIDEOFILLMODE

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

iv_gridgap TYPE /AWS1/IVRGRIDGAP /AWS1/IVRGRIDGAP

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

iv_pipparticipantattribute TYPE /AWS1/IVRATTRIBUTEKEY /AWS1/IVRATTRIBUTEKEY

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

iv_pipbehavior TYPE /AWS1/IVRPIPBEHAVIOR /AWS1/IVRPIPBEHAVIOR

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

iv_pipoffset TYPE /AWS1/IVRPIPOFFSET /AWS1/IVRPIPOFFSET

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

iv_pipposition TYPE /AWS1/IVRPIPPOSITION /AWS1/IVRPIPPOSITION

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

iv_pipwidth TYPE /AWS1/IVRPIPWIDTH /AWS1/IVRPIPWIDTH

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.

iv_pipheight TYPE /AWS1/IVRPIPHEIGHT /AWS1/IVRPIPHEIGHT

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.

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

videoFillMode

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

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: 0.

Accessible with the following methods

Method	Description
GET_GRIDGAP()	Getter for GRIDGAP

pipParticipantAttribute

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

Accessible with the following methods

Method	Description
GET_PIPPARTICIPANTATTRIBUTE()	Getter for PIPPARTICIPANTATTRIBUTE, with configurable defaul
ASK_PIPPARTICIPANTATTRIBUTE()	Getter for PIPPARTICIPANTATTRIBUTE w/ exceptions if field ha
HAS_PIPPARTICIPANTATTRIBUTE()	Determine if PIPPARTICIPANTATTRIBUTE has a value

pipBehavior

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

Accessible with the following methods

Method	Description
GET_PIPBEHAVIOR()	Getter for PIPBEHAVIOR, with configurable default
ASK_PIPBEHAVIOR()	Getter for PIPBEHAVIOR w/ exceptions if field has no value
HAS_PIPBEHAVIOR()	Determine if PIPBEHAVIOR has a value

pipOffset

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

Accessible with the following methods

Method	Description
GET_PIPOFFSET()	Getter for PIPOFFSET

pipPosition

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

Accessible with the following methods

Method	Description
GET_PIPPOSITION()	Getter for PIPPOSITION, with configurable default
ASK_PIPPOSITION()	Getter for PIPPOSITION w/ exceptions if field has no value
HAS_PIPPOSITION()	Determine if PIPPOSITION has a value

pipWidth

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.

Accessible with the following methods

Method	Description
GET_PIPWIDTH()	Getter for PIPWIDTH, with configurable default
ASK_PIPWIDTH()	Getter for PIPWIDTH w/ exceptions if field has no value
HAS_PIPWIDTH()	Determine if PIPWIDTH has a value

pipHeight

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.

Accessible with the following methods

Method	Description
GET_PIPHEIGHT()	Getter for PIPHEIGHT, with configurable default
ASK_PIPHEIGHT()	Getter for PIPHEIGHT w/ exceptions if field has no value
HAS_PIPHEIGHT()	Determine if PIPHEIGHT has a value

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