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
.
The capabilties that you want to update.
Link to this section Functions
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.
batch_update_attendee_capabilities_except(client, meeting_id, input, options \\ [])
View SourceUpdates 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 toSendReceive
orReceive
unless you also setvideo
capabilities toSendReceive
orReceive
. If you don't set thevideo
capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideo
capability to receive and you set yourcontent
capability to not receive.When you change an
audio
capability fromNone
orReceive
toSend
orSendReceive
, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.When you change a
video
orcontent
capability fromNone
orReceive
toSend
orSendReceive
, 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.
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.
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.
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.
delete_attendee(client, attendee_id, meeting_id, input, options \\ [])
View SourceDeletes 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.
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.
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.
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.
list_attendees(client, meeting_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists 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.
start_meeting_transcription(client, meeting_id, input, options \\ [])
View SourceStarts transcription for the specified meetingId
.
stop_meeting_transcription(client, meeting_id, input, options \\ [])
View SourceStops transcription for the specified meetingId
.
update_attendee_capabilities(client, attendee_id, meeting_id, input, options \\ [])
View SourceThe 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 toSendReceive
orReceive
unless you also setvideo
capabilities toSendReceive
orReceive
. If you don't set thevideo
capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideo
capability to receive and you set yourcontent
capability to not receive.When you change an
audio
capability fromNone
orReceive
toSend
orSendReceive
, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.When you change a
video
orcontent
capability fromNone
orReceive
toSend
orSendReceive
, 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.