Class GridConfiguration

java.lang.Object
software.amazon.awssdk.services.ivsrealtime.model.GridConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<GridConfiguration.Builder,GridConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class GridConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GridConfiguration.Builder,GridConfiguration>

Configuration information specific to Grid layout, for server-side composition. See "Layouts" in Server-Side Composition.

See Also:

  • Method Details

    • featuredParticipantAttribute

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

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

    • omitStoppedVideo

      public final Boolean omitStoppedVideo()

      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.

    • videoAspectRatio

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, videoAspectRatio will return VideoAspectRatio.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from videoAspectRatioAsString().

      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:

    • videoAspectRatioAsString

      public final String videoAspectRatioAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, videoAspectRatio will return VideoAspectRatio.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from videoAspectRatioAsString().

      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:

    • videoFillMode

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, videoFillMode will return VideoFillMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from videoFillModeAsString().

      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:

    • videoFillModeAsString

      public final String videoFillModeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, videoFillMode will return VideoFillMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from videoFillModeAsString().

      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:

    • gridGap

      public final Integer gridGap()

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

      Returns:
      Specifies the spacing between participant tiles in pixels. Default: 2.

    • toBuilder

      public GridConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GridConfiguration.Builder,GridConfiguration>
      Returns:
      a builder for type T

    • builder

      public static GridConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GridConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.