KinesisVideoSignalingChannels / Client / send_alexa_offer_to_master

send_alexa_offer_to_master#

KinesisVideoSignalingChannels.Client.send_alexa_offer_to_master(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.send_alexa_offer_to_master(
    ChannelARN='string',
    SenderClientId='string',
    MessagePayload='string'
)
Parameters:

  • ChannelARN (string) –

    [REQUIRED]

    The ARN of the signaling channel by which Alexa and the master peer communicate.

  • SenderClientId (string) –

    [REQUIRED]

    The unique identifier for the sender client.

  • MessagePayload (string) –

    [REQUIRED]

    The base64-encoded SDP offer content.

Return type:

dict

Returns:

Response Syntax

{
    'Answer': 'string'
}

Response Structure

  • (dict) –

    • Answer (string) –

      The base64-encoded SDP answer content.

Exceptions

  • KinesisVideoSignalingChannels.Client.exceptions.ClientLimitExceededException

  • KinesisVideoSignalingChannels.Client.exceptions.ResourceNotFoundException

  • KinesisVideoSignalingChannels.Client.exceptions.InvalidArgumentException

  • KinesisVideoSignalingChannels.Client.exceptions.NotAuthorizedException