GetIceServerConfig

$result = $client->getIceServerConfig([/* ... */]);
$promise = $client->getIceServerConfigAsync([/* ... */]);

Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, username, and password which can be used to configure the WebRTC connection. The ICE component uses this configuration information to setup the WebRTC connection, including authenticating with the Traversal Using Relays around NAT (TURN) relay server.

TURN is a protocol that is used to improve the connectivity of peer-to-peer applications. By providing a cloud-based relay service, TURN ensures that a connection can be established even when one or more peers are incapable of a direct peer-to-peer connection. For more information, see A REST API For Access To TURN Services.

You can invoke this API to establish a fallback mechanism in case either of the peers is unable to establish a direct peer-to-peer connection over a signaling channel. You must specify either a signaling channel ARN or the client ID in order to invoke this API.

Parameter Syntax

$result = $client->getIceServerConfig([
    'ChannelARN' => '<string>', // REQUIRED
    'ClientId' => '<string>',
    'Service' => 'TURN',
    'Username' => '<string>',
]);

Parameter Details

Result Syntax

[
    'IceServerList' => [
        [
            'Password' => '<string>',
            'Ttl' => <integer>,
            'Uris' => ['<string>', ...],
            'Username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidClientException:

The specified client is invalid.

SessionExpiredException:

If the client session is expired. Once the client is connected, the session is valid for 45 minutes. Client should reconnect to the channel to continue sending/receiving messages.

ClientLimitExceededException:

Your request was throttled because you have exceeded the limit of allowed client calls. Try making the call later.

ResourceNotFoundException:

The specified resource is not found.

InvalidArgumentException:

The value for this input parameter is invalid.

NotAuthorizedException:

The caller is not authorized to perform this operation.

SendAlexaOfferToMaster

$result = $client->sendAlexaOfferToMaster([/* ... */]);
$promise = $client->sendAlexaOfferToMasterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->sendAlexaOfferToMaster([
    'ChannelARN' => '<string>', // REQUIRED
    'MessagePayload' => '<string>', // REQUIRED
    'SenderClientId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Answer' => '<string>',
]

Result Details

Errors

ClientLimitExceededException:

Your request was throttled because you have exceeded the limit of allowed client calls. Try making the call later.

ResourceNotFoundException:

The specified resource is not found.

InvalidArgumentException:

The value for this input parameter is invalid.

NotAuthorizedException:

The caller is not authorized to perform this operation.