Interface PipConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PipConfiguration.Builder,PipConfiguration>, SdkBuilder<PipConfiguration.Builder,PipConfiguration>, SdkPojo
Enclosing class:
PipConfiguration
@Mutable @NotThreadSafe public static interface PipConfiguration.Builder extends SdkPojo, CopyableBuilder<PipConfiguration.Builder,PipConfiguration>

  • Method Details

    • featuredParticipantAttribute

      PipConfiguration.Builder featuredParticipantAttribute(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).

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • omitStoppedVideo

      PipConfiguration.Builder omitStoppedVideo(Boolean omitStoppedVideo)

      Determines whether to omit participants with stopped video in the composition. Default: false.

      Parameters:
      omitStoppedVideo - Determines whether to omit participants with stopped video in the composition. Default: false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • videoFillMode

      PipConfiguration.Builder videoFillMode(String videoFillMode)

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

      Parameters:
      videoFillMode - Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • videoFillMode

      PipConfiguration.Builder videoFillMode(VideoFillMode videoFillMode)

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

      Parameters:
      videoFillMode - Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • gridGap

      PipConfiguration.Builder gridGap(Integer gridGap)

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

      Parameters:
      gridGap - Specifies the spacing between participant tiles in pixels. Default: 0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pipParticipantAttribute

      PipConfiguration.Builder pipParticipantAttribute(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).

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • pipBehavior

      PipConfiguration.Builder pipBehavior(String pipBehavior)

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

      Parameters:
      pipBehavior - Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pipBehavior

      PipConfiguration.Builder pipBehavior(PipBehavior pipBehavior)

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

      Parameters:
      pipBehavior - Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pipOffset

      PipConfiguration.Builder pipOffset(Integer pipOffset)

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

      Parameters:
      pipOffset - Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pipPosition

      PipConfiguration.Builder pipPosition(String pipPosition)

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

      Parameters:
      pipPosition - Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pipPosition

      PipConfiguration.Builder pipPosition(PipPosition pipPosition)

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

      Parameters:
      pipPosition - Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pipWidth

      PipConfiguration.Builder pipWidth(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • pipHeight

      PipConfiguration.Builder pipHeight(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.