/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the kinesis-video-signaling-2019-12-04.normal.json service model.
*/
using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.KinesisVideoSignalingChannels.Model;
namespace Amazon.KinesisVideoSignalingChannels
{
/// <summary>
/// Interface for accessing 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.
/// </summary>
public partial interface IAmazonKinesisVideoSignalingChannels : IAmazonService, IDisposable
{
#region GetIceServerConfig
/// <summary>
/// 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.
///
///
///
/// <para>
/// 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 href="https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00">A
/// REST API For Access To TURN Services</a>.
/// </para>
///
/// <para>
/// 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.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetIceServerConfig service method.</param>
///
/// <returns>The response from the GetIceServerConfig service method, as returned by KinesisVideoSignalingChannels.</returns>
/// <exception cref="Amazon.KinesisVideoSignalingChannels.Model.ClientLimitExceededException">
/// Your request was throttled because you have exceeded the limit of allowed client calls.
/// Try making the call later.
/// </exception>
/// <exception cref="Amazon.KinesisVideoSignalingChannels.Model.InvalidArgumentException">
/// The value for this input parameter is invalid.
/// </exception>
/// <exception cref="Amazon.KinesisVideoSignalingChannels.Model.InvalidClientException">
/// The specified client is invalid.
/// </exception>
/// <exception cref="Amazon.KinesisVideoSignalingChannels.Model.NotAuthorizedException">
/// The caller is not authorized to perform this operation.
/// </exception>
/// <exception cref="Amazon.KinesisVideoSignalingChannels.Model.ResourceNotFoundException">
/// The specified resource is not found.
/// </exception>
/// <exception cref="Amazon.KinesisVideoSignalingChannels.Model.SessionExpiredException">
/// If the client session is expired. Once the client is connected, the session is valid
/// for 45 minutes. Client should reconnect to the channel to continue sending/receiving
/// messages.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/GetIceServerConfig">REST API Reference for GetIceServerConfig Operation</seealso>
GetIceServerConfigResponse GetIceServerConfig(GetIceServerConfigRequest request);
/// <summary>
/// Initiates the asynchronous execution of the GetIceServerConfig operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the GetIceServerConfig operation on AmazonKinesisVideoSignalingChannelsClient.</param>
/// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param>
/// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.</param>
///
/// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetIceServerConfig
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/GetIceServerConfig">REST API Reference for GetIceServerConfig Operation</seealso>
IAsyncResult BeginGetIceServerConfig(GetIceServerConfigRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the GetIceServerConfig operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetIceServerConfig.</param>
///
/// <returns>Returns a GetIceServerConfigResult from KinesisVideoSignalingChannels.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/GetIceServerConfig">REST API Reference for GetIceServerConfig Operation</seealso>
GetIceServerConfigResponse EndGetIceServerConfig(IAsyncResult asyncResult);
#endregion
#region SendAlexaOfferToMaster
/// <summary>
/// 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.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the SendAlexaOfferToMaster service method.</param>
///
/// <returns>The response from the SendAlexaOfferToMaster service method, as returned by KinesisVideoSignalingChannels.</returns>
/// <exception cref="Amazon.KinesisVideoSignalingChannels.Model.ClientLimitExceededException">
/// Your request was throttled because you have exceeded the limit of allowed client calls.
/// Try making the call later.
/// </exception>
/// <exception cref="Amazon.KinesisVideoSignalingChannels.Model.InvalidArgumentException">
/// The value for this input parameter is invalid.
/// </exception>
/// <exception cref="Amazon.KinesisVideoSignalingChannels.Model.NotAuthorizedException">
/// The caller is not authorized to perform this operation.
/// </exception>
/// <exception cref="Amazon.KinesisVideoSignalingChannels.Model.ResourceNotFoundException">
/// The specified resource is not found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster">REST API Reference for SendAlexaOfferToMaster Operation</seealso>
SendAlexaOfferToMasterResponse SendAlexaOfferToMaster(SendAlexaOfferToMasterRequest request);
/// <summary>
/// Initiates the asynchronous execution of the SendAlexaOfferToMaster operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the SendAlexaOfferToMaster operation on AmazonKinesisVideoSignalingChannelsClient.</param>
/// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param>
/// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.</param>
///
/// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSendAlexaOfferToMaster
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster">REST API Reference for SendAlexaOfferToMaster Operation</seealso>
IAsyncResult BeginSendAlexaOfferToMaster(SendAlexaOfferToMasterRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the SendAlexaOfferToMaster operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginSendAlexaOfferToMaster.</param>
///
/// <returns>Returns a SendAlexaOfferToMasterResult from KinesisVideoSignalingChannels.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster">REST API Reference for SendAlexaOfferToMaster Operation</seealso>
SendAlexaOfferToMasterResponse EndSendAlexaOfferToMaster(IAsyncResult asyncResult);
#endregion
}
}