Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
Documentation
An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId
and
JoinToken
. The JoinToken
allows a client to authenticate and join as
the specified attendee. The JoinToken
expires when the meeting ends,
or when DeleteAttendee is called. After that, the attendee is unable to
join the meeting.
We recommend securely transferring each JoinToken
from your server
application to the client so that no other client has access to the
token except for the one authorized to represent the attendee.
See: newAttendee
smart constructor.
Attendee' | |
|
Instances
newAttendee :: Attendee Source #
Create a value of Attendee
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attendeeId:Attendee'
, attendee_attendeeId
- The Amazon Chime SDK attendee ID.
$sel:capabilities:Attendee'
, attendee_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:
- 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.
$sel:externalUserId:Attendee'
, attendee_externalUserId
- The Amazon Chime SDK external user ID. An idempotency token. Links the
attendee to an identity managed by a builder application.
$sel:joinToken:Attendee'
, attendee_joinToken
- The join token used by the Amazon Chime SDK attendee.
attendee_capabilities :: Lens' Attendee (Maybe AttendeeCapabilities) Source #
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:
- 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.