OpenTok Windows SDK
Public Member Functions | Properties | List of all members
OpenTok.IceConfig Class Reference

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

Public Member Functions

 IceConfig (List< IceServer > customIceServers, ICETransport transportPolicy, ICEIncludeServers includeServers)
 The constructor for IceConfig object passed into the OpenTok.Session.Session(Context, string, string, bool, Uri, bool, Uri, IceConfig) constructor. More...
 
override string ToString ()
 

Properties

List< IceServerCustomIceServers [get, set]
 
ICETransport TransportPolicy [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 in as the iceConfig parameter of the OpenTok.Session.Session(Context, string, string, bool, Uri, bool, Uri, IceConfig) constructor.

Constructor & Destructor Documentation

◆ IceConfig()

OpenTok.IceConfig.IceConfig ( List< IceServer customIceServers,
ICETransport  transportPolicy,
ICEIncludeServers  includeServers 
)

The constructor for IceConfig object passed into the OpenTok.Session.Session(Context, string, string, bool, Uri, bool, Uri, IceConfig) constructor.

Parameters
customIceServersA list of IceServer objects, representing custom TURN servers to be used by the client. IceServer
transportPolicyWhether to use all ICE transport types (such as host, srflx, and TURN) to establish media connectivity or to only use TURN. <see cref="ICETransport"
includeServersWhether to use only the custom servers or both OpenTok servers and the custom servers. <see cref="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.

◆ TransportPolicy

ICETransport OpenTok.IceConfig.TransportPolicy
getset

Whether to use all ICE transport types (such as host, srflx, and TURN) to establish media connectivity or to only use TURN.


The documentation for this class was generated from the following file: