External: LinphoneProxyConfig

LinphoneProxyConfig

The LinphoneProxyConfig object represents a proxy configuration to be used by the LinphoneCore object. Its fields must not be used directly in favour of the accessors methods. Once created and filled properly the LinphoneProxyConfig can be given to LinphoneCore with
Source:

Members

avpfMode :linphone.AVPFMode

Enable the use of RTCP feedback (also known as AVPF profile).
Type:
Source:

avpfRrInterval :number

Set the interval between regular RTCP reports when using AVPF/SAVPF.
Type:
  • number
Source:

contactParameters :string

Set optional contact parameters that will be added to the contact information sent in the registration.
Type:
  • string
Source:

contactUriParameters :string

Set optional contact parameters that will be added to the contact information sent in the registration, inside the URI.
Type:
  • string
Source:

<readonly> core :external:LinphoneCore

Get the
Type:
Source:

dialEscapePlus :boolean

Sets whether liblinphone should replace "+" by international calling prefix in dialed numbers (passed to
Type:
  • boolean
Source:

dialPrefix :string

Sets a dialing prefix to be automatically prepended when inviting a number with
Type:
  • string
Source:

<readonly> domain :string

Get the domain name of the given proxy config.
Type:
  • string
Source:

<readonly> error :linphone.Reason

Get the reason why registration failed when the proxy config state is LinphoneRegistrationFailed.
Type:
Source:

<readonly> errorInfo :external:LinphoneErrorInfo

Get detailed information why registration failed when the proxy config state is LinphoneRegistrationFailed.
Type:
Source:

expires :number

Sets the registration expiration time in seconds.
Type:
  • number
Source:

fileTransferServer :string

Set the http file transfer server to be used for content type application/vnd.gsma.rcs-ft-http+xml
Type:
  • string
Source:

identity :string

Sets the user identity as a SIP address.
Type:
  • string
Source:

privacy :external:LinphonePrivacyMask

Set default privacy policy for all calls routed through this proxy.
Type:
  • external:LinphonePrivacyMask
Source:

publishEnabled :boolean

Indicates either or not, PUBLISH must be issued for this
Type:
  • boolean
Source:

publishExpires :number

Set the publish expiration time in second.
Type:
  • number
Source:

qualityReportingCollector :string

Set the SIP address of the collector end-point when using quality reporting. This SIP address should be used on server-side to process packets directly then discard packets. Collector address should be a non existing account and should not received any packets.
Type:
  • string
Source:

qualityReportingEnabled :boolean

Indicates whether quality statistics during call should be stored and sent to a collector according to RFC 6035.
Type:
  • boolean
Source:

qualityReportingInterval :number

Set the interval between 2 interval reports sending when using quality reporting. If call exceed interval size, an interval report will be sent to the collector. On call termination, a session report will be sent for the remaining period. Value must be 0 (disabled) or positive.
Type:
  • number
Source:

realm :string

Set the realm of the given proxy config.
Type:
  • string
Source:

registerEnabled :boolean

Indicates either or not, REGISTRATION must be issued for this
Type:
  • boolean
Source:

route :string

Sets a SIP route. When a route is set, all outgoing calls will go to the route's destination if this proxy is the default one (see linphone_core_set_default_proxy() ).
Type:
  • string
Source:

serverAddr :string

Sets the proxy address
Type:
  • string
Source:

<readonly> state :linphone.RegistrationState

Get the registration state of the given proxy config.
Type:
Source:

Methods

done() → {number}

Commits modification made to the proxy configuration.
Source:
Returns:
Type
number

edit() → {void}

Starts editing a proxy configuration.
Source:
Returns:
Type
void

normalizeNumber(username, result, result_len) → {number}

normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
Parameters:
Name Type Description
username string -
result string -
result_len number -
Source:
Returns:
Type
number

pauseRegister() → {void}

Prevent a proxy config from refreshing its registration. This is useful to let registrations to expire naturally (or) when the application wants to keep control on when refreshes are sent. However, linphone_core_set_network_reachable(lc,TRUE) will always request the proxy configs to refresh their registrations. The refreshing operations can be resumed with
Source:
Returns:
Type
void

refreshRegister() → {void}

Refresh a proxy registration. This is useful if for example you resuming from suspend, thus IP address may have changed.
Source:
Returns:
Type
void