@Generated(value="software.amazon.awssdk:codegen") public interface KinesisVideoSignalingAsyncClient extends 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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static KinesisVideoSignalingAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
KinesisVideoSignalingAsyncClient . |
static KinesisVideoSignalingAsyncClient |
create()
Create a
KinesisVideoSignalingAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<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 CompletableFuture<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 CompletableFuture<SendAlexaOfferToMasterResponse> |
sendAlexaOfferToMaster(Consumer<SendAlexaOfferToMasterRequest.Builder> sendAlexaOfferToMasterRequest)
This API allows you to connect WebRTC-enabled devices with Alexa display devices.
|
default CompletableFuture<SendAlexaOfferToMasterResponse> |
sendAlexaOfferToMaster(SendAlexaOfferToMasterRequest sendAlexaOfferToMasterRequest)
This API allows you to connect WebRTC-enabled devices with Alexa display devices.
|
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static KinesisVideoSignalingAsyncClient create()
KinesisVideoSignalingAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static KinesisVideoSignalingAsyncClientBuilder builder()
KinesisVideoSignalingAsyncClient
.default CompletableFuture<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. 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.
getIceServerConfigRequest
- default CompletableFuture<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. 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 via GetIceServerConfigRequest.builder()
getIceServerConfigRequest
- A Consumer
that will call methods on GetIceServerConfigRequest.Builder
to create a
request.default CompletableFuture<SendAlexaOfferToMasterResponse> sendAlexaOfferToMaster(SendAlexaOfferToMasterRequest sendAlexaOfferToMasterRequest)
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.
sendAlexaOfferToMasterRequest
- default CompletableFuture<SendAlexaOfferToMasterResponse> sendAlexaOfferToMaster(Consumer<SendAlexaOfferToMasterRequest.Builder> sendAlexaOfferToMasterRequest)
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 via SendAlexaOfferToMasterRequest.builder()
sendAlexaOfferToMasterRequest
- A Consumer
that will call methods on SendAlexaOfferToMasterRequest.Builder
to create a
request.