GridConfiguration (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.ivsrealtime.model

Class GridConfiguration

java.lang.Object
- com.amazonaws.services.ivsrealtime.model.GridConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GridConfiguration ()

Constructors
Constructor and Description
`GridConfiguration ()`

Method Summary

All Methods
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, to control the aspect ratio of video tiles.
`String`	`getVideoFillMode ()` Defines how video content fits within the participant tile: `FILL` (stretched), `COVER` (cropped), or `CONTAIN` (letterboxed).
`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, to control the aspect ratio of video tiles.
`void`	`setVideoFillMode (String videoFillMode)` Defines how video content fits within the participant tile: `FILL` (stretched), `COVER` (cropped), or `CONTAIN` (letterboxed).
`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, to control the aspect ratio of video tiles.
`GridConfiguration`	`withVideoAspectRatio (VideoAspectRatio videoAspectRatio)` Sets the non-featured participant display mode, to control the aspect ratio of video tiles.
`GridConfiguration`	`withVideoFillMode (String videoFillMode)` Defines how video content fits within the participant tile: `FILL` (stretched), `COVER` (cropped), or `CONTAIN` (letterboxed).
`GridConfiguration`	`withVideoFillMode (VideoFillMode videoFillMode)` Defines how video content fits within the participant tile: `FILL` (stretched), `COVER` (cropped), or `CONTAIN` (letterboxed).

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GridConfiguration
```
public GridConfiguration()
```
- Method Detail
  - setFeaturedParticipantAttribute
```
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. Default: "" (no featured participant).
    
    Parameters:
    
    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).
  - getFeaturedParticipantAttribute
```
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. Default: "" (no featured participant).
    
    Returns:
    
    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).
  - withFeaturedParticipantAttribute
```
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. Default: "" (no featured participant).
    
    Parameters:
    
    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).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOmitStoppedVideo
```
public void setOmitStoppedVideo(Boolean omitStoppedVideo)
```
    Determines whether to omit participants with stopped video in the composition. Default: false.
    
    Parameters:
    
    omitStoppedVideo - Determines whether to omit participants with stopped video in the composition. Default: false .
  - getOmitStoppedVideo
```
public Boolean getOmitStoppedVideo()
```
    Determines whether to omit participants with stopped video in the composition. Default: false.
    
    Returns:
    
    Determines whether to omit participants with stopped video in the composition. Default: false.
  - withOmitStoppedVideo
```
public GridConfiguration withOmitStoppedVideo(Boolean omitStoppedVideo)
```
    Determines whether to omit participants with stopped video in the composition. Default: false.
    
    Parameters:
    
    omitStoppedVideo - Determines whether to omit participants with stopped video in the composition. Default: false .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isOmitStoppedVideo
```
public Boolean isOmitStoppedVideo()
```
    Determines whether to omit participants with stopped video in the composition. Default: false.
    
    Returns:
    
    Determines whether to omit participants with stopped video in the composition. Default: false.
  - setVideoAspectRatio
```
public void setVideoAspectRatio(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    VideoAspectRatio
  - getVideoAspectRatio
```
public String getVideoAspectRatio()
```
    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.
    
    Returns:
    
    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.
    
    See Also:
    
    VideoAspectRatio
  - withVideoAspectRatio
```
public GridConfiguration withVideoAspectRatio(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VideoAspectRatio
  - withVideoAspectRatio
```
public GridConfiguration withVideoAspectRatio(VideoAspectRatio 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VideoAspectRatio
  - setVideoFillMode
```
public void setVideoFillMode(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    VideoFillMode
  - getVideoFillMode
```
public String getVideoFillMode()
```
    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.
    
    Returns:
    
    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.
    
    See Also:
    
    VideoFillMode
  - withVideoFillMode
```
public GridConfiguration withVideoFillMode(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VideoFillMode
  - withVideoFillMode
```
public GridConfiguration withVideoFillMode(VideoFillMode 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VideoFillMode
  - setGridGap
```
public void setGridGap(Integer gridGap)
```
    Specifies the spacing between participant tiles in pixels. Default: 2.
    
    Parameters:
    
    gridGap - Specifies the spacing between participant tiles in pixels. Default: 2.
  - getGridGap
```
public Integer getGridGap()
```
    Specifies the spacing between participant tiles in pixels. Default: 2.
    
    Returns:
    
    Specifies the spacing between participant tiles in pixels. Default: 2.
  - withGridGap
```
public GridConfiguration withGridGap(Integer gridGap)
```
    Specifies the spacing between participant tiles in pixels. Default: 2.
    
    Parameters:
    
    gridGap - Specifies the spacing between participant tiles in pixels. Default: 2.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GridConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class GridConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GridConfiguration

Method Detail

setFeaturedParticipantAttribute

getFeaturedParticipantAttribute

withFeaturedParticipantAttribute

setOmitStoppedVideo

getOmitStoppedVideo

withOmitStoppedVideo

isOmitStoppedVideo

setVideoAspectRatio

getVideoAspectRatio

withVideoAspectRatio

withVideoAspectRatio

setVideoFillMode

getVideoFillMode

withVideoFillMode

withVideoFillMode

setGridGap

getGridGap

withGridGap

toString

equals

hashCode

clone

marshall