/AWS1/CL_KNG=>GETICESERVERCONFIG()¶
About GetIceServerConfig¶
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_CHANNELARN TYPE /AWS1/KNGRESOURCEARN /AWS1/KNGRESOURCEARN¶
The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.
Optional arguments:¶
IV_CLIENTID TYPE /AWS1/KNGCLIENTID /AWS1/KNGCLIENTID¶
Unique identifier for the viewer. Must be unique within the signaling channel.
IV_SERVICE TYPE /AWS1/KNGSERVICE /AWS1/KNGSERVICE¶
Specifies the desired service. Currently,
TURNis the only valid value.
IV_USERNAME TYPE /AWS1/KNGUSERNAME /AWS1/KNGUSERNAME¶
An optional user ID to be associated with the credentials.