Interface KinesisVideoSignalingClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aKinesisVideoSignalingClient
.static KinesisVideoSignalingClient
create()
Create aKinesisVideoSignalingClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default GetIceServerConfigResponse
getIceServerConfig
(Consumer<GetIceServerConfigRequest.Builder> getIceServerConfigRequest) Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, username, and password which can be used to configure the WebRTC connection.default GetIceServerConfigResponse
getIceServerConfig
(GetIceServerConfigRequest getIceServerConfigRequest) Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, username, and password which can be used to configure the WebRTC connection.default SendAlexaOfferToMasterResponse
sendAlexaOfferToMaster
(Consumer<SendAlexaOfferToMasterRequest.Builder> sendAlexaOfferToMasterRequest) This API allows you to connect WebRTC-enabled devices with Alexa display devices.default SendAlexaOfferToMasterResponse
sendAlexaOfferToMaster
(SendAlexaOfferToMasterRequest sendAlexaOfferToMasterRequest) This API allows you to connect WebRTC-enabled devices with Alexa display devices.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
getIceServerConfig
default GetIceServerConfigResponse getIceServerConfig(GetIceServerConfigRequest getIceServerConfigRequest) throws InvalidClientException, SessionExpiredException, ClientLimitExceededException, ResourceNotFoundException, InvalidArgumentException, NotAuthorizedException, AwsServiceException, SdkClientException, KinesisVideoSignalingException 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.
- Parameters:
getIceServerConfigRequest
-- Returns:
- Result of the GetIceServerConfig operation returned by the service.
- See Also:
-
getIceServerConfig
default GetIceServerConfigResponse getIceServerConfig(Consumer<GetIceServerConfigRequest.Builder> getIceServerConfigRequest) throws InvalidClientException, SessionExpiredException, ClientLimitExceededException, ResourceNotFoundException, InvalidArgumentException, NotAuthorizedException, AwsServiceException, SdkClientException, KinesisVideoSignalingException 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.
This is a convenience which creates an instance of the
GetIceServerConfigRequest.Builder
avoiding the need to create one manually viaGetIceServerConfigRequest.builder()
- Parameters:
getIceServerConfigRequest
- AConsumer
that will call methods onGetIceServerConfigRequest.Builder
to create a request.- Returns:
- Result of the GetIceServerConfig operation returned by the service.
- See Also:
-
sendAlexaOfferToMaster
default SendAlexaOfferToMasterResponse sendAlexaOfferToMaster(SendAlexaOfferToMasterRequest sendAlexaOfferToMasterRequest) throws ClientLimitExceededException, ResourceNotFoundException, InvalidArgumentException, NotAuthorizedException, AwsServiceException, SdkClientException, KinesisVideoSignalingException 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.
- Parameters:
sendAlexaOfferToMasterRequest
-- Returns:
- Result of the SendAlexaOfferToMaster operation returned by the service.
- See Also:
-
sendAlexaOfferToMaster
default SendAlexaOfferToMasterResponse sendAlexaOfferToMaster(Consumer<SendAlexaOfferToMasterRequest.Builder> sendAlexaOfferToMasterRequest) throws ClientLimitExceededException, ResourceNotFoundException, InvalidArgumentException, NotAuthorizedException, AwsServiceException, SdkClientException, KinesisVideoSignalingException 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.
This is a convenience which creates an instance of the
SendAlexaOfferToMasterRequest.Builder
avoiding the need to create one manually viaSendAlexaOfferToMasterRequest.builder()
- Parameters:
sendAlexaOfferToMasterRequest
- AConsumer
that will call methods onSendAlexaOfferToMasterRequest.Builder
to create a request.- Returns:
- Result of the SendAlexaOfferToMaster operation returned by the service.
- See Also:
-
create
Create aKinesisVideoSignalingClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aKinesisVideoSignalingClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-