View Source AWS.ChimeSDKMeetings (aws-elixir v0.12.0)

The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications.

For more information about the meeting APIs, see Amazon Chime SDK meetings.

Link to this section Summary

Functions

Creates up to 100 attendees for an active Amazon Chime SDK meeting.

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

Creates a new attendee for an active Amazon Chime SDK meeting.

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken.

Deletes the specified Amazon Chime SDK meeting.

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.

Gets the Amazon Chime SDK meeting details for the specified meeting ID.

Lists the attendees for the specified Amazon Chime SDK meeting.

Starts transcription for the specified meetingId.

Stops transcription for the specified meetingId.

Link to this section Functions

Link to this function

batch_create_attendee(client, meeting_id, input, options \\ [])

View Source

Creates up to 100 attendees 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.

Link to this function

batch_update_attendee_capabilities_except(client, meeting_id, input, options \\ [])

View Source

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

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 attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

Link to this function

create_attendee(client, meeting_id, input, options \\ [])

View Source

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.

Link to this function

create_meeting(client, input, options \\ [])

View Source

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.

For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Link to this function

create_meeting_with_attendees(client, input, options \\ [])

View Source

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.

For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Link to this function

delete_attendee(client, attendee_id, meeting_id, input, options \\ [])

View Source

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken.

Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Link to this function

delete_meeting(client, meeting_id, input, options \\ [])

View Source

Deletes the specified Amazon Chime SDK meeting.

The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Link to this function

get_attendee(client, attendee_id, meeting_id, options \\ [])

View Source

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.

For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Link to this function

get_meeting(client, meeting_id, options \\ [])

View Source

Gets the Amazon Chime SDK meeting details for the specified meeting ID.

For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Link to this function

list_attendees(client, meeting_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the attendees for the specified Amazon Chime SDK meeting.

For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Link to this function

start_meeting_transcription(client, meeting_id, input, options \\ [])

View Source

Starts transcription for the specified meetingId.

Link to this function

stop_meeting_transcription(client, meeting_id, input, options \\ [])

View Source

Stops transcription for the specified meetingId.

Link to this function

update_attendee_capabilities(client, attendee_id, meeting_id, input, options \\ [])

View Source

The capabilties that you want to update.

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 attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.