/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace KinesisVideoSignalingChannels { /** *

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.

*/ class AWS_KINESISVIDEOSIGNALINGCHANNELS_API KinesisVideoSignalingChannelsClient : public Aws::Client::AWSJsonClient, public Aws::Client::ClientWithAsyncTemplateMethods { public: typedef Aws::Client::AWSJsonClient BASECLASS; static const char* SERVICE_NAME; static const char* ALLOCATION_TAG; typedef KinesisVideoSignalingChannelsClientConfiguration ClientConfigurationType; typedef KinesisVideoSignalingChannelsEndpointProvider EndpointProviderType; /** * Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config * is not specified, it will be initialized to default values. */ KinesisVideoSignalingChannelsClient(const Aws::KinesisVideoSignalingChannels::KinesisVideoSignalingChannelsClientConfiguration& clientConfiguration = Aws::KinesisVideoSignalingChannels::KinesisVideoSignalingChannelsClientConfiguration(), std::shared_ptr endpointProvider = Aws::MakeShared(ALLOCATION_TAG)); /** * Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config * is not specified, it will be initialized to default values. */ KinesisVideoSignalingChannelsClient(const Aws::Auth::AWSCredentials& credentials, std::shared_ptr endpointProvider = Aws::MakeShared(ALLOCATION_TAG), const Aws::KinesisVideoSignalingChannels::KinesisVideoSignalingChannelsClientConfiguration& clientConfiguration = Aws::KinesisVideoSignalingChannels::KinesisVideoSignalingChannelsClientConfiguration()); /** * Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, * the default http client factory will be used */ KinesisVideoSignalingChannelsClient(const std::shared_ptr& credentialsProvider, std::shared_ptr endpointProvider = Aws::MakeShared(ALLOCATION_TAG), const Aws::KinesisVideoSignalingChannels::KinesisVideoSignalingChannelsClientConfiguration& clientConfiguration = Aws::KinesisVideoSignalingChannels::KinesisVideoSignalingChannelsClientConfiguration()); /* Legacy constructors due deprecation */ /** * Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config * is not specified, it will be initialized to default values. */ KinesisVideoSignalingChannelsClient(const Aws::Client::ClientConfiguration& clientConfiguration); /** * Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config * is not specified, it will be initialized to default values. */ KinesisVideoSignalingChannelsClient(const Aws::Auth::AWSCredentials& credentials, const Aws::Client::ClientConfiguration& clientConfiguration); /** * Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, * the default http client factory will be used */ KinesisVideoSignalingChannelsClient(const std::shared_ptr& credentialsProvider, const Aws::Client::ClientConfiguration& clientConfiguration); /* End of legacy constructors due deprecation */ virtual ~KinesisVideoSignalingChannelsClient(); /** *

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 Reference

*/ virtual Model::GetIceServerConfigOutcome GetIceServerConfig(const Model::GetIceServerConfigRequest& request) const; /** * A Callable wrapper for GetIceServerConfig that returns a future to the operation so that it can be executed in parallel to other requests. */ template Model::GetIceServerConfigOutcomeCallable GetIceServerConfigCallable(const GetIceServerConfigRequestT& request) const { return SubmitCallable(&KinesisVideoSignalingChannelsClient::GetIceServerConfig, request); } /** * An Async wrapper for GetIceServerConfig that queues the request into a thread executor and triggers associated callback when operation has finished. */ template void GetIceServerConfigAsync(const GetIceServerConfigRequestT& request, const GetIceServerConfigResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const { return SubmitAsync(&KinesisVideoSignalingChannelsClient::GetIceServerConfig, request, handler, context); } /** *

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 Reference

*/ virtual Model::SendAlexaOfferToMasterOutcome SendAlexaOfferToMaster(const Model::SendAlexaOfferToMasterRequest& request) const; /** * A Callable wrapper for SendAlexaOfferToMaster that returns a future to the operation so that it can be executed in parallel to other requests. */ template Model::SendAlexaOfferToMasterOutcomeCallable SendAlexaOfferToMasterCallable(const SendAlexaOfferToMasterRequestT& request) const { return SubmitCallable(&KinesisVideoSignalingChannelsClient::SendAlexaOfferToMaster, request); } /** * An Async wrapper for SendAlexaOfferToMaster that queues the request into a thread executor and triggers associated callback when operation has finished. */ template void SendAlexaOfferToMasterAsync(const SendAlexaOfferToMasterRequestT& request, const SendAlexaOfferToMasterResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const { return SubmitAsync(&KinesisVideoSignalingChannelsClient::SendAlexaOfferToMaster, request, handler, context); } void OverrideEndpoint(const Aws::String& endpoint); std::shared_ptr& accessEndpointProvider(); private: friend class Aws::Client::ClientWithAsyncTemplateMethods; void init(const KinesisVideoSignalingChannelsClientConfiguration& clientConfiguration); KinesisVideoSignalingChannelsClientConfiguration m_clientConfiguration; std::shared_ptr m_executor; std::shared_ptr m_endpointProvider; }; } // namespace KinesisVideoSignalingChannels } // namespace Aws