liblinphone  3.6.1
Functions
Controlling network parameters (ports, mtu...)

Functions

int linphone_core_get_audio_port (const LinphoneCore *lc)
 
void linphone_core_get_audio_port_range (const LinphoneCore *lc, int *min_port, int *max_port)
 
int linphone_core_get_video_port (const LinphoneCore *lc)
 
void linphone_core_get_video_port_range (const LinphoneCore *lc, int *min_port, int *max_port)
 
void linphone_core_set_audio_port (LinphoneCore *lc, int port)
 
void linphone_core_set_video_port (LinphoneCore *lc, int port)
 
int linphone_core_get_sip_port (LinphoneCore *lc)
 
int linphone_core_set_sip_transports (LinphoneCore *lc, const LCSipTransports *tr)
 
int linphone_core_get_sip_transports (LinphoneCore *lc, LCSipTransports *tr)
 
void linphone_core_set_sip_port (LinphoneCore *lc, int port)
 
bool_t linphone_core_ipv6_enabled (LinphoneCore *lc)
 
void linphone_core_enable_ipv6 (LinphoneCore *lc, bool_t val)
 
void linphone_core_set_sip_dscp (LinphoneCore *lc, int dscp)
 
int linphone_core_get_sip_dscp (const LinphoneCore *lc)
 
void linphone_core_set_audio_dscp (LinphoneCore *lc, int dscp)
 
int linphone_core_get_audio_dscp (const LinphoneCore *lc)
 
void linphone_core_set_video_dscp (LinphoneCore *lc, int dscp)
 
int linphone_core_get_video_dscp (const LinphoneCore *lc)
 
bool_t linphone_core_upnp_available ()
 
LinphoneUpnpState linphone_core_get_upnp_state (const LinphoneCore *lc)
 
const char * linphone_core_get_upnp_external_ipaddress (const LinphoneCore *lc)
 
void linphone_core_set_network_reachable (LinphoneCore *lc, bool_t value)
 
bool_t linphone_core_is_network_reachable (LinphoneCore *lc)
 
void linphone_core_enable_keep_alive (LinphoneCore *lc, bool_t enable)
 
bool_t linphone_core_keep_alive_enabled (LinphoneCore *lc)
 

Detailed Description

Function Documentation

int linphone_core_get_audio_port ( const LinphoneCore lc)

Returns the UDP port used for audio streaming.

void linphone_core_get_audio_port_range ( const LinphoneCore lc,
int *  min_port,
int *  max_port 
)

Get the audio port range from which is randomly chosen the UDP port used for audio streaming.

int linphone_core_get_video_port ( const LinphoneCore lc)

Returns the UDP port used for video streaming.

void linphone_core_get_video_port_range ( const LinphoneCore lc,
int *  min_port,
int *  max_port 
)

Get the video port range from which is randomly chosen the UDP port used for video streaming.

void linphone_core_set_audio_port ( LinphoneCore lc,
int  port 
)

Sets the UDP port used for audio streaming.

void linphone_core_set_video_port ( LinphoneCore lc,
int  port 
)

Sets the UDP port used for video streaming.

int linphone_core_get_sip_port ( LinphoneCore lc)

Returns the UDP port used by SIP.

Deprecated: use linphone_core_get_sip_transports() instead.

int linphone_core_set_sip_transports ( LinphoneCore lc,
const LCSipTransports tr 
)

Sets the ports to be used for each of transport (UDP or TCP)

A zero value port for a given transport means the transport is not used.

int linphone_core_get_sip_transports ( LinphoneCore lc,
LCSipTransports tr 
)

Retrieves the ports used for each transport (udp, tcp). A zero value port for a given transport means the transport is not used.

void linphone_core_set_sip_port ( LinphoneCore lc,
int  port 
)

Sets the UDP port to be used by SIP.

Deprecated: use linphone_core_set_sip_transports() instead.

bool_t linphone_core_ipv6_enabled ( LinphoneCore lc)

Returns TRUE if IPv6 is enabled.

See linphone_core_enable_ipv6() for more details on how IPv6 is supported in liblinphone.

void linphone_core_enable_ipv6 ( LinphoneCore lc,
bool_t  val 
)

Turns IPv6 support on or off.

Note
IPv6 support is exclusive with IPv4 in liblinphone: when IPv6 is turned on, IPv4 calls won't be possible anymore. By default IPv6 support is off.
void linphone_core_set_sip_dscp ( LinphoneCore lc,
int  dscp 
)

Set the DSCP field for SIP signaling channel.

  • The DSCP defines the quality of service in IP packets.
int linphone_core_get_sip_dscp ( const LinphoneCore lc)

Get the DSCP field for SIP signaling channel.

  • The DSCP defines the quality of service in IP packets.
void linphone_core_set_audio_dscp ( LinphoneCore lc,
int  dscp 
)

Set the DSCP field for outgoing audio streams.

The DSCP defines the quality of service in IP packets.

int linphone_core_get_audio_dscp ( const LinphoneCore lc)

Get the DSCP field for outgoing audio streams.

The DSCP defines the quality of service in IP packets.

void linphone_core_set_video_dscp ( LinphoneCore lc,
int  dscp 
)

Set the DSCP field for outgoing video streams.

The DSCP defines the quality of service in IP packets.

int linphone_core_get_video_dscp ( const LinphoneCore lc)

Get the DSCP field for outgoing video streams.

The DSCP defines the quality of service in IP packets.

bool_t linphone_core_upnp_available ( )

Return the availability of uPnP.

Returns
true if uPnP is available otherwise return false.
LinphoneUpnpState linphone_core_get_upnp_state ( const LinphoneCore lc)

Return the internal state of uPnP.

Parameters
lcLinphoneCore
Returns
an LinphoneUpnpState.
const char* linphone_core_get_upnp_external_ipaddress ( const LinphoneCore lc)

Return the external ip address of router. In some cases the uPnP can have an external ip address but not a usable uPnP (state different of Ok).

Parameters
lcLinphoneCore
Returns
a null terminated string containing the external ip address. If the the external ip address is not available return null.
void linphone_core_set_network_reachable ( LinphoneCore lc,
bool_t  value 
)

This method is called by the application to notify the linphone core library when network is reachable. Calling this method with true trigger linphone to initiate a registration process for all proxies. Calling this method disables the automatic network detection mode. It means you must call this method after each network state changes.

bool_t linphone_core_is_network_reachable ( LinphoneCore lc)

return network state either as positioned by the application or by linphone itself.

void linphone_core_enable_keep_alive ( LinphoneCore lc,
bool_t  enable 
)

enable signaling keep alive. small udp packet sent periodically to keep udp NAT association

Enables signaling keep alive

bool_t linphone_core_keep_alive_enabled ( LinphoneCore lc)

Is signaling keep alive

Is signaling keep alive enabled