PipConfiguration
Configuration information specific to Picture-in-Picture (PiP) layout, for 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. 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:
0.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
- pipBehavior
-
Defines PiP behavior when all participants have left:
STATIC(maintains original position/size) orDYNAMIC(expands to full composition). Default:STATIC.Type: String
Valid Values:
STATIC | DYNAMICRequired: No
- 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.Type: Integer
Valid Range: Minimum value of 1.
Required: No
- pipOffset
-
Sets the PiP window’s offset position in pixels from the closest edges determined by
PipPosition. Default:0.Type: Integer
Valid Range: Minimum value of 0.
Required: No
- 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).Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern:
[a-zA-Z0-9-_]*Required: No
- pipPosition
-
Determines the corner position of the PiP window. Default:
BOTTOM_RIGHT.Type: String
Valid Values:
TOP_LEFT | TOP_RIGHT | BOTTOM_LEFT | BOTTOM_RIGHTRequired: No
- 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.Type: Integer
Valid Range: Minimum value of 1.
Required: No
- videoFillMode
-
Defines how video content fits within the participant tile:
FILL(stretched),COVER(cropped), orCONTAIN(letterboxed). Default:COVER.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:
