Liblinphone  5.5.0
Public Member Functions | Properties | List of all members
Linphone.NatPolicy Class Reference
Inheritance diagram for Linphone.NatPolicy:
Linphone.LinphoneObject

Public Member Functions

void Clear ()
 
Linphone.NatPolicy Clone ()
 
void ResolveStunServer ()
 

Properties

Linphone.Core Core [get]
 
bool IceEnabled [get, set]
 
string NatV4Address [get, set]
 
string NatV6Address [get, set]
 
bool StunEnabled [get, set]
 
string StunServer [get, set]
 
string StunServerUsername [get, set]
 
bool TcpTurnTransportEnabled [get, set]
 
bool TlsTurnTransportEnabled [get, set]
 
string TurnConfigurationEndpoint [get, set]
 
bool TurnEnabled [get, set]
 
bool UdpTurnTransportEnabled [get, set]
 
bool UpnpEnabled [get, set]
 

Additional Inherited Members

- Protected Member Functions inherited from Linphone.LinphoneObject
static String linphone_pointer_to_string (IntPtr ptr)
 
static IntPtr linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)
 
IntPtr StringArrayToBctbxList (IEnumerable< string > stringlist)
 
void CleanStringArrayPtrs (IntPtr l)
 

Detailed Description

Policy to use to pass through NATs/firewalls.

Member Function Documentation

void Linphone.NatPolicy.Clear ( )
inline

Clear a NAT policy (deactivate all protocols and unset the STUN server).

Linphone.NatPolicy Linphone.NatPolicy.Clone ( )
inline

Clone an existing Linphone.NatPolicy object.

Returns
A clone of the original Linphone.NatPolicy object.
void Linphone.NatPolicy.ResolveStunServer ( )
inline

Start a STUN server DNS resolution.

Property Documentation

Linphone.Core Linphone.NatPolicy.Core
get

Returns the Linphone.Core object managing this nat policy, if any.

Returns
the Linphone.Core object associated.
bool Linphone.NatPolicy.IceEnabled
getset

Tell whether ICE is enabled.

Returns
Boolean value telling whether ICE is enabled.
string Linphone.NatPolicy.NatV4Address
getset

Get the mandatory v4 IP address to use with this NAT policy as server-reflexive candidate for ICE.

Used when STUN or TURN are enabled.

Returns
the nat v4 address.
string Linphone.NatPolicy.NatV6Address
getset

Get the mandatory v6 IP address to use with this NAT policy as server-reflexive candidate for ICE.

Used when STUN or TURN are enabled.

Returns
the nat v4 address.
bool Linphone.NatPolicy.StunEnabled
getset

Tell whether STUN is enabled.

Returns
Boolean value telling whether STUN is enabled.
string Linphone.NatPolicy.StunServer
getset

Get the STUN/TURN server to use with this NAT policy.

Used when STUN or TURN are enabled.

Returns
The STUN server used by this NAT policy.
string Linphone.NatPolicy.StunServerUsername
getset

Get the username used to authenticate with the STUN/TURN server.

The authentication will search for a Linphone.AuthInfo with this username. If it is not set the username of the currently used Linphone.ProxyConfig is used to search for a LinphoneAuthInfo.

Returns
The username used to authenticate with the STUN/TURN server.
bool Linphone.NatPolicy.TcpTurnTransportEnabled
getset

Tells whether TCP TURN transport is enabled.

Used when TURN is enabled.

Warning : Enabling more than one transport (UDP, TCP, TLS) at a time is currently not supported.

Returns
Boolean value telling whether TCP TURN transport is enabled.
bool Linphone.NatPolicy.TlsTurnTransportEnabled
getset

Tells whether TLS TURN transport is enabled.

Used when TURN is enabled.

Warning : Enabling more than one transport (UDP, TCP, TLS) at a time is currently not supported.

Returns
Boolean value telling whether TLS TURN transport is enabled.
string Linphone.NatPolicy.TurnConfigurationEndpoint
getset

Get the TURN configuration endpoint.

Returns
The TURN configuration endpoint used by this NAT policy.
bool Linphone.NatPolicy.TurnEnabled
getset

Tell whether TURN is enabled.

Returns
Boolean value telling whether TURN is enabled.
bool Linphone.NatPolicy.UdpTurnTransportEnabled
getset

Tells whether UDP TURN transport is enabled.

Used when TURN is enabled.

Warning : Enabling more than one transport (UDP, TCP, TLS) at a time is currently not supported.

Returns
Boolean value telling whether UDP TURN transport is enabled.
bool Linphone.NatPolicy.UpnpEnabled
getset

Tell whether uPnP is enabled.

Returns
Boolean value telling whether uPnP is enabled.
The documentation for this class was generated from the following file: