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:

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

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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<PipConfiguration.Builder,PipConfiguration>
      Returns:
      a builder for type T

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