Package software.amazon.awssdk.services.ivsrealtime.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GridConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static GridConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	featuredParticipantAttribute()	This attribute name identifies the featured slot.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
Integer	gridGap()	Specifies the spacing between participant tiles in pixels.
int	hashCode()
Boolean	omitStoppedVideo()	Determines whether to omit participants with stopped video in the composition.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GridConfiguration.Builder>	serializableBuilderClass()
GridConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
VideoAspectRatio	videoAspectRatio()	Sets the non-featured participant display mode, to control the aspect ratio of video tiles.
String	videoAspectRatioAsString()	Sets the non-featured participant display mode, to control the aspect ratio of video tiles.
VideoFillMode	videoFillMode()	Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed).
String	videoFillModeAsString()	Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

VideoAspectRatio

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:

VideoAspectRatio

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:

VideoFillMode

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:

VideoFillMode

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

Specified by:

toBuilder in interface ToCopyableBuilder<GridConfiguration.Builder,GridConfiguration>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo