| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.KinesisVideoSignaling.SendAlexaOfferToMaster
Description
This API allows you to connect WebRTC-enabled devices with Alexa display devices. When invoked, it sends the Alexa Session Description Protocol (SDP) offer to the master peer. The offer is delivered as soon as the master is connected to the specified signaling channel. This API returns the SDP answer from the connected master. If the master is not connected to the signaling channel, redelivery requests are made until the message expires.
Synopsis
- data SendAlexaOfferToMaster = SendAlexaOfferToMaster' {}
- newSendAlexaOfferToMaster :: Text -> Text -> Text -> SendAlexaOfferToMaster
- sendAlexaOfferToMaster_channelARN :: Lens' SendAlexaOfferToMaster Text
- sendAlexaOfferToMaster_senderClientId :: Lens' SendAlexaOfferToMaster Text
- sendAlexaOfferToMaster_messagePayload :: Lens' SendAlexaOfferToMaster Text
- data SendAlexaOfferToMasterResponse = SendAlexaOfferToMasterResponse' {
- answer :: Maybe Text
- httpStatus :: Int
- newSendAlexaOfferToMasterResponse :: Int -> SendAlexaOfferToMasterResponse
- sendAlexaOfferToMasterResponse_answer :: Lens' SendAlexaOfferToMasterResponse (Maybe Text)
- sendAlexaOfferToMasterResponse_httpStatus :: Lens' SendAlexaOfferToMasterResponse Int
Creating a Request
data SendAlexaOfferToMaster Source #
See: newSendAlexaOfferToMaster smart constructor.
Constructors
| SendAlexaOfferToMaster' | |
Fields
| |
Instances
newSendAlexaOfferToMaster Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> SendAlexaOfferToMaster |
Create a value of SendAlexaOfferToMaster 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:channelARN:SendAlexaOfferToMaster', sendAlexaOfferToMaster_channelARN - The ARN of the signaling channel by which Alexa and the master peer
communicate.
$sel:senderClientId:SendAlexaOfferToMaster', sendAlexaOfferToMaster_senderClientId - The unique identifier for the sender client.
$sel:messagePayload:SendAlexaOfferToMaster', sendAlexaOfferToMaster_messagePayload - The base64-encoded SDP offer content.
Request Lenses
sendAlexaOfferToMaster_channelARN :: Lens' SendAlexaOfferToMaster Text Source #
The ARN of the signaling channel by which Alexa and the master peer communicate.
sendAlexaOfferToMaster_senderClientId :: Lens' SendAlexaOfferToMaster Text Source #
The unique identifier for the sender client.
sendAlexaOfferToMaster_messagePayload :: Lens' SendAlexaOfferToMaster Text Source #
The base64-encoded SDP offer content.
Destructuring the Response
data SendAlexaOfferToMasterResponse Source #
See: newSendAlexaOfferToMasterResponse smart constructor.
Constructors
| SendAlexaOfferToMasterResponse' | |
Fields
| |
Instances
newSendAlexaOfferToMasterResponse Source #
Create a value of SendAlexaOfferToMasterResponse 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:answer:SendAlexaOfferToMasterResponse', sendAlexaOfferToMasterResponse_answer - The base64-encoded SDP answer content.
$sel:httpStatus:SendAlexaOfferToMasterResponse', sendAlexaOfferToMasterResponse_httpStatus - The response's http status code.
Response Lenses
sendAlexaOfferToMasterResponse_answer :: Lens' SendAlexaOfferToMasterResponse (Maybe Text) Source #
The base64-encoded SDP answer content.
sendAlexaOfferToMasterResponse_httpStatus :: Lens' SendAlexaOfferToMasterResponse Int Source #
The response's http status code.