public static interface CreateAttendeeRequest.Builder extends ChimeSdkMeetingsRequest.Builder, SdkPojo, CopyableBuilder<CreateAttendeeRequest.Builder,CreateAttendeeRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateAttendeeRequest.Builder |
capabilities(AttendeeCapabilities capabilities)
The capabilities (
audio, video, or content) that you want to grant an
attendee. |
default CreateAttendeeRequest.Builder |
capabilities(Consumer<AttendeeCapabilities.Builder> capabilities)
The capabilities (
audio, video, or content) that you want to grant an
attendee. |
CreateAttendeeRequest.Builder |
externalUserId(String externalUserId)
The Amazon Chime SDK external user ID.
|
CreateAttendeeRequest.Builder |
meetingId(String meetingId)
The unique ID of the meeting.
|
CreateAttendeeRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateAttendeeRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateAttendeeRequest.Builder meetingId(String meetingId)
The unique ID of the meeting.
meetingId - The unique ID of the meeting.CreateAttendeeRequest.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.
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.
CreateAttendeeRequest.Builder capabilities(AttendeeCapabilities capabilities)
The capabilities (audio, video, or content) that you want to grant an
attendee. If you don't specify capabilities, all users have send and receive capabilities on all media
channels by default.
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:
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.
capabilities - The capabilities (audio, video, or content) that you want to
grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on
all media channels by default.
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:
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.
default CreateAttendeeRequest.Builder capabilities(Consumer<AttendeeCapabilities.Builder> capabilities)
The capabilities (audio, video, or content) that you want to grant an
attendee. If you don't specify capabilities, all users have send and receive capabilities on all media
channels by default.
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:
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.
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).
capabilities - a consumer that will call methods on AttendeeCapabilities.Buildercapabilities(AttendeeCapabilities)CreateAttendeeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateAttendeeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.