Class GridViewConfiguration

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

Specifies the type of grid layout.

See Also:

  • Method Details

    • contentShareLayout

      public final ContentShareLayoutOption contentShareLayout()

      Defines the layout of the video tiles when content sharing is enabled.

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

      Returns:
      Defines the layout of the video tiles when content sharing is enabled.
      See Also:

    • contentShareLayoutAsString

      public final String contentShareLayoutAsString()

      Defines the layout of the video tiles when content sharing is enabled.

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

      Returns:
      Defines the layout of the video tiles when content sharing is enabled.
      See Also:

    • presenterOnlyConfiguration

      public final PresenterOnlyConfiguration presenterOnlyConfiguration()

      Defines the configuration options for a presenter only video tile.

      Returns:
      Defines the configuration options for a presenter only video tile.

    • activeSpeakerOnlyConfiguration

      public final ActiveSpeakerOnlyConfiguration activeSpeakerOnlyConfiguration()

      The configuration settings for an ActiveSpeakerOnly video tile.

      Returns:
      The configuration settings for an ActiveSpeakerOnly video tile.

    • horizontalLayoutConfiguration

      public final HorizontalLayoutConfiguration horizontalLayoutConfiguration()

      The configuration settings for a horizontal layout.

      Returns:
      The configuration settings for a horizontal layout.

    • verticalLayoutConfiguration

      public final VerticalLayoutConfiguration verticalLayoutConfiguration()

      The configuration settings for a vertical layout.

      Returns:
      The configuration settings for a vertical layout.

    • videoAttribute

      public final VideoAttribute videoAttribute()

      The attribute settings for the video tiles.

      Returns:
      The attribute settings for the video tiles.

    • canvasOrientation

      public final CanvasOrientation canvasOrientation()

      The orientation setting, horizontal or vertical.

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

      Returns:
      The orientation setting, horizontal or vertical.
      See Also:

    • canvasOrientationAsString

      public final String canvasOrientationAsString()

      The orientation setting, horizontal or vertical.

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

      Returns:
      The orientation setting, horizontal or vertical.
      See Also:

    • toBuilder

      public GridViewConfiguration.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<GridViewConfiguration.Builder,GridViewConfiguration>
      Returns:
      a builder for type T

    • builder

      public static GridViewConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GridViewConfiguration.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.