Revision as of 00:11, January 28, 2017 by JLara (talk | contribs)
Jump to: navigation, search

Default SipEndpoint.config Settings

Using the Default Configuration File

You can find the default configuration file in the following location:

<installation folder>/Configuration/SipEndpoint.config

This file contains XML configuration details that affect how your SIP Endpoint SDK application behaves. The inital settings are the same as those specified for use with the QuickStart application that is included with your SIP Endpoint SDK release.

Configuration settings are separated into two containers: the Basic Container holds the connectivity details that are required to connect to your SIP Server, while the Genesys Container holds a variety of configuration settings.

Basic Container

The first Container ("Basic") holds the basic connectivity details that are required to connect to your SIP Server. This container has at least one connection (Connectivity) element with the following attributes:

<Connectivity user="DN" server="SERVER:PORT" protocol="TRANSPORT"/>

If you are using a configuration that supports Disaster Recovery and Geo-Redundancy, there may be multiple connection elements present with each specifying a separate possible connection. Refer to the configuration settings of that feature for details. You will have to make the following changes and save the updated configuration file before using the SIP Endpoint SDK:

  • user="DN" — Supply a valid DN for the user attribute.
  • server="SERVER:PORT" — Replace SERVER with the host name where your SIP Server is deployed, and PORT with the SIP port of the SIP Server host. (The default SIP port value is 5060.)
  • protocol="TRANSPORT" — Set the protocol attribute to reflect the protocol being used to communicate with SIP Server. Possible values are UDP, TCP, or TLS.

Genesys Container

The second Container ("Genesys") holds a number of configurable settings that are organized into domains and sections. These settings do not have to be changed, but can be customized to take full control over your SIP Endpoint SDK applications.

An overview of the settings in this container and the valid values for these settings is provided here:

Domain Section Setting
policy
endpoint
audio_qos
include_os_version_in_user_agent_header
include_sdk_version_in_user_agent_header
ip_versions
public_address
refer_to_proxy
rtp_inactivity_timeout
rtp_port_min
rtp_port_max
signaling_qos
sip_port_min
sip_port_max
sip_transaction_timeout
video_max_bitrate
video_qos
vq_report_collector
vq_report_publish
webrtc_audio_layer
answer_sdp_priority
sip_port_binding
session
agc_mode
auto_accept_video
auto_answer
auto_answer_delay
dtmf_method
echo_control
noise_suppression
dtx_mode
reject_session_when_headset_na
sip_code_when_headset_na
vad_level
ringing_enabled
ringing_timeout
ringing_file
restart_audio_if_stuck
reject_session_when_busy
number_sessions_for_busy
sip_code_when_busy
device
audio_in_device

For more information, see Audio Device Settings

audio_out_device
capture_device
headset_name
use_headset
codecs

— See Working with Codec Priorities

proxies
proxy<n>
display_name
domain
password
reg_interval
reg_match_received_rport
reg_timeout
mailbox (sub-section of proxy<n>)
password
server
timeout
transport
user
nat (sub-section of proxy<n>)
ice_enabled
stun_server
stun_server_port
turn_password
turn_relay_type
turn_server
turn_server_port
turn_user_name
system
diagnostics
enable_logging
log_file
log_level
log_options_provider
log_options_endpoint
logger_type
log_segment
log_expire
log_time_convert
log_time_format
security
tls_enabled
use_srtp
media
ringing_file


policy Domain

endpoint Section

audio_qos

Valid Values: Integer

Integer value representing the DSCP bits to set for RTP audio packets. Note: QoS is not supported for Windows Vista, Windows 7, or higher.


include_os_version_in_user_agent_header

Valid Values: 0, 1

Default Value: 1

If set to 1, the user agent field includes the OS version the client is currently running on.


include_sdk_version_in_user_agent_header

Valid Values: 0, 1

Default Value: 1

If set to 1, the user agent field includes the SDK version the client is currently running on.


ip_versions

Valid Values: IPv4, IPv6, IPv4, IPv6, IPv6, IPv4, or empty

Default Value: IPv4, IPv6

  • IPv4—the application selects an available local IPv4 address; IPv6 addresses are ignored.
  • IPv6—the application selects an available local IPv6 address; IPv4 addresses are ignored.
  • IPv4,IPv6 or an empty—the application selects an IPv4 address if one exists. If not, an available IPv6 address is selected.
  • IPv6,IPv4—the application selects an IPv6 address if one exists. If not, an available IPv4 address is selected.

Note: This parameter has no effect if the public_address option specifies an explicit IP address.


public_address

Valid Values:


refer_to_proxy

Valid Values:


rtp_inactivity_timeout

Valid Values:


rtp_port_min

Valid Values:


rtp_port_max

Valid Values:


signaling_qos

Valid Values:


sip_port_min

Valid Values:


sip_port_max

Valid Values:


sip_transaction_timeout

Valid Values:


video_max_bitrate

Valid Values:


video_qos

Valid Values:


vq_report_collector

Valid Values:


vq_report_publish

Valid Values:


webrtc_audio_layer

Valid Values:


answer_sdp_priority

Valid Values:


sip_port_binding

Valid Values:


session Section

agc_mode

Valid Values:


auto_accept_video

Valid Values:


auto_answer

Valid Values:


auto_answer_delay

Valid Values:


dtmf_method

Valid Values:


echo_control

Valid Values:


noise_suppression

Valid Values:


dtx_mode

Valid Values:


reject_session_when_headset_na

Valid Values:


sip_code_when_headset_na

Valid Values:


vad_level

Valid Values:


ringing_enabled

Valid Values:


ringing_timeout

Valid Values:


ringing_file

Valid Values:


restart_audio_if_stuck

Valid Values:


reject_session_when_busy

Valid Values:


number_sessions_for_busy

Valid Values:


sip_code_when_busy

Valid Values:


device Section

audio_in_device

Valid Values: For more information, see Audio Device Settings


audio_out_device

Valid Values:


capture_device

Valid Values:


headset_name

Valid Values:


use_headset

Valid Values:


codecs Domain

See Working with Codec Priorities


proxies Domain

proxy<n> Section


display_name

Valid Values:


domain

Valid Values:


password

Valid Values:


reg_interval

Valid Values:


reg_match_received_rport

Valid Values:


reg_timeout

Valid Values:

mailbox Sub-section

password

Valid Values:


server

Valid Values:


timeout

Valid Values:


transport

Valid Values:


user

Valid Values:


nat Sub-section

ice_enabled

Valid Values:


stun_server

Valid Values:


stun_server_port

Valid Values:


turn_password

Valid Values:


turn_relay_type

Valid Values:


turn_server

Valid Values:


turn_server_port

Valid Values:


turn_user_name

Valid Values:


system Domain


diagnostics Section


enable_logging

Valid Values:


log_file

Valid Values:


log_level

Valid Values:


log_options_provider

Valid Values:


log_options_endpoint

Valid Values:


logger_type

Valid Values:


log_segment

Valid Values:


log_expire

Valid Values:


log_time_convert

Valid Values:


log_time_format

Valid Values:


security Section


tls_enabled

Valid Values:


use_srtp

Valid Values:


media Section

media


ringing_file

Valid Values:

Additional Configuration Options

The default configuration file may not contain all settings that may be used with the SIP Endpoint SDK; additional settings can be added to change certain behaviors. Check Configuring SIP Endpoint SDK for .NET for a discussion of these additional settings.

Comments or questions about this documentation? Contact us for support!