Package software.amazon.awssdk.services.chimesdkmeetings.model

Interface Attendee.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Attendee.Builder,Attendee>, SdkBuilder<Attendee.Builder,Attendee>, SdkPojo
Enclosing class:
Attendee
public static interface Attendee.Builder extends SdkPojo, CopyableBuilder<Attendee.Builder,Attendee>

  • Method Details

    • externalUserId

      Attendee.Builder externalUserId(String externalUserId)

      The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

      Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

      Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

      Parameters:
      externalUserId - The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

      Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

      Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attendeeId

      Attendee.Builder attendeeId(String attendeeId)

      The Amazon Chime SDK attendee ID.

      Parameters:
      attendeeId - The Amazon Chime SDK attendee ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • joinToken

      Attendee.Builder joinToken(String joinToken)

      The join token used by the Amazon Chime SDK attendee.

      Parameters:
      joinToken - The join token used by the Amazon Chime SDK attendee.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilities

      Attendee.Builder capabilities(AttendeeCapabilities capabilities)

      The capabilities assigned to an attendee: audio, video, or content.

      You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

      When using capabilities, be aware of these corner cases:

      • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

      • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

      • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

      • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

      • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

      Parameters:
      capabilities - The capabilities assigned to an attendee: audio, video, or content.

      You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

      When using capabilities, be aware of these corner cases:

      • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

      • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

      • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

      • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

      • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilities

      default Attendee.Builder capabilities(Consumer<AttendeeCapabilities.Builder> capabilities)

      The capabilities assigned to an attendee: audio, video, or content.

      You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

      When using capabilities, be aware of these corner cases:

      • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

      • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

      • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

      • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

      • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

      This is a convenience method that creates an instance of the AttendeeCapabilities.Builder avoiding the need to create one manually via AttendeeCapabilities.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capabilities(AttendeeCapabilities).

      Parameters:
      capabilities - a consumer that will call methods on AttendeeCapabilities.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: