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

Interface GridConfiguration.Builder

    • Method Detail

      • featuredParticipantAttribute

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

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

      • videoAspectRatio

        GridConfiguration.Builder videoAspectRatio​(String 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.

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

      • videoAspectRatio

        GridConfiguration.Builder videoAspectRatio​(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.

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

      • videoFillMode

        GridConfiguration.Builder videoFillMode​(String 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.

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

      • videoFillMode

        GridConfiguration.Builder videoFillMode​(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.

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

      • gridGap

        GridConfiguration.Builder gridGap​(Integer gridGap)

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

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