kinesisvideosignaling/aws.sdk.kotlin.services.kinesisvideosignaling

Package-level declarations

Types

interface KinesisVideoSignalingClient : SdkClient

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

getIceServerConfig

inline suspend fun KinesisVideoSignalingClient.getIceServerConfig(crossinline block: GetIceServerConfigRequest.Builder.() -> Unit): GetIceServerConfigResponse

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.

sendAlexaOfferToMaster

inline suspend fun KinesisVideoSignalingClient.sendAlexaOfferToMaster(crossinline block: SendAlexaOfferToMasterRequest.Builder.() -> Unit): SendAlexaOfferToMasterResponse

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.

withConfig

fun KinesisVideoSignalingClient.withConfig(block: KinesisVideoSignalingClient.Config.Builder.() -> Unit): KinesisVideoSignalingClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.