@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PipConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
Configuration information specific to Picture-in-Picture (PiP) layout, for server-side composition.
Constructor and Description |
---|
PipConfiguration() |
Modifier and Type | Method and Description |
---|---|
PipConfiguration |
clone() |
boolean |
equals(Object obj) |
String |
getFeaturedParticipantAttribute()
This attribute name identifies the featured slot.
|
Integer |
getGridGap()
Specifies the spacing between participant tiles in pixels.
|
Boolean |
getOmitStoppedVideo()
Determines whether to omit participants with stopped video in the composition.
|
String |
getPipBehavior()
Defines PiP behavior when all participants have left.
|
Integer |
getPipHeight()
Specifies the height of the PiP window in pixels.
|
Integer |
getPipOffset()
Sets the PiP window’s offset position in pixels from the closest edges determined by
PipPosition . |
String |
getPipParticipantAttribute()
Identifies the PiP slot.
|
String |
getPipPosition()
Determines the corner position of the PiP window.
|
Integer |
getPipWidth()
Specifies the width of the PiP window in pixels.
|
String |
getVideoFillMode()
Defines how video fits within the participant tile.
|
int |
hashCode() |
Boolean |
isOmitStoppedVideo()
Determines whether to omit participants with stopped video in the composition.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setFeaturedParticipantAttribute(String featuredParticipantAttribute)
This attribute name identifies the featured slot.
|
void |
setGridGap(Integer gridGap)
Specifies the spacing between participant tiles in pixels.
|
void |
setOmitStoppedVideo(Boolean omitStoppedVideo)
Determines whether to omit participants with stopped video in the composition.
|
void |
setPipBehavior(String pipBehavior)
Defines PiP behavior when all participants have left.
|
void |
setPipHeight(Integer pipHeight)
Specifies the height of the PiP window in pixels.
|
void |
setPipOffset(Integer pipOffset)
Sets the PiP window’s offset position in pixels from the closest edges determined by
PipPosition . |
void |
setPipParticipantAttribute(String pipParticipantAttribute)
Identifies the PiP slot.
|
void |
setPipPosition(String pipPosition)
Determines the corner position of the PiP window.
|
void |
setPipWidth(Integer pipWidth)
Specifies the width of the PiP window in pixels.
|
void |
setVideoFillMode(String videoFillMode)
Defines how video fits within the participant tile.
|
String |
toString()
Returns a string representation of this object.
|
PipConfiguration |
withFeaturedParticipantAttribute(String featuredParticipantAttribute)
This attribute name identifies the featured slot.
|
PipConfiguration |
withGridGap(Integer gridGap)
Specifies the spacing between participant tiles in pixels.
|
PipConfiguration |
withOmitStoppedVideo(Boolean omitStoppedVideo)
Determines whether to omit participants with stopped video in the composition.
|
PipConfiguration |
withPipBehavior(PipBehavior pipBehavior)
Defines PiP behavior when all participants have left.
|
PipConfiguration |
withPipBehavior(String pipBehavior)
Defines PiP behavior when all participants have left.
|
PipConfiguration |
withPipHeight(Integer pipHeight)
Specifies the height of the PiP window in pixels.
|
PipConfiguration |
withPipOffset(Integer pipOffset)
Sets the PiP window’s offset position in pixels from the closest edges determined by
PipPosition . |
PipConfiguration |
withPipParticipantAttribute(String pipParticipantAttribute)
Identifies the PiP slot.
|
PipConfiguration |
withPipPosition(PipPosition pipPosition)
Determines the corner position of the PiP window.
|
PipConfiguration |
withPipPosition(String pipPosition)
Determines the corner position of the PiP window.
|
PipConfiguration |
withPipWidth(Integer pipWidth)
Specifies the width of the PiP window in pixels.
|
PipConfiguration |
withVideoFillMode(String videoFillMode)
Defines how video fits within the participant tile.
|
PipConfiguration |
withVideoFillMode(VideoFillMode videoFillMode)
Defines how video fits within the participant tile.
|
public void setFeaturedParticipantAttribute(String 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.
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.public String getFeaturedParticipantAttribute()
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.
"true"
(as a string value) in ParticipantTokenConfiguration is placed in the featured
slot.public PipConfiguration withFeaturedParticipantAttribute(String 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.
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.public void setGridGap(Integer gridGap)
Specifies the spacing between participant tiles in pixels. Default: 0
.
gridGap
- Specifies the spacing between participant tiles in pixels. Default: 0
.public Integer getGridGap()
Specifies the spacing between participant tiles in pixels. Default: 0
.
0
.public PipConfiguration withGridGap(Integer gridGap)
Specifies the spacing between participant tiles in pixels. Default: 0
.
gridGap
- Specifies the spacing between participant tiles in pixels. Default: 0
.public void setOmitStoppedVideo(Boolean omitStoppedVideo)
Determines whether to omit participants with stopped video in the composition. Default: false
.
omitStoppedVideo
- Determines whether to omit participants with stopped video in the composition. Default: false
.public Boolean getOmitStoppedVideo()
Determines whether to omit participants with stopped video in the composition. Default: false
.
false
.public PipConfiguration withOmitStoppedVideo(Boolean omitStoppedVideo)
Determines whether to omit participants with stopped video in the composition. Default: false
.
omitStoppedVideo
- Determines whether to omit participants with stopped video in the composition. Default: false
.public Boolean isOmitStoppedVideo()
Determines whether to omit participants with stopped video in the composition. Default: false
.
false
.public void setPipBehavior(String pipBehavior)
Defines PiP behavior when all participants have left. Default: STATIC
.
pipBehavior
- Defines PiP behavior when all participants have left. Default: STATIC
.PipBehavior
public String getPipBehavior()
Defines PiP behavior when all participants have left. Default: STATIC
.
STATIC
.PipBehavior
public PipConfiguration withPipBehavior(String pipBehavior)
Defines PiP behavior when all participants have left. Default: STATIC
.
pipBehavior
- Defines PiP behavior when all participants have left. Default: STATIC
.PipBehavior
public PipConfiguration withPipBehavior(PipBehavior pipBehavior)
Defines PiP behavior when all participants have left. Default: STATIC
.
pipBehavior
- Defines PiP behavior when all participants have left. Default: STATIC
.PipBehavior
public void setPipHeight(Integer 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.
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.public Integer getPipHeight()
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.
pipHeight
’s value will be based on the size of the composition and the aspect ratio of the participant’s video.public PipConfiguration withPipHeight(Integer 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.
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.public void setPipOffset(Integer pipOffset)
Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition
.
Default: 0
.
pipOffset
- Sets the PiP window’s offset position in pixels from the closest edges determined by
PipPosition
. Default: 0
.public Integer getPipOffset()
Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition
.
Default: 0
.
PipPosition
. Default: 0
.public PipConfiguration withPipOffset(Integer pipOffset)
Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition
.
Default: 0
.
pipOffset
- Sets the PiP window’s offset position in pixels from the closest edges determined by
PipPosition
. Default: 0
.public void setPipParticipantAttribute(String pipParticipantAttribute)
Identifies the PiP slot. A participant with this attribute set to "true"
(as a string value) in
ParticipantTokenConfiguration is placed in the PiP slot.
pipParticipantAttribute
- Identifies the PiP slot. A participant with this attribute set to "true"
(as a string value)
in ParticipantTokenConfiguration is placed in the PiP slot.public String getPipParticipantAttribute()
Identifies the PiP slot. A participant with this attribute set to "true"
(as a string value) in
ParticipantTokenConfiguration is placed in the PiP slot.
"true"
(as a string value)
in ParticipantTokenConfiguration is placed in the PiP slot.public PipConfiguration withPipParticipantAttribute(String pipParticipantAttribute)
Identifies the PiP slot. A participant with this attribute set to "true"
(as a string value) in
ParticipantTokenConfiguration is placed in the PiP slot.
pipParticipantAttribute
- Identifies the PiP slot. A participant with this attribute set to "true"
(as a string value)
in ParticipantTokenConfiguration is placed in the PiP slot.public void setPipPosition(String pipPosition)
Determines the corner position of the PiP window. Default: BOTTOM_RIGHT
.
pipPosition
- Determines the corner position of the PiP window. Default: BOTTOM_RIGHT
.PipPosition
public String getPipPosition()
Determines the corner position of the PiP window. Default: BOTTOM_RIGHT
.
BOTTOM_RIGHT
.PipPosition
public PipConfiguration withPipPosition(String pipPosition)
Determines the corner position of the PiP window. Default: BOTTOM_RIGHT
.
pipPosition
- Determines the corner position of the PiP window. Default: BOTTOM_RIGHT
.PipPosition
public PipConfiguration withPipPosition(PipPosition pipPosition)
Determines the corner position of the PiP window. Default: BOTTOM_RIGHT
.
pipPosition
- Determines the corner position of the PiP window. Default: BOTTOM_RIGHT
.PipPosition
public void setPipWidth(Integer 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.
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.public Integer getPipWidth()
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.
pipWidth
’s
value will be based on the size of the composition and the aspect ratio of the participant’s video.public PipConfiguration withPipWidth(Integer 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.
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.public void setVideoFillMode(String videoFillMode)
Defines how video fits within the participant tile. Default: COVER
.
videoFillMode
- Defines how video fits within the participant tile. Default: COVER
.VideoFillMode
public String getVideoFillMode()
Defines how video fits within the participant tile. Default: COVER
.
COVER
.VideoFillMode
public PipConfiguration withVideoFillMode(String videoFillMode)
Defines how video fits within the participant tile. Default: COVER
.
videoFillMode
- Defines how video fits within the participant tile. Default: COVER
.VideoFillMode
public PipConfiguration withVideoFillMode(VideoFillMode videoFillMode)
Defines how video fits within the participant tile. Default: COVER
.
videoFillMode
- Defines how video fits within the participant tile. Default: COVER
.VideoFillMode
public String toString()
toString
in class Object
Object.toString()
public PipConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.