Table of Contents
KinesisVideoSignalingChannels.Client¶A low-level client representing Amazon Kinesis Video Signaling Channels
Kinesis Video Streams Signaling Service is a intermediate service that establishes a communication channel for discovering peers, transmitting offers and answers in order to establish peer-to-peer connection in webRTC technology.
import boto3
client = boto3.client('kinesis-video-signaling')
These are the available methods:
can_paginate()close()get_ice_server_config()get_paginator()get_waiter()send_alexa_offer_to_master()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
get_ice_server_config(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.get_ice_server_config(
ChannelARN='string',
ClientId='string',
Service='TURN',
Username='string'
)
[REQUIRED]
The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.
TURN is the only valid value.dict
Response Syntax
{
'IceServerList': [
{
'Uris': [
'string',
],
'Username': 'string',
'Password': 'string',
'Ttl': 123
},
]
}
Response Structure
(dict) --
IceServerList (list) --
The list of ICE server information objects.
(dict) --
A structure for the ICE server connection data.
Uris (list) --
An array of URIs, in the form specified in the I-D.petithuguenin-behave-turn-uris spec. These URIs provide the different addresses and/or protocols that can be used to reach the TURN server.
Username (string) --
A username to login to the ICE server.
Password (string) --
A password to login to the ICE server.
Ttl (integer) --
The period of time, in seconds, during which the username and password are valid.
Exceptions
KinesisVideoSignalingChannels.Client.exceptions.InvalidClientExceptionKinesisVideoSignalingChannels.Client.exceptions.SessionExpiredExceptionKinesisVideoSignalingChannels.Client.exceptions.ClientLimitExceededExceptionKinesisVideoSignalingChannels.Client.exceptions.ResourceNotFoundExceptionKinesisVideoSignalingChannels.Client.exceptions.InvalidArgumentExceptionKinesisVideoSignalingChannels.Client.exceptions.NotAuthorizedExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
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'
)
[REQUIRED]
The ARN of the signaling channel by which Alexa and the master peer communicate.
[REQUIRED]
The unique identifier for the sender client.
[REQUIRED]
The base64-encoded SDP offer content.
dict
Response Syntax
{
'Answer': 'string'
}
Response Structure
(dict) --
Answer (string) --
The base64-encoded SDP answer content.
Exceptions
KinesisVideoSignalingChannels.Client.exceptions.ClientLimitExceededExceptionKinesisVideoSignalingChannels.Client.exceptions.ResourceNotFoundExceptionKinesisVideoSignalingChannels.Client.exceptions.InvalidArgumentExceptionKinesisVideoSignalingChannels.Client.exceptions.NotAuthorizedExceptionThe available paginators are: