@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GridConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
Configuration information specific to Grid layout, for server-side composition. See "Layouts" in Server-Side Composition.
Constructor and Description |
---|
GridConfiguration() |
Modifier and Type | Method and Description |
---|---|
GridConfiguration |
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 |
getVideoAspectRatio()
Sets the non-featured participant display mode.
|
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 |
setVideoAspectRatio(String videoAspectRatio)
Sets the non-featured participant display mode.
|
void |
setVideoFillMode(String videoFillMode)
Defines how video fits within the participant tile.
|
String |
toString()
Returns a string representation of this object.
|
GridConfiguration |
withFeaturedParticipantAttribute(String featuredParticipantAttribute)
This attribute name identifies the featured slot.
|
GridConfiguration |
withGridGap(Integer gridGap)
Specifies the spacing between participant tiles in pixels.
|
GridConfiguration |
withOmitStoppedVideo(Boolean omitStoppedVideo)
Determines whether to omit participants with stopped video in the composition.
|
GridConfiguration |
withVideoAspectRatio(String videoAspectRatio)
Sets the non-featured participant display mode.
|
GridConfiguration |
withVideoAspectRatio(VideoAspectRatio videoAspectRatio)
Sets the non-featured participant display mode.
|
GridConfiguration |
withVideoFillMode(String videoFillMode)
Defines how video fits within the participant tile.
|
GridConfiguration |
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 GridConfiguration 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: 2
.
gridGap
- Specifies the spacing between participant tiles in pixels. Default: 2
.public Integer getGridGap()
Specifies the spacing between participant tiles in pixels. Default: 2
.
2
.public GridConfiguration withGridGap(Integer gridGap)
Specifies the spacing between participant tiles in pixels. Default: 2
.
gridGap
- Specifies the spacing between participant tiles in pixels. Default: 2
.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 GridConfiguration 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 setVideoAspectRatio(String videoAspectRatio)
Sets the non-featured participant display mode. Default: VIDEO
.
videoAspectRatio
- Sets the non-featured participant display mode. Default: VIDEO
.VideoAspectRatio
public String getVideoAspectRatio()
Sets the non-featured participant display mode. Default: VIDEO
.
VIDEO
.VideoAspectRatio
public GridConfiguration withVideoAspectRatio(String videoAspectRatio)
Sets the non-featured participant display mode. Default: VIDEO
.
videoAspectRatio
- Sets the non-featured participant display mode. Default: VIDEO
.VideoAspectRatio
public GridConfiguration withVideoAspectRatio(VideoAspectRatio videoAspectRatio)
Sets the non-featured participant display mode. Default: VIDEO
.
videoAspectRatio
- Sets the non-featured participant display mode. Default: VIDEO
.VideoAspectRatio
public void setVideoFillMode(String videoFillMode)
Defines how video fits within the participant tile. When not set, videoFillMode
defaults to
COVER
fill mode for participants in the grid and to CONTAIN
fill mode for featured
participants.
videoFillMode
- Defines how video fits within the participant tile. When not set, videoFillMode
defaults to
COVER
fill mode for participants in the grid and to CONTAIN
fill mode for
featured participants.VideoFillMode
public String getVideoFillMode()
Defines how video fits within the participant tile. When not set, videoFillMode
defaults to
COVER
fill mode for participants in the grid and to CONTAIN
fill mode for featured
participants.
videoFillMode
defaults to
COVER
fill mode for participants in the grid and to CONTAIN
fill mode for
featured participants.VideoFillMode
public GridConfiguration withVideoFillMode(String videoFillMode)
Defines how video fits within the participant tile. When not set, videoFillMode
defaults to
COVER
fill mode for participants in the grid and to CONTAIN
fill mode for featured
participants.
videoFillMode
- Defines how video fits within the participant tile. When not set, videoFillMode
defaults to
COVER
fill mode for participants in the grid and to CONTAIN
fill mode for
featured participants.VideoFillMode
public GridConfiguration withVideoFillMode(VideoFillMode videoFillMode)
Defines how video fits within the participant tile. When not set, videoFillMode
defaults to
COVER
fill mode for participants in the grid and to CONTAIN
fill mode for featured
participants.
videoFillMode
- Defines how video fits within the participant tile. When not set, videoFillMode
defaults to
COVER
fill mode for participants in the grid and to CONTAIN
fill mode for
featured participants.VideoFillMode
public String toString()
toString
in class Object
Object.toString()
public GridConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.