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

Class PipConfiguration

java.lang.Object

software.amazon.awssdk.services.ivsrealtime.model.PipConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PipConfiguration.Builder,PipConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class PipConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PipConfiguration.Builder,PipConfiguration>

Configuration information specific to Picture-in-Picture (PiP) layout, for server-side composition.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PipConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static PipConfiguration.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.
PipBehavior	pipBehavior()	Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition).
String	pipBehaviorAsString()	Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition).
Integer	pipHeight()	Specifies the height of the PiP window in pixels.
Integer	pipOffset()	Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition.
String	pipParticipantAttribute()	Specifies the participant for the PiP window.
PipPosition	pipPosition()	Determines the corner position of the PiP window.
String	pipPositionAsString()	Determines the corner position of the PiP window.
Integer	pipWidth()	Specifies the width of the PiP window in pixels.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PipConfiguration.Builder>	serializableBuilderClass()
PipConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
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.

videoFillMode

public final VideoFillMode videoFillMode()

Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.

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). Default: COVER.

See Also:

VideoFillMode

videoFillModeAsString

public final String videoFillModeAsString()

Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.

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). Default: COVER.

See Also:

VideoFillMode

gridGap

public final Integer gridGap()

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

Returns:

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

pipParticipantAttribute

public final String pipParticipantAttribute()

Specifies the participant for the PiP window. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot. Default: "" (no PiP participant).

Returns:

Specifies the participant for the PiP window. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot. Default: "" (no PiP participant).

pipBehavior

public final PipBehavior pipBehavior()

Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.

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

Returns:

Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.

See Also:

PipBehavior

pipBehaviorAsString

public final String pipBehaviorAsString()

Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.

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

Returns:

Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.

See Also:

PipBehavior

pipOffset

public final Integer pipOffset()

Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.

Returns:

Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.

pipPosition

public final PipPosition pipPosition()

Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.

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

Returns:

Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.

See Also:

PipPosition

pipPositionAsString

public final String pipPositionAsString()

Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.

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

Returns:

Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.

See Also:

PipPosition

pipWidth

public final Integer pipWidth()

Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

Returns:

Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

pipHeight

public final Integer pipHeight()

Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

Returns:

Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight ’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

toBuilder

public PipConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PipConfiguration.Builder,PipConfiguration>

builder

public static PipConfiguration.Builder builder()

serializableBuilderClass

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