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.

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

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

      • 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. Default: VIDEO.

        Parameters:
        videoAspectRatio - Sets the non-featured participant display mode. 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. Default: VIDEO.

        Parameters:
        videoAspectRatio - Sets the non-featured participant display mode. 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 fits within the participant tile. 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 fits within the participant tile. 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 fits within the participant tile. 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 fits within the participant tile. 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