createAttendee method

Future<CreateAttendeeResponse> createAttendee({
  1. required String externalUserId,
  2. required String meetingId,
  3. AttendeeCapabilities? capabilities,
})

Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

May throw BadRequestException. May throw ForbiddenException. May throw LimitExceededException. May throw NotFoundException. May throw ServiceFailureException. May throw ServiceUnavailableException. May throw ThrottlingException. May throw UnauthorizedException. May throw UnprocessableEntityException.

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

Parameter meetingId : The unique ID of the meeting.

Parameter 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. 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.
  • If meeting features is defined as Video:MaxResolution:None but Content:MaxResolution is defined as something other than None and attendee capabilities are not defined in the API request, then the default attendee video capability is set to Receive and attendee content capability is set to SendReceive. This is because content SendReceive requires video to be at least 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.

Implementation

Future<CreateAttendeeResponse> createAttendee({
  required String externalUserId,
  required String meetingId,
  AttendeeCapabilities? capabilities,
}) async {
  final $payload = <String, dynamic>{
    'ExternalUserId': externalUserId,
    if (capabilities != null) 'Capabilities': capabilities,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/meetings/${Uri.encodeComponent(meetingId)}/attendees',
    exceptionFnMap: _exceptionFns,
  );
  return CreateAttendeeResponse.fromJson(response);
}