Byn.Awrtc.NetworkConfig Class Reference

Contains information about how to setup webrtc. SignalingUrl must be set otherwise connections won't be possible. You should also at least add a single stun server to IceServers if you want to be able to connect to devices outside your local LAN / WIFI. More...

Public Member Functions
override string	ToString ()
	Converts the NetworkConfig into a string used for debugging.
virtual void	CopyFrom (NetworkConfig config)
	Copies each member. Supports partial copies from base classes. Override to add support for subclasses.

Protected Member Functions
virtual void	ToStringBase (StringBuilder sb)
	To string supporting base and sub classes.

Properties
List< IceServer >	IceServers [get, set]
	New place to setup stun and turn servers. Unlike the old version it allows to set username and password for secure connections.
string	SignalingUrl [get, set]
	Server used to find the other peer based on a given string.
bool	IsConference [get, set]
	Set true to set the call object to conference mode. This prepares the ICall or INetwork instance to handle multiple parallel connections.
bool	KeepSignalingAlive [get, set]
	Set to true to:
int	MaxIceRestart [get, set]
	Number of reconnect attempts until a disconnected event is triggered Only works if the signaling connection remains active (KeepSignalingAlive = true) If KeepSignalingAlive == false this value is always 0. Default is 0 (no ice restart)

Detailed Description

Contains information about how to setup webrtc. SignalingUrl must be set otherwise connections won't be possible. You should also at least add a single stun server to IceServers if you want to be able to connect to devices outside your local LAN / WIFI.

Member Function Documentation

CopyFrom()

virtual void Byn.Awrtc.NetworkConfig.CopyFrom ( NetworkConfig config )

virtual

Copies each member. Supports partial copies from base classes. Override to add support for subclasses.

Parameters

config

ToString()

override string Byn.Awrtc.NetworkConfig.ToString

(

)

Converts the NetworkConfig into a string used for debugging.

Returns

Property Documentation

IsConference

bool Byn.Awrtc.NetworkConfig.IsConference

getset

Set true to set the call object to conference mode. This prepares the ICall or INetwork instance to handle multiple parallel connections.

If set to false ICall based applications will automatically block new incoming connections once the first successful peer to peer connection is established.

KeepSignalingAlive

bool Byn.Awrtc.NetworkConfig.KeepSignalingAlive

getset

Set to true to:

• keep the signaling connection alive even after the direct connection is established
• allow for renegotiation of the direct peer connection if needed
• allow for ice restart if needed
• this causes the lifetime of the peer connection to depend on the signaling server connection If the server connection dies it will cut the peer connection as well. This allows the server to fully control the peer connections by opening / closing the attached signaling connection.

Set to false to:

• Cut the signaling connection once the peer connected to reduce load on the signaling server

Default is false.

SignalingUrl

string Byn.Awrtc.NetworkConfig.SignalingUrl

getset

Server used to find the other peer based on a given string.

Leave empty to use a default server (development only!).

Setting this value to null will turn on the test mode! Instead of using a signaling server the network will be simulated locally (program wide only)

---

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

• /Volumes/macdev/wrtc/main_new/awrtc/awrtc_cs_common/Byn.Awrtc/NetworkConfig.cs