SIP Endpoint SDK for OS X
 All Classes Functions Properties
GSConstants.h
1 //
2 // GSConstants.h
3 // SipEndpoint
4 //
5 // Copyright (c) 2011-2016 Genesys Telecommunications Laboratories, Inc. All rights reserved.
6 //
7 
8 #define GS_INVALID_ID -1
9 #define GS_DEFAULT_VOLUME 50
10 #define GS_MAX_CONNECTION_NUMBER 6
11 #define GS_ENDPOINT_VERSION @"8.5.200.54"
12 #define GS_ENDPOINT_NAME @"Genesys-SIPendpointSDK"
13 
14 //Endpoint policy
15 #define PUBLIC_ADDRESS_KEY @"policy:endpoint:public_address"
16 #define IP_VERSIONS_KEY @"policy:endpoint:ip_versions"
17 #define INCLUDE_OS_VERSION_IN_USER_AGENT_HEADER_KEY @"policy:endpoint:include_os_version_in_user_agent_header"
18 #define INCLUDE_SDK_VERSION_IN_USER_AGENT_HEADER_KEY @"policy:endpoint:include_sdk_version_in_user_agent_header"
19 #define ANSWER_SDP_PRIORITY_KEY @"policy:endpoint:answer_sdp_priority"
20 #define SIP_TRANSACTION_TIMEOUT_KEY @"policy:endpoint:sip_transaction_timeout"
21 #define VQ_REPORT_COLLECTOR_KEY @"policy:endpoint:vq_report_collector"
22 #define VQ_REPORT_PUBLISH_KEY @"policy:endpoint:vq_report_publish"
23 #define SIGNALING_QOS_KEY @"policy:endpoint:signaling_qos"
24 #define SECURE_SIGNALING_QOS_KEY @"policy:endpoint:secure_signaling_qos"
25 #define AUDIO_QOS_KEY @"policy:endpoint:audio_qos"
26 #define VIDEO_QOS_KEY @"policy:endpoint:video_qos"
27 #define SIP_PORT_MIN_KEY @"policy:endpoint:sip_port_min"
28 #define SIP_PORT_MAX_KEY @"policy:endpoint:sip_port_max"
29 #define SIP_PORT_BINDING_KEY @"policy:endpoint:sip_port_binding"
30 #define RTP_PORT_MIN_KEY @"policy:endpoint:rtp_port_min"
31 #define RTP_PORT_MAX_KEY @"policy:endpoint:rtp_port_max"
32 #define RTP_INACTIVITY_TIMEOUT_KEY @"policy:endpoint:rtp_inactivity_timeout"
33 #define VIDEO_MAX_BITRATE_KEY @"policy:endpoint:video_max_bitrate"
34 #define WEBRTC_AUDIO_LAYER_KEY @"policy:endpoint:webrtc_audio_layer"
35 
36 //Session policy
37 #define REJECT_SESSION_WHEN_HEADSET_NA_KEY @"policy:session:reject_session_when_headset_na"
38 #define SIP_CODE_WHEN_HEADSET_NA_KEY @"policy:session:sip_code_when_headset_na"
39 #define MESSAGE_WHEN_HEADSET_NA_KEY @"policy:session:message_when_headset_na"
40 #define AUTO_ANSWER_KEY @"policy:session:auto_answer"
41 #define AUTO_ACCEPT_VIDEO_KEY @"policy:session:auto_accept_video"
42 #define DTMF_METHOD_KEY @"policy:session:dtmf_method"
43 #define INFO_DTMF_METHOD @"Info"
44 #define INBAND_RTP_DTMF_METHOD @"InbandRtp"
45 #define RFC2833_DTMF_METHOD @"rfc2833"
46 #define AGC_MODE_KEY @"policy:session:agc_mode"
47 #define DTX_MODE_KEY @"policy:session:dtx_mode"
48 #define VAD_LEVEL_KEY @"policy:session:vad_level"
49 #define NOISE_SUPPRESSION_KEY @"policy:session:noise_suppression"
50 #define ECHO_CONTROL_KEY @"policy:session:echo_control"
51 #define RINGING_ENABLED_KEY @"policy:session:ringing_enabled"
52 #define RINGING_TIMEOUT_KEY @"policy:session:ringing_timeout"
53 #define RINGING_FILE_KEY @"policy:session:ringing_file"
54 #define RESTART_AUDIO_IF_STUCK_KEY @"policy:session:restart_audio_if_stuck"
55 #define CALL_WAITING_FILE_KEY @"policy:session:call_waiting_file"
56 #define AUTO_ANSWER_DELAY_KEY @"policy:session:auto_answer_delay"
57 #define REJECT_SESSION_WHEN_BUSY_KEY @"policy:session:reject_session_when_busy"
58 #define NUMBER_SESSIONS_FOR_BUSY_KEY @"policy:session:number_sessions_for_busy"
59 #define SIP_CODE_WHEN_BUSY_KEY @"policy:session:sip_code_when_busy"
60 
61 //Device policy
62 #define USE_HEADSET_KEY @"policy:device:use_headset"
63 #define AUDIO_IN_DEVICE_KEY @"policy:device:audio_in_device:0"
64 #define AUDIO_OUT_DEVICE_KEY @"policy:device:audio_out_device:0"
65 #define HEADSET_NAME_KEY @"policy:device:headset_name:0"
66 #define CAPTURE_DEVICE_KEY @"policy:device:capture_device:0"
67 #define HEADSET_AVAILABLE_KEY @"headset_available"
68 #define MIC_AVAILABLE_KEY @"mic_available"
69 #define SPEAKER_AVAILABLE_KEY @"speaker_available"
70 #define CAPTURE_DEVICE_AVAILABLE_KEY @"capture_device_available"
71 
72 //Codecs
73 #define CODECS @"codecs"
74 #define CODEC_PAYLOAD_TYPE @"payload_type"
75 #define CODEC_FMTP @"fmtp"
76 
77 //Diagnostics
78 #define LOGGER_TYPE_KEY @"system:diagnostics:logger_type"
79 #define ENABLE_LOGGING_KEY @"system:diagnostics:enable_logging"
80 #define LOG_LEVEL_KEY @"system:diagnostics:log_level"
81 #define LOG_OPTIONS_PROVIDER_KEY @"system:diagnostics:log_options_provider"
82 #define LOG_OPTIONS_ENDPOINT_KEY @"system:diagnostics:log_options_endpoint"
83 #define LOG_FILE_KEY @"system:diagnostics:log_file"
84 #define LOG_SEGMENT_KEY @"system:diagnostics:log_segment"
85 #define LOG_EXPIRE_KEY @"system:diagnostics:log_expire"
86 #define TIME_CONVERT_KEY @"system:diagnostics:log_time_convert"
87 #define TIME_FORMAT_KEY @"system:diagnostics:log_time_format"
88 
89 #define LOGGER_TYPE @"logger_type"
90 #define ENABLE_LOGGING @"enable_logging"
91 #define LOG_LEVEL @"log_level"
92 #define LOG_FILE @"log_file"
93 
94 
95 //Security
96 #define TLS_ENABLED_KEY @"system:security:tls_enabled"
97 #define CERTIFICATE_FILE_KEY @"system:security:cert_file"
98 #define USE_SRTP_KEY @"system:security:use_srtp"
99 #define PRIVATE_KEY_FILE_KEY @"system:security:priv_key_file"
100 #define CA_LIST_FILE_KEY @"system:security:ca_list_file"
101 
102 //Connection
103 #define CONNECTIVITIES @"connectivities"
104 #define PROXIES @"proxies"
105 
106 #define USER_KEY @"user:0"
107 #define SERVER_KEY @"server:0"
108 #define PROTOCOL_KEY @"protocol:0"
109 #define CTRL_KEY @"ctrl:0"
110 
111 #define PASSWORD_KEY @"proxies:proxy0:password"
112 #define REG_TIMEOUT_KEY @"proxies:proxy0:reg_timeout"
113 #define REG_INTERVAL_KEY @"proxies:proxy0:reg_interval"
114 #define REG_MATCH_RECEIVED_RPORT_KEY @"proxies:proxy0:reg_match_received_rport"
115 #define DOMAIN_KEY @"proxies:proxy0:domain"
116 #define DISPLAY_NAME_KEY @"proxies:proxy0:display_name"
117 
118 #define MAILBOX_TIMEOUT_KEY @"proxies:proxy0:mailbox:timeout"
119 #define MAILBOX_PASSWORD_KEY @"proxies:proxy0:mailbox:password"
120 #define MAILBOX_USER_KEY @"proxies:proxy0:mailbox:user"
121 #define MAILBOX_SERVER_KEY @"proxies:proxy0:mailbox:server"
122 #define MAILBOX_TRANSPORT_KEY @"proxies:proxy0:mailbox:transport"
123 
124 #define NAT_ICE_ENABLED_KEY @"proxies:proxy0:nat:ice_enabled"
125 #define NAT_STUN_SERVER_KEY @"proxies:proxy0:nat:stun_server"
126 #define NAT_STUN_SERVER_PORT_KEY @"proxies:proxy0:nat:stun_server_port"
127 #define NAT_TURN_SERVER_KEY @"proxies:proxy0:nat:turn_server"
128 #define NAT_TURN_SERVER_PORT_KEY @"proxies:proxy0:nat:turn_server_port"
129 #define NAT_TURN_USERNAME_KEY @"proxies:proxy0:nat:turn_user_name"
130 #define NAT_TURN_PASSWORD_KEY @"proxies:proxy0:nat:turn_password"
131 #define NAT_TURN_RELAY_TYPE_KEY @"proxies:proxy0:nat:turn_relay_type"
132 
133 #define USER @"user"
134 #define SERVER @"server"
135 #define PROTOCOL @"protocol"
136 #define CTRL @"ctrl"
137 #define CONFIG_ID @"config_id"
138 
139 #define PASSWORD @"password"
140 #define REG_TIMEOUT @"reg_timeout"
141 #define REG_INTERVAL @"reg_interval"
142 #define REG_MATCH_RECEIVED_RPORT @"reg_match_received_rport"
143 #define DOMAIN_SIP @"domain"
144 #define DISPLAY_NAME @"display_name"
145 
146 #define SIP_PORT_MIN @"sip_port_min"
147 #define SIP_PORT_MAX @"sip_port_max"
148 #define RTP_PORT_MIN @"rtp_port_min"
149 #define RTP_PORT_MAX @"rtp_port_max"
150 
151 
152 #define MAILBOX_TIMEOUT @"mailbox:timeout"
153 #define MAILBOX_PASSWORD @"mailbox:password"
154 #define MAILBOX_USER @"mailbox:user"
155 #define MAILBOX_SERVER @"mailbox:server"
156 #define MAILBOX_TRANSPORT @"mailbox:transport"
157 
158 #define NAT_ICE_ENABLED @"nat:ice_enabled"
159 #define NAT_STUN_SERVER @"nat:stun_server"
160 #define NAT_STUN_SERVER_PORT @"nat:stun_server_port"
161 #define NAT_TURN_SERVER @"nat:turn_server"
162 #define NAT_TURN_SERVER_PORT @"nat:turn_server_port"
163 #define NAT_TURN_USERNAME @"nat:turn_user_name"
164 #define NAT_TURN_PASSWORD @"nat:turn_password"
165 #define NAT_TURN_RELAY_TYPE @"nat:turn_relay_type"
166 
167 //Logging macros
168 #define LOG_DEBUG_FORMAT(msg, ...) [self.logger logDebugMessageWithFormat:msg, __VA_ARGS__]
169 #define LOG_DEBUG(msg) [self.logger logDebugMessage:msg]
170 
171 #define LOG_INFO_FORMAT(msg, ...) [self.logger logInfoMessageWithFormat:msg, __VA_ARGS__]
172 #define LOG_INFO(msg) [self.logger logInfoMessage:msg]
173 
174 #define LOG_WARN_FORMAT(msg, ...) [self.logger logWarningMessageWithFormat:msg, __VA_ARGS__]
175 #define LOG_WARN(msg) [self.logger logWarnMessage:msg]
176 
177 #define LOG_ERROR_FORMAT(msg, ...) [self.logger logErrorMessageWithFormat:msg, __VA_ARGS__]
178 #define LOG_ERROR(msg) [self.logger logErrorMessage:msg]
179 
180 #define LOG_FATAL_FORMAT(msg, ...) [self.logger logFatalErrorMessageWithFormat:msg, __VA_ARGS__]
181 #define LOG_FATAL(msg) [self.logger logFatalErrorMessage:msg]