Interface KinesisVideoSignalingClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface KinesisVideoSignalingClient
extends AwsClient

Service client for accessing Amazon Kinesis Video Signaling Channels. This can be created using the static 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

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static KinesisVideoSignalingClientBuilder	builder()	Create a builder that can be used to configure and create a KinesisVideoSignalingClient.
static KinesisVideoSignalingClient	create()	Create a KinesisVideoSignalingClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
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.
default KinesisVideoSignalingServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	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

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

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:

• AWS API Documentation

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 via GetIceServerConfigRequest.builder()

Parameters:

getIceServerConfigRequest - A Consumer that will call methods on GetIceServerConfigRequest.Builder to create a request.

Returns:

Result of the GetIceServerConfig operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via SendAlexaOfferToMasterRequest.builder()

Parameters:

sendAlexaOfferToMasterRequest - A Consumer that will call methods on SendAlexaOfferToMasterRequest.Builder to create a request.

Returns:

Result of the SendAlexaOfferToMaster operation returned by the service.

See Also:

• AWS API Documentation

create

static KinesisVideoSignalingClient create()

Create a KinesisVideoSignalingClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static KinesisVideoSignalingClientBuilder builder()

Create a builder that can be used to configure and create a KinesisVideoSignalingClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default KinesisVideoSignalingServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration