OpenTok.IceConfig Class Reference

A class for setting custom ICE configuration. More...

Public Member Functions
	IceConfig (List< IceServer > customIceServers, bool forceTurn, ICEIncludeServers includeServers)
	The constructor for IceConfig object passed to the Session.Builder IceConfig property. More...
override string	ToString ()

Properties
List< IceServer >	CustomIceServers [get, set]
bool	ForceTurn [get, set]
ICEIncludeServers	IncludeServers [get, set]

Detailed Description

A class for setting custom ICE configuration.

This is used for the configurable TURN feature. Pass this to the Session.Builder IceConfig property.

Constructor & Destructor Documentation

IceConfig()

OpenTok.IceConfig.IceConfig	(	List< IceServer >	customIceServers,
		bool	forceTurn,
		ICEIncludeServers	includeServers
	)

The constructor for IceConfig object passed to the Session.Builder IceConfig property.

Parameters

customIceServers	A list of IceServer objects, representing custom TURN servers to be used by the client. IceServer
forceTurn	Whether to use all ICE transport types (such as host, srflx, and TURN) to establish media connectivity or to only use TURN. ICETransport
includeServers	Whether to use only the custom servers or both OpenTok servers and the custom servers. ICEIncludeServers

Property Documentation

CustomIceServers

List<IceServer> OpenTok.IceConfig.CustomIceServers

getset

The list of IceServer objects, representing custom TURN servers to be used by the client.

IncludeServers

ICEIncludeServers OpenTok.IceConfig.IncludeServers

getset

Whether to use only the custom servers or both OpenTok servers and the custom servers.

---