Android SIP SDK -AJVoIP
<!-- If the browser does not support frames put the first topic content here --> <div class="WordSection1"> <div style='border-top:solid #C0504D 6.0pt;border-left:none;border-bottom:solid #C0504D 6.0pt; border-right:none;padding:0in 0in 0in 0in;background:#C0504D'> <p class="MsoTitle">AJVoIP –Android Java VoIP SDK</p> <p class="MsoTitle"><span style='font-size:12.0pt'>July 3, 2023</span></p> </div> <p class="MsoNormal"><span style='font-size:22.0pt;line-height:120%'> </span></p> <p class="MsoNormal"><span style='font-size:24.0pt;line-height:120%'> </span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <p class="MsoTocHeading"><span style='font-size:12.0pt;line-height:112%'>Contents</span></p> </div> <p class="MsoToc1"><a href="start.htm#_Toc506369838"><span style='font-size:11.0pt;line-height:120%'>About</span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>. </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>2</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc506369839"><span style='font-size:11.0pt; line-height:120%'>Package content</span><span style='font-size:11.0pt; line-height:120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>2</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc506369840"><span style='font-size:11.0pt; line-height:120%'>Requirements</span><span style='font-size:11.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>2</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc506369841"><span style='font-size:11.0pt; line-height:120%'>Usage</span><span style='font-size:11.0pt;line-height:120%; color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>4</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc506369842"><span style='font-size:11.0pt; line-height:120%'>Instructions</span><span style='font-size:11.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>4</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc506369843"><span style='font-size:11.0pt; line-height:120%'>Example code</span><span style='font-size:11.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>6</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc506369844"><span style='font-size:11.0pt; line-height:120%'>Sample project</span><span style='font-size:11.0pt; line-height:120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>7</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc506369845"><span style='font-size:11.0pt; line-height:120%'>Features</span><span style='font-size:11.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>7</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc506369846"><span style='font-size:11.0pt; line-height:120%'>Licensing</span><span style='font-size:11.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>8</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc506369847"><span style='font-size:11.0pt; line-height:120%'>API</span><span style='font-size:11.0pt;line-height:120%; color:windowtext;display:none;text-decoration:none'> </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>9</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc506369848"><span style='font-size:11.0pt; line-height:120%'>Functions</span><span style='font-size:11.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>9</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc506369849"><span style='font-size:11.0pt; line-height:120%'>Notifications</span><span style='font-size:11.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>27</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc506369850"><span style='font-size:11.0pt; line-height:120%'>Parameters</span><span style='font-size:11.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>38</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc506369851"><span style='font-size:11.0pt; line-height:120%'>Basic Parameters</span><span style='font-size:11.0pt; line-height:120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>38</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc506369858"><span style='font-size:11.0pt; line-height:120%'>Advanced Parameters</span><span style='font-size:11.0pt; line-height:120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>39</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc506370021"><span style='font-size:11.0pt; line-height:120%'>FAQ</span><span style='font-size:11.0pt;line-height:120%; color:windowtext;display:none;text-decoration:none'>.. </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>80</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc506370057"><span style='font-size:11.0pt; line-height:120%'>Resources</span><span style='font-size:11.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:11.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>116</span></a></p> <p class="MsoNormal"><span style='font-size:11.0pt;line-height:120%'> </span></p> <p class="MsoNormal"><span style='font-size:11.0pt;line-height:120%'> </span></p> <p class="MsoNormal"><span style='font-size:24.0pt;line-height:120%'> </span></p> <p class="MsoNormal"><span style='font-size:24.0pt;line-height:120%'> </span></p> <p class="MsoNormal"><span style='font-size:24.0pt;line-height:120%'> </span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1 style='background:#F2DBDB'><a name="_Toc506369838">About</a> </h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The Android Java VoIP SDK (AJVoIP) is a SIP client library for the Android platform. Since it is based on the open standard </span><a href="http://en.wikipedia.org/wiki/Session_Initiation_Protocol"><span style='font-style:normal'>Session Initiation Protocol</span></a><span style='font-style:normal'>, it can inter-operate with any other SIP-based device (servers and clients).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="https://www.mizu-voip.com/Software/SIPSDK/AndroidSIPSDK.aspx"><span style='font-style:normal'>AJVoIP</span></a><span style='font-style:normal'> is an easy to use compact Android SIP client library consisting of a single library file which have to be added to your project (one single aar or jar file) containing a simple high-level API (one single class).</span></p> <p class="MsoListParagraph" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>With the Android SIP SDK you have a compact but full featured SIP/media stack, easy to integrate with any Android application.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>It can be used to develop a custom Android SIP client application or to add VoIP call capabilities into any existing Android application.</span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1 style='background:#F2DBDB'><a name="_Toc506369839"></a><a name="_Package_content"></a>Package content </h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The followings can be found in the </span><a href="https://www.mizu-voip.com/Portals/0/Files/AJVoIP.zip"><span style='font-style:normal'>AJVoIP package</span></a><span style='font-style: normal'>:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>The library itself:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>AJVoIP.aar (Android Archive file to be used with Android Studio)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>AJVoIP.jar (jar file to be used with any other development environment such as Eclipse or Embarcadero Delphi / C++ Builder)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Documentation: </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>SDK description: </span><a href="https://www.mizu-voip.com/Software/SIPSDK/AndroidSIPSDK.aspx"><span style='font-style:normal'>software home-page</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Full documentation: </span><a href="https://www.mizu-voip.com/Portals/0/Files/AndroidSIPSDK.pdf"><span style='font-style:normal'>this document</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>JavaDoc: </span><a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc.zip"><span style='font-style:normal'>download</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Sample project:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Test project (a working example) to be downloaded from </span><a href="https://www.mizu-voip.com/Portals/0/Files/AJVoIPTest.zip"><span style='font-style:normal'>here</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>License:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>AJVoIP comes with life-time license allowing commercial usage for your company (limited features and number of users with the Basic license, al features and unlimited users and calls with the Advanced and Gold license)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Support:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Support is also included with your AJVoIP license for no extra cost. </span><a href="mailto:info@mizu-voip.com?subject=AJVoIP%20help"><span style='font-style:normal'>Contact us</span></a><span style='font-style:normal'> with any question/issue/bug report and we are here to help.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Upgrades: AJVoIP is actively maintained with at last one major new version per year including improvements, bug fixes and new features in each new release. Upgrades are always backward and forward compatible with no code changes required in your project.</span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1 style='background:#F2DBDB'><a name="_Toc506369840"></a><a name="_Requirements"></a>Requirements </h1> </div> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>Programming language:</span></b><span style='font-style:normal'> Java, Kotlin, Scala or any other which can consume a aar/jar and can emit android apk such as Xamarin, Corona, Phonegap/Cordova, C++, Python, Groovy, Flutter, Xamarin, React, Ionic and others. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>IDE</span></b><span style='font-style:normal'>: For development you can use any environment which can produce android executables. The most popular options are Android Studio and Eclipse. You can use any operating system to work on your project: Windows, MAC, Linux.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>SIP</span></b><span style='font-style:normal'>: a SIP account at any VoIP service provider or your own IP-PBX/Softswitch/SIP sever. Can be also used without registration for peer to peer SIP calls.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>Network</span></b><span style='font-style:normal'>: All networks are supported with connection speed above 12 kbits including Wi-Fi and mobile GPRS, EDGE, 3G, 4G, LTE, 5G. VPN connections are also supported.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>Size</span></b><span style='font-style:normal'>: below 3 MB</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>RAM</span></b><span style='font-style:normal'>: around 35 MB while in call. (This means that you can run the SIP engine also on low-end devices with 256 MB RAM or less)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>CPU architecture</span></b><span style='font-style:normal'>: any. Most of the library is pure Java. </span><span style='font-size:9.0pt'>To improve performance, some audio processing and codec related functionalities are implemented also as native ABI modules for all the popular platforms (arm, x86 and mips, including 64bit versions), but these modules are optional (will be loaded only on compatible platforms although this means that it will work on most devices)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>CPU speed</span></b><span style='font-style:normal'>: any (The library will auto detect the CPU performance and it might disable some features on old/slow CPU’s, such as G.729, wideband and AEC which means that you can run it even on low-end 100 MHz ARM processors)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>Android versions</span></b><span style='font-style:normal'>: Android 4 (released in 2011) – Android 14+ (released in 2023). Compatible with all devices since Android 4.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>API level</span></b><span style='font-style:normal'>: All Android API/SDK versions are supported (AJVoIP is optimized to old API levels but also takes full advantage of the features found in latest versions if you are running it on a compatible OS)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Minimum (minSdkVersion):<b> </b>14 (released in 2011 with Android 4.0 Ice Cream Sandwich), which means compatibility also with ancient phones covering 100% of the market. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt'>Note: On request, we can ship also build with minSdkVersion 9 (this might be necessary only if you wish to target some specific/outdated hardware)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Target (targetSdkVersion): 14 or higher (you should set this as high as possible for your project environment. Current recommended is: 33)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt'>Note: due to Google Play regulations you must always target latest android versions as old API levels cannot be submitted. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Compile: The compileSdkVersion should be set to 33 or higher (you should set it to highest possible by your project environment)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Maximum: 34+. API level 33 introduced with Android 13 in 2023. The SDK is continuously tested and optimized to latest API levels as released by Google while also keeping full backward compatibility with old API levels. You can expect to work it also in all future versions with no modifications required and we also add optimizations to latest API levels when new versions are released if there is any new Android feature that can be exploited by the VoIP SDK.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>Required permissions:</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can set these in your AndroidManifest.xml as </span><a href="https://developer.android.com/guide/topics/manifest/uses-permission-element"><span style='font-style:normal'>uses-permission</span></a><span style='font-style: normal'> elements:<br> Example: <span style='color:#984806'><uses-permission android:name="android.permission.RECORD_AUDIO"/></span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>Here are the required and optional permissions: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Dangerous/Mandatory (your app must have permission for this):</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>RECORD_AUDIO (used for the audio input stream)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Dangerous/Optional (permission have to be asked only if related features are needed):</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>CAMERA (used only if you need video calls)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>POST_NOTIFICATIONS (not required for AJVoIP, but might be needed for your app if you wish to post notifications)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>READ_CONTACTS and WRITE_CONTACTS (not required for AJVoIP at all, but might be needed for your app if you wish to manage contacts)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>READ_PHONE_STATE (only if the rejectonphonebusy parameter is set to 0 or 2 or if you need more accurate call state detection)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Normal (permissions are granted automatically for these, just add them into your manifest.xml):</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>INTERNET (mandatory)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>ACCESS_NETWORK_STATE (optional but highly recommended) </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>CHANGE_NETWORK_STATE (optional)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>MODIFY_AUDIO_SETTINGS (optinal)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>ACCESS_WIFI_STATE (optional)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>CHANGE_WIFI_STATE (optional)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>BLUETOOTH (optional for API level < 31)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>BLUETOOTH_CONNECT (optional for API level >= 31)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>DISABLE_KEYGUARD (optional)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>VIBRATE (optional)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>FOREGROUND_SERVICE (optional since API level 27 if you wish to launch the sipstack from a foreground service)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>REQUEST_IGNORE_BATTERY_OPTIMIZATIONS (optional for API level 26 or above running the sipstack as a service)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>WAKE_LOCK (optional but highly recommended)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>SCHEDULE_EXACT_ALARM (optional for API level < 32; might help to keep the app service running on some devices)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>RECEIVE_BOOT_COMPLETED (needed only if you wish to run it as a service and auto-start)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: there is no need to ask for permissions at runtime if your application target API level 22 or below outside the Play Store. </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>More details about permissions can be found <a href="start.htm#_Project_configuration">here</a>.</p> <p class="MsoListParagraph" style='margin-top:0in;margin-right:0in;margin-bottom: 0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in;line-height: normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>Required android features:</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can set these in your AndroidManifest.xml as </span><a href="https://developer.android.com/guide/topics/manifest/uses-feature-element"><span style='font-style:normal'>uses-feature</span></a><span style='font-style:normal'> elements:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The only important feature is the android.hardware.microphone (but this is also not enforced by default by the library because you might use it for other purposes when no media recording is required for calls).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For a usual SIP client application you should add the following line to your manifest:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> <span style='color: #984806'><uses-feature android:name="android.hardware.microphone" android:required="true" /></span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The RECORD_AUDIO permission must be also asked at runtime as described </span><a href="https://developer.android.com/training/permissions/requesting"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>. AJVoIP will ask for this on first audio device opening, but this might fail outside your activity and it is better if you ask it also from your app at a more appropriate time (for example at startup or before the first call).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Other features that might be used by the library (thus might be required by your application) are the followings: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>android.hardware.audio.low_latency</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>android.hardware.audio.output</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>android.hardware.audio.pro</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>android.hardware.telephony</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>android.hardware.bluetooth</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>android.hardware.bluetooth_le</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>android.hardware.wifi</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>android.hardware.sensor.proximity</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>android.hardware.camera</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>android.hardware.camera.front</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>android.hardware.camera.any</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>android.hardware.camera.autofocus</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>android.software.sip</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>android.software.sip.voip</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>android.software.webview</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>None of these are crucial so you might add them to your manifest with required flag set to false or don’t add at all if not mandatory for your use-case. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: <span style='color:#984806'><uses-feature android:name="android.hardware.audio.low_latency" android:required="false" /></span></span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1 style='background:#F2DBDB'><a name="_Toc506369841">Usage</a> </h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can use the AJVoIP library in any Android project. Just add the library to your project and call its public API </span><a href="start.htm#_Functions"><span style='font-style:normal'>functions</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369842"><span style='font-size: 12.0pt'>Instructions</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Step-by-step instruction for using AJVoIP:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Download AJVoIP from </span><a href="https://www.mizu-voip.com/Portals/0/Files/AJVoIP.zip"><span style='font-style:normal'>here</span></a><span style='font-style:normal'> (this is the demo version) or from the link provided by Mizutech (paid versions) and unzip.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>You might load the </span><a href="start.htm#_Sample_project"><span style='font-style:normal'>sample project</span></a><span style='font-style: normal'> first and check its </span><a href="http://www.mizu-voip.com/portals/0/files/exampleMainActivity.java.txt"><span style='font-style:normal'>MainActivity.java</span></a><span style='font-style: normal'> file for a simple but working usage example.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Add the SIP library to your project</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>You can use either the AJVoIP.aar file or the AJVoIP.jar file. If you are using Android Studio then we recommend the aar file. Otherwise the jar file.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>For Android Studio you can add it to your project this way:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>1)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Click File > New > New Module.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>2)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Click Import .JAR/.AAR Package then click Next.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>3)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Enter the location of the AJVoIP.aar file then click Finish.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>4)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Make sure the library is listed at the top of your settings.gradle file:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>include ':app', ':AJVoIP'</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>5)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Open the app module's build.gradle file and add a new line to the dependencies block: </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>dependencies {</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'> ...</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'> implementation project(":AJVoIP")</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>}</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>6)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Click Sync Project with Gradle Files.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>7)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>More details can be found </span><a href="start.htm#_Project_configuration"><span style='font-style:normal'>here</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>If you are using Eclipse then follow these steps:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>1)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Create a folder called libs in your project's root folder</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>2)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Copy the AJVoIP.jar file to the libs folder</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>3)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Now right click on the AJVoIP.jar file and then select Build Path > Add to Build Path, which will create a folder called 'Referenced Libraries' within your project</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span class="MsoHyperlink"><span style='color:windowtext; font-style:normal;text-decoration:none'>4)<span style='font:7.0pt "Times New Roman"'> </span></span></span><span style='font-style:normal'>You can read more details </span><a href="https://stackoverflow.com/questions/1334802/how-can-i-use-external-jars-in-an-android-project"><span style='font-style:normal'>here</span></a></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>If you are using other IDE or environment:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> Just import the AJVoIP.jar into your project and use its public class.</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Instantiate a SipStack object</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Add the following code to the location from where do you wish to start the SIP client:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>import com.mizuvoip.jvoip.*; </span><span style='color:gray;font-style:normal'>//import the SipStack class from AJVoIP </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>SipStack mysipclient = null; </span><span style='color:gray;font-style:normal'>//declare the SIP stack object variable somewhere in your application</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>mysipclient = new SipStack();</span><span style='color:gray;font-style:normal'> //create the SIP Stack instance. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>mysipclient.Init(context); </span><span style='color:gray;font-style:normal'>//initialize the SIP stack</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='color:gray;font-style:normal'>//The context parameter is your application Context which can be obtained from any activity or as described </span><a href="https://stackoverflow.com/questions/2002288/static-way-to-get-context-on-android"><span style='color:gray;font-style:normal'>here</span></a></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Call the SetParameter (or the SetParameters) function to pass any settings</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>mysipclient.SetParameter("loglevel","5"); </span><span style='color:gray;font-style:normal'>//set loglevel</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>mysipclient.SetParameter("serveraddress","voip.mizu-voip.com"); </span><span style='color:gray;font-style:normal'>//set your voip server domain or IP:port</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>mysipclient.SetParameter("username","sdktest2"); </span><span style='color:gray;font-style:normal'>//set SIP username</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>mysipclient.SetParameter("password","sdktest2"); </span><span style='color:gray;font-style:normal'>//set SIP password</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:gray;font-style:normal'>//you might set other parameters here such as proxyaddress, autoaccept and many others. See the </span><a href="start.htm#_Parameters"><span style='color:gray;font-style:normal'>parameters</span></a><span style='color:gray;font-style:normal'> chapter for the full list of possible parameters.</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Call the Start() to start the sipstack</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>mysipclient.Start(); </span><span style='color:gray;font-style:normal'>//this will start the SIP stack internal main thread. It might also auto register, depending on the “register” parameter</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='color:gray;font-style:normal'>//mysipclient.Register(); </span><span style='color:#984806;font-style:normal'> </span><span style='color:gray;font-style:normal'>//if you have set the “register” parameter to 0, then you might need to </span><a href="start.htm#_How_to_register?"><span style='font-style:normal'>register</span></a><span style='color:gray; font-style:normal'> explicitly</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>6.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Call any of the API </span><a href="start.htm#_Functions"><span style='font-style:normal'>functions</span></a><span style='font-style:normal'>. This is where the actual work is done. Example: </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:.25in; line-height:normal'><span style='color:#984806;font-style:normal'>mysipclient.Call(-1, “testivr3”); </span><span style='color:gray;font-style:normal'>//init call to “testivr3”. Possibly behind a “Call” button.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:.25in; line-height:normal'><span style='color:#984806;font-style:normal'>mysipclient.SendChat(-1, “john”, “hi”); </span><span style='color:gray;font-style:normal'>//send “hi” text message to the john SIP user or SIP extension. Possibly behind a “Chat” button.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Use any other </span><a href="start.htm#_Functions"><span style='font-style:normal'>API</span></a><span style='font-style:normal'> (for example to send DTMF, set presence, call transfer, conference or other functions)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>7.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Handle the notifications. </span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='color:gray;font-style:normal'>//create a SIPNotification subclass and override the functions (notification events) in which you are interested in: </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>class MySIPNotificationListener extends SIPNotificationListener</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>{</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'> public void onAll(SIPNotification e) {</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'> Log.v("AJVoIP","Notification received: " + e.toString());</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'> }</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'> public void onStatus (SIPNotification.Status e) {</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'> Log.v("AJVoIP","STATUS notification received: " + e.</span><span style='font-size:11.0pt'> </span><span style='color:#984806;font-style:normal'>getStatusText());</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'> } </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>}</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:gray;font-style:normal'>//subscribe to notifications (this can be done when you initialize the SipStack):</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>mysipclient.SetNotificationListener(new MySIPNotificationListener());<br> <br> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .25in;line-height:normal'><span style='font-style:normal'>Adjust your state machine and GUI according the notifications received (the </span><a href="start.htm#_STATUS,line,statustext,peername,loc"><span style='font-style:normal'>STATUS</span></a><span style='font-style:normal'> notification is the most relevant)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .25in;line-height:normal'><span style='font-style:normal'>See the </span><a href="start.htm#_Notifications"><span style='font-style:normal'>Notifications</span></a><span style='font-style:normal'> chapter and the </span><a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html"><span style='font-style:normal'>Javadoc</span></a><span style='font-style:normal'> for the details.</span></p> <p class="MsoListParagraph" style='margin-top:0in;margin-right:0in;margin-bottom: 0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in;line-height: normal'><span style='font-style:normal'>8.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Fine-tune your application by adjusting any additional </span><a href="start.htm#_Parameters"><span style='font-style: normal'>parameters</span></a><span style='font-style:normal'> that might be needed for your use-case.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .25in;line-height:normal'><span style='font-style:normal'>Scroll trough the </span><a href="start.htm#_FAQ"><span style='font-style:normal'>FAQ</span></a><span style='font-style:normal'> to find the answer for the most relevant issues and potential features such as </span><a href="start.htm#_Native_phone_integration"><span style='font-style:normal'>call</span></a><span class="MsoHyperlink"><span style='font-style:normal'> </span></span><a href="start.htm#_Call_recording"><span style='font-style:normal'>recording</span></a><span style='font-style:normal'> or </span><a href="start.htm#_Transfer_API_usage"><span style='font-style:normal'>call transfer</span></a><span style='font-style:normal'> usage.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .25in;line-height:normal'><a href="mailto:info@mizu-voip.com?subject=AJVoIP"><span style='font-style:normal'>Contact us</span></a><span style='font-style:normal'> if you run into any issue or with any question</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Project_configuration"></a><span style='font-size:12.0pt'>Project configuration</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>There are no any specific requirements regarding your Android project, IDE or environment. You just need to add the AJVoIP.aar into your Android Studio project (or the AJVoIP.jar if you are using some other IDE) and you are ready to go by importing the API class (</span><span style='color:#984806;font-style:normal'>import com.mizuvoip.jvoip.*;</span><span style='color:black;font-style:normal'>) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>The followings are to be considered for your gradle and manifest file.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>The basic requirements are the followings (SDK / api level settings for your app):</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;color:black;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black;font-style:normal'>Set the </span><span style='color:#984806;font-style:normal'>minSdkVersion </span><span style='color:black;font-style:normal'>to </span><span style='color:#984806; font-style:normal'>14 </span><span style='color:black;font-style:normal'>or higher (the minimal SDK version your app is prepared to handle. Let us know if for some reason you need to go below 14)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;color:black;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black;font-style:normal'>Set the </span><span style='color:#984806;font-style:normal'>compileSdkVersion </span><span style='color:black;font-style:normal'>to the maximum possible in your development environment (33 or higher. Depending on the SDK version you wish to use to compile your project)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;color:black;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black;font-style:normal'>Set the </span><span style='color:#984806;font-style:normal'>targetSdkVersion </span><span style='color:black;font-style:normal'>to at least to the minimum API level allowed in Google Play when your publish your app. For example to 33 in 2023 (It is recommended to set this to a value to cover most of the phones on the </span><a href="https://developer.android.com/about/dashboards/"><span style='font-style: normal'>market</span></a><span style='color:black;font-style:normal'> and Google Play doesn’t allow targeting too old API levels)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>The AJVoIP library itself have been built with the following SDK/API settings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;color:black;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black;font-style:normal'>min SDK: 14 (this gives you a lot of flexibility, allowing your app to target any SDK versions you wish starting with the already ancient v.14)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;color:black;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black;font-style:normal'>target SDK: 33</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;color:black;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black;font-style:normal'>compile SDK: 33</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;color:black;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black;font-style:normal'>the library might load API level 14+ (including v.33) features at run-time with class-loader or support libraries when it is running on a new devices, taking full advantage of the latest Android platform features.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>If your minSdkVersion is 20 or below (prior to Android 5.0), then you should enable multidex as described </span><a href="https://developer.android.com/studio/build/multidex"><span style='font-style:normal'>here</span></a><span style='color:black;font-style: normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>The library depends also on android support library (this is to allow your project to compile and target any SDK using any API level since 14).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>You might need to add it into your gradle config as well:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal;background:white'><span style='color:#984806;font-style:normal'>dependencies {<br> </span><span style='color:#984806'>…</span><span style='color:#984806; font-style:normal'><br> implementation 'androidx.legacy:legacy-support-v4:1.0.0'</span><span style='color:#984806'><br> </span><span style='color:#984806;font-style:normal'>}</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>The only “dangerous” permission required by default is audio recording. For this you should add the following lines to your AndroidManifest.xml:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'><uses-permission android:name="android.permission.RECORD_AUDIO"></uses-permission></span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'><uses-feature android:name="android.hardware.microphone" android:required="true" /></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>Above API level 23 the permission request should be handled at runtime as described </span><a href="https://developer.android.com/distribute/best-practices/develop/runtime-permissions"><span style='font-style:normal'>here</span></a><span style='color:black;font-style: normal'> and </span><a href="https://developer.android.com/training/permissions/requesting"><span style='font-style:normal'>here</span></a><span style='color:black;font-style: normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Permissions can be requested from your own code, however the AJVoIP will also check (and ask for permission if needed) for RECORD_AUDIO (for calls) and CAMERA (on video calls).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>You must also add the following non-dangerous permissions to your AndroidManifest.xml (allowed automatically, no need for explicit permission request):</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'><uses-permission android:name="android.permission.INTERNET"/></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>All other permissions and features are optional and handled gratefully by the library if not granted. For a full list see the “Required Permissions” section </span><a href="start.htm#_Requirements"><span style='font-style:normal'>here</span></a><span style='color:black;font-style:normal'>. You need to take care of these only if your app requires a specific feature depending on one of these permissions.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>More details about permissions can be found </span><a href="https://developer.android.com/guide/topics/permissions/overview"><span style='font-style:normal'>here</span></a><span style='color:black;font-style: normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>For a basic gradle config file, see the build.gradle file in the </span><a href="https://www.mizu-voip.com/Portals/0/Files/AJVoIPTest.zip"><span style='font-style:normal'>sample application</span></a><span style='color:black; font-style:normal'> (inside the “app” subfolder).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>You might also check the </span><a href="https://www.mizu-voip.com/Portals/0/Files/build.gradle.txt"><span style='font-style:normal'>gradle file</span></a><span style='color:black; font-style:normal'> of our </span><a href="https://play.google.com/store/apps/details?id=com.mizuvoip.mizudroid.app"><span style='font-style:normal'>MizuDroid</span></a><span style='color:black; font-style:normal'> softphone (this is a full featured SIP softphone based on the AJVoIP library with a long list of features).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>For a basic manifest file, see the AndroidManifest.xml in the </span><a href="https://www.mizu-voip.com/Portals/0/Files/AJVoIPTest.zip"><span style='font-style:normal'>sample application</span></a><span style='color:black; font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>You might also check the </span><a href="https://www.mizu-voip.com/Portals/0/Files/AndroidManifest.xml"><span style='font-style:normal'>manifest file</span></a><span style='color:black; font-style:normal'> of our MizuDroid softphone used in production.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>Since AJVoIP is already minified/optimized, you should exclude it from ProGuard, by adding this line in your project proguard-rules.pro file:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='color:#984806;font-style:normal'>-keep com.mizuvoip.jvoip.** { *; }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>Otherwise, you should be able to use any </span><a href="http://omgitsmgp.com/2013/09/09/a-conservative-guide-to-proguard-for-android/"><span style='font-style:normal'>proguard</span></a><span style='color:black; font-style:normal'> rules for your project as this will should not affect AJVoIP usage (the SIP library itself is already highly optimized, but with its interface class kept untouched).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>You might need to slightly modify your project config to match your requirements, however in overall AJVoIP doesn’t impose any hard limitations on the required configurations and you should be able to use the library in any environment with any settings if you respect the minimal requirements (min/target/compile SDK versions as described above).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369843"></a><a name="_Example_code"></a><span style='font-size:12.0pt'>Example code</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//error handling removed for simplicity</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>package yourpackagename;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>import com.mizuvoip.jvoip.*; </span><span style='font-size:9.0pt;color:gray; font-style:normal'>//import AJVoIP</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//create SipStack class object instance:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>SipStack mysipclient = new SipStack();</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//initialize the SDK:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>mysipclient.Init((Context)this); </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//subscribe to notification events</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>MyNotificationListener listener = new MyNotificationListener();</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>mysipclient.SetNotificationListener(listener);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//set parameters (replace uppercase words):</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>mysipclient.SetParameter("serveraddress", "VOIP_SERVER_IP_OR_DOMAIN");</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>mysipclient.SetParameter("username", "SIP_USERNAME");</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>mysipclient.SetParameter("password", "SIP_PASSWORD");</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>mysipclient.SetParameter("loglevel", "5");</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//you might set other parameters here</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//start the sipstack:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>mysipclient.Start(); </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//</span><a href="start.htm#_How_to_register?"><span style='font-size:9.0pt;font-style:normal'>register</span></a><span style='font-size:9.0pt;color:gray;font-style:normal'> to your SIP server if needed (usually not needed since the above Start can also auto-register, depending on the “register” parameter):</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//mysipclient.Register();</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//make a call to a user/extension/phone number/SIP URI (note: 1-2 seconds might be needed between Start/Register and Call for the sipstack to initialize)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>mysipclient.Call(-1, "DESTINATION");</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//the following lines should be used from another function</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//during the call you might call call divert functions by your app logic or on user interaction, for example Hold()</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//call hangup to end the call (possibly triggered by a "Hangup" button pressed by the user):</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>mysipclient.Hangup(-1);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//stop AJVoIP when you don't need it anymore</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>mysipclient.Unregister();</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>sipnotifications.Stop();</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//handle the notifications:</span></p> <p class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>class MyNotificationListener extends SIPNotificationListener</span></p> <p class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>{</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#548DD4;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//see the </span><a href="start.htm#_Notifications"><span style='font-size:9.0pt;font-style:normal'>Notifications</span></a><span style='font-size:9.0pt;color:gray;font-style:normal'> chapter and the </span><a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html"><span style='font-size:9.0pt;font-style:normal'>javadoc</span></a><span style='font-size:9.0pt;color:gray;font-style:normal'> for the details. </span></p> <p class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-size:9.0pt;color:#548DD4;font-style:normal'> </span></p> <p class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-size:9.0pt;color:#548DD4;font-style:normal'> </span><span style='font-size:9.0pt;color:#984806;font-style:normal'>public void onAll(SIPNotification e) { </span></p> <p class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> System.out.println("Notification received: " + e.toString());</span></p> <p class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> }</span></p> <p class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-size:9.0pt;color:#548DD4;font-style:normal'> </span></p> <p class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-size:9.0pt;color:gray;font-style:normal'> //override any other members here after your needs.</span></p> <p class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>} </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#984806'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>See the </span><a href="start.htm#_API"><span style='font-style:normal'>API</span></a><span style='font-style:normal'> and the </span><a href="start.htm#_Parameters"><span style='font-style:normal'>parameters</span></a><span style='font-style:normal'> sections below for the details about the usage.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369844"></a><a name="_Sample_project"></a><span style='font-size:12.0pt'>Sample project</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>You can download a working example from </span><a href="https://www.mizu-voip.com/Portals/0/Files/AJVoIPTest.zip"><span style='font-style:normal'>here</span></a><span style='color:black;font-style: normal'>. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>Usage:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='color:black;font-style: normal'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.mizu-voip.com/Portals/0/Files/AJVoIPTest.zip"><span style='font-style:normal'>Download</span></a><span style='color:black; font-style:normal'> and unzip the AJVoIPTest.zip file</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='color:black; font-style:normal'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black;font-style:normal'>Open the project in Android Studio</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='color:black; font-style:normal'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black;font-style:normal'>Copy the </span><span style='color:#984806;font-style:normal'>AJVoIP.aar</span><span style='color:black;font-style:normal'> into the </span><span style='color:#984806; font-style:normal'>\AJVoIPTest\AJVoIP</span><span style='color:black; font-style:normal'> folder! (from </span><a href="https://www.mizu-voip.com/Portals/0/Files/AJVoIP.zip"><span style='font-style:normal'>the demo</span></a><span style='color:black; font-style:normal'> or from the package sent to you by Mizutech)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='color:black; font-style:normal'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black;font-style:normal'>You might also need to adjust the SDK version and location in the following files:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>local.properties </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>\app\</span><span style='font-size: 11.0pt;color:#984806'> </span><span style='color:#984806;font-style:normal'>build.gradle</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='color:black;font-style: normal'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black;font-style:normal'>From Android Studio select </span><span style='color:#984806;font-style:normal'>Rebuild Project </span><span style='color:black;font-style:normal'>from the Build menu. Once the rebuild is ready, you can </span><span style='color:#984806;font-style:normal'>Run </span><span style='color:black;font-style:normal'>it (on your device or in emulator)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>The relevant code can be found in the </span><span style='color:#984806;font-style:normal'>\AJVoIPTest\app\src\main\java\com\ajvoiptest\MainActivity.java</span><span style='color:black;font-style:normal'> </span><a href="http://www.mizu-voip.com/portals/0/files/exampleMainActivity.java.txt"><span style='font-style:normal'>file</span></a><span style='color:black;font-style: normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>This is an Android Studio example project. If you are using Eclipse or other environment, then just inspect the above file or convert the project to your environment.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For a full demonstration of the SDK capabilities you might check the </span><a href="https://www.mizu-voip.com/Software/Softphones/AndroidSoftphone.aspx"><span style='font-style:normal'>MizuDroid Android softphone</span></a><span style='font-style:normal'> which is also based on this SDK.</span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc506369845"></a><a name="_Features"></a>Features</h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>AJVoIP is a full featured SIP library for Android with all the usual telephony features implemented and many other extra features.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Standard SIP client for calls (in/out), chat, conference and others</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>SIP</span></b><span style='font-style:normal'> and RTP stack compatible with any VoIP server or client (Cisco, Asterisk, gateways, ATA, softphones, IP Phones, X-Lite and many others)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Compatible with all Android devices (phones, tablets, TV’s and others). SDK compatibility with 100% of the market share (min SDK: 9) and always optimized for latest Android versions while keeping full backward compatibility even with ancient devices</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Protocols: SIP/SIPS, RTP/SRTP. Transport: UDP, TCP, TLS, TCP tunnel, SOCKS proxy traversal, HTTP proxy traversal, HTTP,<b> </b>VPN tunneling</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>NAT/Firewall support: stable SIP and RTP ports ,keep-alive, UPnP, rport support, fast ICE/fast STUN protocols and auto configuration</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Encryption: <b>TLS/SRTP</b>, tunneling and peer to peer encrypted media (if direct routing is not disable by your SIP server SDP negotiation)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>RFC’s: 2543, 3261, 2976, 3892, 2778, 2779, 3428, 3265, 3515, 3311, 3911, 3581, 3842, 1889, 2327, 3550, 3960, 4028, 3824, 3966, 2663, 3022 and others</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Supported methods: REGISTER, INVITE, reINVITE, ACK, PRACK, BYE, CANCEL, UPDATE, MESSAGE, INFO, OPTIONS, SUBSCRIBE, NOTIFY, REFER</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Audio codec: PCMU, PCMA, <b>G.729</b>, GSM, iLBC, SPEEX, <b>OPUS</b></span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>RTC Video codec: H264, VP8 (optional as-is)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>HD Audio: Wideband, <b>ultra-wideband</b> and full-band codecs (speex, opus)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Audio enhancements: PLC (packet loss concealment), <b>AEC</b> (acoustic echo canceller), Noise suppression, Silence suppression, AGC (automatic gain control), VAD (voice activity detection), audio focus and auto QoS (quality of service)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>Conference</span></b><span style='font-style:normal'> calls (built-in RTP mixer)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>Voice recording</span></b><span style='font-style:normal'> (SIPREC, local, FTP or HTTP upload in wav, gsm or ogg format), SIPREC, custom audio streaming (to external app or service)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>DTMF (SIP INFO method in signaling, RFC 2833, In-Band)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>IM/Chat</span></b><span style='font-style:normal'> (RFC 3428), offline chat support (caching messages when peer is not online), group chat</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>IMS/3GPP (basic compatibility and features such as USSD and 3GPP SMS)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>Presence</span></b><span style='font-style:normal'> capability and <b>BLF</b> (busy lamp field)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Redial, call <b>hold</b>, MOH (music on hold), mute, <b>forward</b> and <b>transfer</b> (attended and unattended) </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Call park and pickup, barge-in</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Additional call features: call fork, re-INVITE, 3PCC, ED-137, early media, local ring-back, PRACK and 100rel, replaces</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Balance display, call timer, inbound/outbound calls, Caller-ID display, <b>voicemail</b> (MWI)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Support for credit (balance) and call rating display</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Custom ringtone</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Contact management</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Auto handle phone power state, idle state, charging and airplane mode</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Call optimizations such as proximity sensor, WiFi lock/reconnect and optimal wake-looks (CPU/keyboard/screen)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Native call integration support (including ConnectionService support; optional for custom builds since it requires more permissions)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Unlimited lines, multiple accounts</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Support for run as service with minimal battery usage (including bypassing background service limitations)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Support for <b>push notifications</b></span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>A long list of other features (see the parameter list and the API for the details)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Flexibility (all parameters/behavior can be changed/controlled by settings and/or the API)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>Auto adapt</span></b><span style='font-style:normal'> to hardware: auto turn on/off features based on CPU type and RAM size, so it will run also on low-end hardware</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>Reliable incoming calls</span></b><span style='font-style:normal'> with all-time availability using improved service mode and/or push to handle situations where your device or app is closed, <b>standby</b> or the device is in <b>doze</b> or <b>sleeping</b> state</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Auto adapt to networking circumstances: different codec parameters and prioritization based on network type (WiFi/3G/LTE/others) and quality (bandwidth/packet loss/jitter)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Stable high-level API: Always backward and forward compatible including the parameters and the API (you don’t need to change your code when upgrading to new versions)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc506369846">Licensing</a></h1> </div> <p class="MsoNormal"><br> <span style='font-style:normal'>The Mizu Android Java VoIP SDK (AJVoIP) is sold with life-time unlimited client license (Advanced and Gold) or restricted number of licenses (Basic and Standard). You can use it with any VoIP server(s) which belongs to you or your company. Your VoIP server(s) address (IP or domain name) will be hardcoded into the software to protect the licensing. You can find the licensing possibilities on the </span><a href="https://www.mizu-voip.com/Software/SIPSDK/AndroidSIPSDK.aspx"><span style='font-style:normal'>Android SIP SDK</span></a><span style='font-style: normal'> page. After successful tests please ask for your final version at </span><a href="mailto:info@mizu-voip.com"><span style='font-style:normal'>info@mizu-voip.com</span></a><span style='font-style:normal'>. Mizutech will deliver the AJVoIP build (your licensed copy) within one workday on your payment.<br> <br> Release versions don’t have any of the demo limitations and can be fully customized with your branding with “mizu”, “mizutech” words, links and all reference to Mizutech removed. Your final build must be used only for you company needs (including your direct sip endusers and VoIP clients).</span></p> <p class="MsoNormal"><span style='font-style:normal'>The library doesn’t have any external dependencies (everything it requires is within the .aar / .jar file).</span></p> <p class="MsoNormal"><span style='font-style:normal'>Title, ownership rights, and intellectual property rights in the Software shall remain with MizuTech and/or its suppliers.<br> The agreement and the license granted hereunder will terminate automatically if you fail to comply with the limitations described herein. Upon termination, you must destroy all copies of the Software. The software is provided "as is" without any warranty of any kind.</span></p> <p class="MsoNormal"><span style='font-style:normal'>You may:</span></p> <p class="MsoNormal" style='margin-left:.5in'><span style='font-style:normal'>Use AJVoIP on any number of devices or as permitted by your license<br> Use AJVoIP as an SDK embedded in your Android project<br> Use AJVoIP with VoIP servers for which you have license for (after the agreement with Mizutech). All the VoIP servers must be owned by you or your company. Otherwise please contact our support to check the possibilities (the Gold license allows 10+ or freely configured SIP server address)</span></p> <p class="MsoNormal"><span style='font-style:normal'>You may not:</span></p> <p class="MsoNormal" style='margin-left:.5in'><span style='font-style:normal'>Resell AJVoIP<br> Use AJVoIP with VoIP servers not communicated with Mizutech, except Gold license<br> Reverse engineer, decompile, disassemble or modify the software in any way (except modifying the parameters and using it via the public API)</span></p> <p class="MsoNormal"><u><span style='font-style:normal'>Demo version</span></u><span style='font-style:normal'>:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>We are providing a demo version which you can try and test before any payment. The demo version has all features enabled but with some restrictions to prevent commercial usage. The limitations are the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>maximum 10 simultaneous AJVoIP instances in the same time</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>will expire after several months of usage (usually 2-8 months, depending on the last release date)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>maximum ~100 sec call duration restriction </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>maximum 10 calls / session limitation (after 10 calls you will have to restart)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>will work only maximum 20 minutes and after that you have to restart the AJVoIP library or your application</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>verifications against the mizu license service</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: for the first few calls there might be fewer limitations than described above.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>All the above limitations are removed from your licensed copy. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>On your </span><a href="mailto:info@mizu-voip.com?subject=AJVoIP%20trial"><span style='font-style: normal'>request</span></a><span style='font-style:normal'> we can also send a trial version (will expire after some time but doesn’t have the above demo limitations).</span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc506369847"></a><a name="_API"></a>API</h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can use AJVoIP as an SDK by embedding into your Android application and calling its public API functions. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Add AJVoIP.aar or AJVoIP.jar to your project and use the following import statement in your code:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='color:#984806;font-style:normal'>import com.mizuvoip.jvoip.*;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The whole API is defined in the SipStack class for ease of use.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For maximum flexibility, the Android SIP SDK exposes numerous functions, however this doesn’t mean that the usage is difficult. You can ignore most of them and use only those few relevant for your needs also outlined in the usage <a href="start.htm#_Example_code">example</a>. </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For example if you just need to make simple calls, then the following five functions will cover all your needs: Init, SetParameters, Start, Call, Hangup.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border:solid #C0504D 1.0pt;border-left:solid #C0504D 6.0pt; padding:0in 4.0pt 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h2 style='margin-left:0in'><a name="node0" id="node0"></a><span style='font-size:12.0pt;line-height:112%'>General considerations</span></h2> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>All API calls are <b>thread safe</b> and will <b>not throw exceptions</b> (on exception or error they will send “ERROR” notifications and/or return false/-1 depending on the context). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>API calls never returns null (in case of strings you will always receive an empty string return value when needed instead of null). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Most of the functions <b>return a boolean</b> value. True when the operation was completed or initiated successfully, otherwise false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Most of the functions are executed <b>asynchronous</b>ly (non-blocking) such as the Call and Register. This means that it can return a true value immediately and fail later. For example for the Call function the return value means only that the call was initiated successfully. At this point we don’t know if the call will be successful (connected) or not (rejected or failed). You can get the call status by parsing the notification messages or you can periodically poll AJVoIP status with the GetStatus function.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The <b>line</b> parameter is part of most of the functions and it means the channel number to be used if you wish to select a specific session. <br> For simple use cases usually you just have to set it to <b><span style='color:#984806'>-1</span></b>. For the details, see the “</span><a href="start.htm#_Line_parameter"><span style='font-style:normal'>Line parameter</span></a><span style='font-style:normal'>” and the “</span><a href="start.htm#_Multiple_lines"><span style='font-style:normal'>Multiple lines</span></a><span style='font-style: normal'>” FAQ points.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:solid #C0504D 1.0pt;border-left:solid #C0504D 6.0pt; padding:0in 4.0pt 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h2 style='margin-left:0in'><a name="_Toc506369848"></a><a name="_Toc255049843"></a><a name="_Functions"></a>Functions</h2> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The list of public functions exported by the SipStack class are described below:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node1" id="node1"></a>SipStack()</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Constructor. Create new SIP stack instance by creating a new SipStack object:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> <span style='color:#984806'>SipStack mysipclient = new SipStack();</span></span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'> </p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node2" id="node2"></a>boolean Init(Context context_in)</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Initialize the SIP engine. This is the very first function you must call to initialize the internal data structures. </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>The context_in parameter is your application </span><a href="https://developer.android.com/reference/android/content/Context.html"><span style='font-style:normal'>Context</span></a><span style='font-style:normal'> which can be obtained from any activity or as described </span><a href="https://stackoverflow.com/questions/2002288/static-way-to-get-context-on-android"><span style='color:windowtext;font-style:normal'>here</span></a><span class="MsoHyperlink"><span style='color:windowtext;font-style:normal'>.</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="_boolean_API_SetParameter(String_par"></a><a name="_boolean_SetParameter(String_param,"></a>boolean SetParameter(String param, String value)</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Configure the Android SIP library by passing any settings.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>The full list of available parameters are listed </span><a href="start.htm#_Parameters"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Example: </span><span style='font-size:9.0pt; color:#548DD4;font-style:normal'>wobj.SetParameter("loglevel", 5);</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt'>Notes: </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt'>Some basic parameters should be set before the Start function have been called (such as “register”), however most parameters can be also changed at run-time.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt'>Some advanced parameters can be set also by line using the </span><a href="start.htm#_Miscellaneous"><span style='font-size:9.0pt'>SetLineParameter</span></a><span style='font-size:9.0pt'> function (for advanced users only; use the other API functions instead to control the </span><a href="start.htm#_Multiple_lines"><span style='font-size:9.0pt'>individual lines</span></a><span style='font-size:9.0pt'>).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="_boolean_SetParameters(String_parame"></a>boolean SetParameters(String parameters)</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>You can pass a set of parameters with this function in value=key lines separated by CRLF (\r\n). </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>It has the same effect like the above SetParameter function, but uses a list of parameters at once instead of setting them individually.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>See the full list of supported parameters </span><a href="start.htm#_Parameters"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Example: </span><span style='font-size:9.0pt; color:#548DD4;font-style:normal'>mysipclient.SetParameters("loglevel=5\r\ndtmfmode=1\r\n");</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node3" id="node3"></a>boolean SetCredentials(String server, String username, String password, String authname, String displayname)</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Will set the SIP server address (ip:port or domain:port) the SIP username and the password. These values can also be preset by parameters. Parameters with empty strings will be omitted. For example if you would like to change only the username and the password, you can write SetCredentials(“”,”newusername”, “newpassord”)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>If authname is empty, then the username will be used for authentications. The displayname is usually empty (no special displayname will be presented for peers). If other parameters are empty, then they can be specified by user input (If the Android SIP SDK has a visible user interface).</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Note: you can also use the SetParameter(s) to initialize the SDK with the credentials.</span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node4" id="node4"></a>boolean SetCredentialsMD5(String server, String username, String md5, String realm)</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Instead of passing the password directly you can use MD5 checksum.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>In this case the md5 parameter must be the md5 checksum for username:realm:password</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>The realm parameter is optional (can be set as an empty string) but it is recommended for easy error detection. If present and the server realm don’t match with this one, an error message will be displayed by AJVoIP.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_Start()"></a>boolean Start()</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Will start the SIP engine (starting the internal main thread).</span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node5" id="node5"></a>boolean StartStack()</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>This function call is optional to start the sip stack on demand.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>If not called, then the sip stack is started anyway if the “startsipstack” parameter is set, otherwise will start at first registration or outgoing call attempt.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_Register()"></a>boolean Register()</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Will connect to the SIP server. This can be also done automatically by parameter (“register”). This function have to be called only once at the startup. Further re-registrations are done automatically based on the “registerinterval” parameter. When called subsequently, the old registrar endpoint is deleted, a new one will be created with a new call-id and AJVoIP will reregister. </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Even if you wish to force re-registration, you should not call this more frequently than 40 seconds (because up to 40 seconds might be needed for a slow registration attempt)</span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node6" id="node6"></a>boolean Register(String server, String username, String password, String authname, String displayname)</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Same as the above but with parameters. Otherwise you can set the credentials with the SetParameter(s) function before to call Register().</span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_RegisterEx(String_accounts)"></a>boolean RegisterEx(String accounts)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> You can use this function to register multiple secondary accounts (up to 99) on the same or other servers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> The accounts parameter must have the following format: server,usr,pwd,…;server2,usr2,pwd2,…;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> See the </span><a href="start.htm#_Multiple_account_registration_1"><span style='font-style:normal'>Multiple account registration</span></a><span style='font-style:normal'> FAQ for more details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node7" id="node7"></a>boolean Unregister()</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Will stop all endpoints (hangup current calls if any and unregister)</span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_CheckVoicemail(int_line)"></a>boolean CheckVoicemail(int line)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Will (re)subscribe for voicemail notifications. No need to call this function if the “voicemail” parameter is set to 2. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The line parameter should be set to -1.</span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="_boolean_SetLine(int_line)"></a>boolean SetLine(int line)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Will set the current channel. (Use only if you present line selection for the users. Otherwise you don’t have to take care about the lines).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Note: Instead of using each API call with the line parameter, you can just use this function when you wish to change the active line and use all the other API calls with -1 for the line parameter.</span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="_int_GetLine()"></a>int GetLine()</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Will return the current active line. This should be the line which you have set previously except after incoming and outgoing calls (the SIP client will automatically switch the active line to a new free line for these if the current active line is already occupied by a call)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="_int_GetLineStatus(int_line)"></a>int GetLineStatus(int line) <span style='color:black;font-weight:normal'>or</span> string GetLineStatusText(int line)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Query the status of the line.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'>Note: this is rarely needed since you receive the status also by event notifications</p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="node8" id="node8"></a>String GetLineDetails(int line) </h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Get details about a line. The line parameter can be -1 (will return the “best” line status).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Will return the following string:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='color:#984806;font-style:normal'>LINEDETAILS,line,state,callid,remoteusername,localusername,type,localaddress,serveraddress,mute,hold,remotefullname</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>Line</span></b><span style='font-style:normal'> line number (might be useful if you pass -1 as line parameter</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>State</span></b><span style='font-style:normal'> same as in STATUS notification</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>CallID</span></b><span style='font-style:normal'>: SIP session id (SIP call-id)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>Remoteusername</span></b><span style='font-style: normal'> is the other party username (if any)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>Localusername</span></b><span style='font-style:normal'> is the local user name (or username).</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>Type</span></b><span style='font-style:normal'> is 1 from client endpoints and 2 from server endpoints.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>Localaddress</span></b><span style='font-style:normal'>: local IP:port</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>Serveraddress</span></b><span style='font-style:normal'>: remote IP:port</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>Mute</span></b><span style='font-style:normal'>: is muted status. 0=no,1=undefined,2=hold,3=other party hold,4=both in hold (or if you wish to simplify: 0 means no, others means yes)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>Hold</span></b><span style='font-style:normal'>: is on hold status: 0=no,1= undefined,2=hold,3=other party hold,4=both in hold (or if you wish to simplify: 0 means no, others means yes)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>Remotefullname </span></b><span style='font-style: normal'>is the other party display name if any</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="_boolean_Call(int_line,"></a>boolean Call(int line, String peer)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Initiate call to a number or sip username.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>If the peer parameter is empty, then will redial the last number.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;color:black;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black'>Example: </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";color:gray; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806'>mysipclient.Call(-1,</span><span style='font-size:11.0pt'> </span><span style='color:#984806'>"004401234567"); </span><span style='color:gray'>//call to phone number on the default line</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";color:#984806; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806'>mysipclient.Call(2,</span><span style='font-size:11.0pt'> </span><span style='color:#984806'>"bob"); </span><span style='color:gray'>//call to sip username on the second line</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;color:black;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black'>It is recommended to pass only the peer number, extension or username to this function and not the full SIP URI (the SIP stack will construct the full SIP URI with the serveraddress already set)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;color:black;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black'>This function is for normal audio calls. For video use the </span><a href="start.htm#_boolean_VideoCall(String_destinatio">VideoCall</a><span style='color:black'> API.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_Hangup(int_line,"></a>boolean Hangup(int line, String reasontext)</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Disconnect current call(s). If you set -2 for the line parameter, then all calls will be disconnected (in case if there are multiple calls in progress). The “reasontext” parameter is optional.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_Accept(int_line)"></a>boolean Accept(int line)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Connect incoming call.</span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_Reject(int_line)"></a>boolean Reject(int line)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Disconnect incoming call. (Hangup will also work)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node9" id="node9"></a>boolean Ignore(int line)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Ignore incoming call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_Forward(int_line,"></a>boolean Forward(int line, String peer)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Forward incoming call to peer (with 302 Moved Temporarily disconnect code)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_Transfer(int_line,"></a>boolean Transfer(int line, String peer)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Transfer current call to peer which is usually a phone number or a SIP username. (Will use the REFER method after SIP standards).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>You can set the mode of the transfer with the “transfertype” parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>If the peer parameter is empty than will interconnect the currently running calls (should be used only if you have 2 simultaneous calls)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node10" id="node10"></a>boolean SetSpeakerMode(boolean loud)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Switch between speakerphone and loudspeaker.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Set to loud parameter true if you wish to set to speaker/loudspeaker. Otherwise false for normal earspeaker/earpiece.</span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_Mute(int_line,"></a>boolean Mute(int line, boolean mute, int direction)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Mute current call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The line parameter is the endpoint. -2 for all or -1 for current line.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Set the mute parameter to </span><span lang="HU" style='font-style:normal'>true for mute or false to un-mute.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The direction can have the following values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>0: mute in and out </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>1: mute out (speakers)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>2: mute in (microphone)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>3: mute in and out (same as 0)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>4: mute default (set by the “defmute” parameter, which is “mute microphone only” by default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node11" id="node11"></a>int IsMuted(int line)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Return if the selected line is muted or not.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Return values:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>-1: unknown</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>0: not muted</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>1: both muted (in/out)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>2: out muted (speaker)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>3: in muted (microphone)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>4: both muted (in/out; same as 1)</span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_Hold(int_line,"></a>boolean Hold(int line, boolean hold)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Hold current call. This will issue an UPDATE or a reINVITE.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Set the second parameter to true for hold and false to reload.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node12" id="node12"></a>int IsOnHold(int line)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Query if the selected line is on hold or not</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Return values:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>-1: unknown</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>0: no</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>1: not used</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>2: on hold </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>3: other party held</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>4: both in hold</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:4.3pt;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt'> Note: pass -2 for the line to find if any endpoint is in hold</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node13" id="node13"></a>boolean Conf(String peer)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Add people to conference.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>If peer is empty than will mix the currently running calls (if there is more than one call)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Otherwise it will call the new peer (usually a phone number or a SIP user name) and once connected will join with the current session.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node14" id="node14"></a>boolean ConfEx(int line, String peer, boolean add)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Add/remove people or line to conference.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>If peer is empty than:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'> -if add is true:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-style:normal'>-if line is -2 then it will mix all the currently running calls (if there is more than one call)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-style:normal'>-if line is not -2, then it will add the channel to the conference</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> -if add is false:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> -if line is -2 then it will destroy the conference (but will keep the calls on individual lines)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> -if line is not -2 then it will remove the selected line from the conference</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Otherwise it will call the new peer (usually a phone number or a SIP user name) and once connected will join with the current session.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_Dtmf(int_line,"></a>boolean Dtmf(int line, String dtmf)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Send DTMF message by SIP INFO, In-Band or RFC2833 method (depending on the “</span><a href="start.htm#_dtmfmode"><span style='font-style:normal'>dtmfmode</span></a><span style='font-style:normal'>” parameter). Please note that the dtmf parameter is a string. This means that multiple dtmf characters can be passed at once and the Android SIP library will streamline them properly. Use the space char to insert delays between the digits. The dtmf messages are sent with the protocol specified with the “dtmfmode” parameter.<br> </span><span style='font-size:9.0pt;color:black;font-style:normal'>Example:</span><span style='font-size:9.0pt;font-style:normal'> <span style='color:#984806'>Dtmf(-2,” 12 345 #”);</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:black'>Note: dtmf messages can be also sent by adding it to the called number after a comma. For example if you make a call to 123,456 then it will call 123 and then it will send dtmf 456 once the call is connected.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:black'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_Info(int_line,"></a>boolean Info(int line, String msg)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Send any SIP INFO message as defined in </span><a href="https://tools.ietf.org/html/rfc2976"><span style='font-style:normal'>RFC 2976</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Use this API to send any custom INFO messages to the server or to the connected peer (in case if your server will forward it to other peer and not discard it).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The msg string will be sent in the INFO body.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The Content-Type can be specified with the <span style='color:#984806'>infocontenttype </span>parameter. For example you might set the <span style='color:#984806'>infocontenttype </span>to “application/mydata”. If the <span style='color:#984806'>infocontenttype </span>is not set then it will be auto guessed as application/json, application/xml or application/octet-stream”</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Feedback about the message delivery can be received with the </span><a href="start.htm#_INFO,type,line,peername,text"><span style='font-style:normal'>INFO</span></a><span style='font-style:normal'> notifications.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#C0504D;font-style:normal'>Example:</span><span style='font-size:9.0pt;font-style:normal'> <span style='color:#548DD4'>Info(-2,”MyMessage”);</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:#548DD4;font-style: normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>For more details see the </span><a href="start.htm#_Custom_INFO_messages"><span style='font-style:normal'>Custom INFO messages</span></a><span style='color:black;font-style:normal'> FAQ point.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:black'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_Boolean_SendUSSD(int_line,"></a>boolean SendUSSD(int line, String method, String ussd)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Send an USSD message after the IMS </span><a href="https://www.etsi.org/deliver/etsi_ts/124300_124399/124390/12.01.00_60/ts_124390v120100p.pdf"><span style='font-style:normal'>3GPP TS 24.390</span></a><span style='font-style: normal'> standard.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The method parameter can be set to “INVITE”, “INFO” or “BYE”.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>If INVITE, then a new session will be created. Otherwise will use the session suggested by the line parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The ussd parameter have to be set to the USSD string (for example “*135#”) or whole XML (“<?xml version … “).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Will return true if send initialized successfully or false on failure. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Further feedback about the actual delivery or incoming ussd messages can be obtained from the </span><a href="start.htm#_USSD,line,status,text"><span style='font-style:normal'>USSD</span></a><span style='font-style:normal'> notifications.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>More details </span><a href="start.htm#_How_to_USSD"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_SendChat(int_line,"></a>boolean SendChat(int line, String peer, String message)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Send a chat message. (SIP MESSAGE method after RFC 3428)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Peer can be a phone number or SIP username/extension number.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Parse the CHAT notification to check if delivery succeeded or failed.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>On successful delivery you will also receive a log like: EVENT, chat sent successfully</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>On failed delivery you will also receive a log like: WARNING, chat message not delivered</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>You can also send typing notifications with the SendChatIsComposing API.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_Boolean_SendSMS(int_line,"></a>boolean SendSMS(int line, String peer, String message)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Send a SMS message if softswitch has SMS delivery capabilities (Otherwise might try to deliver as IM).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The message is delivered as a 3GPP SMS, SMS HTTP API request or a standard SIP MESSAGE with X-Sms: Yes header (in this case the server is responsible to convert it to SMS).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Note: incoming SMS messages are reported as </span><a href="start.htm#_CHAT,line,peername,text"><span style='font-style:normal'>CHAT notifications</span></a><span style='font-style: normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="_boolean_VideoCall(String_destinatio"></a>boolean VideoCall(String destination, int fragmentResId, FragmentActivity fragmentinstance)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Initiate RTC video call to destinationnumber which can be a number, username or SIP URI.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The fragmentResId is the Integer resource ID of the FrameLayout in which the video fragment will be loaded.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The fragmentinstance is the instance of the Activity in which the video module will be displayed. The video module consists of an android </span><a href="https://developer.android.com/reference/android/app/Fragment"><span style='font-style:normal'>Fragment</span></a><span style='font-style:normal'> and the FragmentActivity will be its parent.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Place the <FrameLayout> in your Activity's content XML.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='color:#984806;font-style:normal'><FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='color:#984806;font-style:normal'> android:id="@+id/fragment_container"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='color:#984806;font-style:normal'> android:layout_width="fill_parent"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='color:#984806;font-style:normal'> android:layout_height="350dp" /></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>In the above example the resource ID will be: <span style='color:#984806'>R.id.fragment_container</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>RTC capabilities must be available for the video to work. More details </span><a href="start.htm#_RTC_video"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="_boolean_AcceptVideo(int_fragmentRes"></a>boolean AcceptVideo(int fragmentResId, FragmentActivity fragmentinstance)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Accept RTC video call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The fragmentResId and fragmentinstance is as described at the VideoCall API above.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>If video interface is not loaded yet, then will initiate it now and call back. If incoming call is not with video, then it might result in simple audio call.</span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="_boolean_RemoveVideo()"></a>boolean RemoveVideo()</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Will remove the video fragment (will also disconnect pending video call if any).</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'>Instead of this function, you should just hide/destroy your video container element from the user interface.</p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'>More details can be found <a href="start.htm#_How_to_close_1">here</a>.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node15" id="node15"></a>boolean SetVideoDisplaySize(int type, int width, int height)</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Use this function to control the video display size (both for remote and local video).</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Accepted parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>type: 1=for remote video container, 2=for local video container</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>width: width in pixels</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>height: height in pixels; this parameter can be 0, and the height will be set depending on the video's aspect ratio</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_VoiceRecord(int_startstop,"></a>boolean VoiceRecord(int startstop, int now, String filename)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Will start/stop a voice recording session.</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Startstop: 0 to stop, 1 to start locally, 2 to start remote ftp, 3 start to record both locally and to remote ftp, 4 start to record as it is set by the “voicerecording” parameter</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Now: used if the startstop is set to 0. 0 means that the recorded file will be saved and/or uploaded at the end of the conversation only. 2 means that the file will be saved immediately</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Filename: file name used for storing the recorded voice (if empty string, than will use a default file name)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'>This function should be used only if you would like to control the recording duration. </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'>If all conversations have to be recorded, then just set the “<a href="start.htm#_voicerecording">voicerecording</a>” parameter after your needs.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'>The last recorded call can be played by calling the PlaySound with the file set to “lastvoicerecord”.</p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_API_PlaySound(int_start,"></a><a name="_boolean_PlaySound(int_start,"></a>boolean PlaySound(int start, String file, boolean islocal, boolean toremotepeer, int line)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Play any sound file. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>At least wave files are supported in the following format: PCM SIGNED 8000.0 Hz (8 kHz) 16 bit mono (2 bytes/frame) in little-endian (128 kbits).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>This function can be used to play audio locally, but also for remote streaming.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>For remote playback, make sure to force a narrowband codec if your file is narrowband and wideband codec (speex, opus) if your file is wideband (16 kHz, 16 bit mono in little-endian).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The file must be found locally.</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>start: 1 for start or 0 to stop the playback, -1 to pre-cache</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>file: file name</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>islocal: true if the file have to be read from the device file system. False if remote file (for example if the file is on the webserver)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>toremotepeer: stream the playback to the connected peer</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>line: used with toremotepeer if there are multiple calls in progress to specify the call (usually set to -1 for the current call if any)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>For remote playback you can pass any file path which can be passed for FileInputStream as our code uses FileInputStream to load the file like this: </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806'>FileInputStream fileinputstream = new FileInputStream(file);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Examples:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>-playback a file locally (mysound.wav must):</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>PlaySound(1, "mysound.wav", false, false, -1)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>-playback a file to the connected remote peer (mysound.wav must exist):</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>PlaySound(1, “mysound.wav", false, true, -1)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>-stop the playback:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>PlaySound(0, "", false, false, -1)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>In case if you just want to play a file locally, then you can do it also directly from your code like this:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806'>MediaPlayer mp = MediaPlayer.create(appcontext, Uri.parse(file));</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806'>mp.start();</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_boolean_StreamSoundBuff(int_start,"></a>boolean StreamSoundBuff(int start, int line, byte[] buff, int len)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Stream from PCM audio buffer or from RTP packets.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>This function will stream the supplied audio buffer to the peer endpoint, transcoding if necessary.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>start: 1 for start or 0 to stop the playback</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>line: specify the channel in case if there are multiple calls in progress (usually set to -1 for the current call if any)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>buff: audio buffer (raw PCM data or RTP packet)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>len: length of the buff (ideally it should be multiple of 360 if raw pcm or the size of the RTP packets which are to be passed separately)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'>Notes:</p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span>The buff should not contain any file header if you are using raw PCM (only raw linear PCM audio data) or it should contain a full RTP packet (with the RTP header) if you are passing RTP data.</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span>You might set the “useaudiodevicerecord” parameter to “false” if you need streaming but don’t have an audio recorder device installed.</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span>If previously supplied buffer(s) are not completed yet, then the new one will be queued </p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span>Alternatively you can use the StreamSoundStream function to pass an InputStream instead of buff and len.</p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span>In case if you wish to receive the audio stream from the remote peer endpoint, see <a href="start.htm#_How_to_get">this FAQ point</a> instead.</p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Buffer/stream format:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>At least raw linear PCM is supported in the following format: PCM SIGNED 8000.0 Hz (8 kHz) 16 bit mono (2 bytes/frame) in little-endian (128 kbits). In case if your buffer is narrowband (8 kHz 16 bit mono), then the stream will be automatically converted to wideband if the VoIP audio codec is wideband such as opus or speex. In case if your buffer is wideband (16 kHz 16 bit mono) then you should set the <span style='color:#984806'>playbacksteamformat </span>parameter to <span style='color:#984806'>1</span> to allow auto conversion to narrowband if the VoIP audio codec is narrowband such as G.711 (PCMU, PCMA), G.729 or GSM.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>The function can accept also RTP packets and will transcode them if necessary. Set the <span style='color:#984806'>streamsoundisrtp </span>parameter to <span style='color:#984806'>-1 </span>to auto-guess raw PCM vs RTP (this is the default value), set to <span style='color:#984806'>0</span> if you supply raw PCM buffer or set to <span style='color:#984806'>1</span> if you supply RTP packets.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="_byte[]_GetMedia(int_timeout)"></a>byte[] GetMedia(int timeout)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Retrieve the next media (audio or video) packet as a byte buffer from the AJVoIP internal queue. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The buffer format (prefix bytes) can be specified with the related sendmedia_... parameters as described in the </span><a href="start.htm#_How_to_get"><span style='font-style:normal'>streaming FAQ</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>This is a blocking function call, so you should call it from a separate thread. </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>The timeout can be specified in milliseconds. If it is higher then 0, then AJVoIP will use an additional waiting lock. If 0 then will issue a simple/fast blocking read. </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>The internal queue size is 900 and on overflow it will remove all queued packets (if you are not calling this function or not fast enough).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>The internal media packets queueing will start only if the <span style='color:#984806'>sendmedia_mode </span>is set to 2 or 3 or at first call to this function. </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>(The first call for this function will also set the sendmedia_mode parameter to 2 or 3 if it was not set before)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>If you don’t need media streaming anymore, then you might call the <span style='color:#984806'>GetMediaEnd() </span>function to stop queuing any more media packets, otherwise it will stop automatically after some time of no usage or overflow. </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>The receive byte buffer might contain some header bytes as specified by the </span><span style='color:#984806;font-style:normal'>sendmedia_</span><span style='color:black;font-style:normal'> parameters.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>For more details see the </span><a href="start.htm#_How_to_get"><span style='font-style:normal'>streaming FAQ</span></a><span style='font-style:normal'>. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node16" id="node16"></a>boolean SetVolume(int dev,int volume, int line)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Set volume (0-100%) for the selected device.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The dev parameter can have the following values:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-style:normal'>0 for the recording (microphone) audio device</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-style:normal'>1 for the playback (speaker) audio device</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-style:normal'>2 for the ringback (speaker) audio device</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> The line is an optional parameter to be used only if you need different volume for separate calls. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span><span style='font-size:9.0pt'>Note: The ringer volume might not be always honored and might not change during ring playback.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node17" id="node17"></a>int GetVolume(int dev, int line)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Return the volume (0-100%) for the selected device.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The dev parameter can have the following values:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-style:normal'>0 for the recording (microphone) audio device</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-style:normal'>1 for the playback (speaker) audio device</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-style:normal'>2 for the ringback (speaker) audio device</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> The line is an optional parameter to query the volume of a specific call line in case if you set the volume per call. Otherwise don’t use or set to -2.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node18" id="node18"></a>boolean SetIdle(boolean idle)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>You might use this API to further extend the battery life (above the usual phone power state changes).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The sipstack internally has an idle state which can be useful to decrease CPU and RAM usage by using less resources, slowing down all operations, running threads in low priority and increases internal timer intervals. This means that the app can enter in idle state even if running in foreground on a non-sleeping phone state (but with no user interaction and no important task running such as an ongoing call)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>You should call this function with the idle parameter set to true if the screen is dimmed/off, there is no call and no user interaction with the application for a while. Call with the idle parameter set to false when the user begins any interaction with the application. The sipstack will also automatically disable the idle state when there is a new incoming call, chat or other important event that might require user interaction or CPU resources.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_String_VAD()"></a>String VAD()</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:4.3pt;margin-bottom:.0001pt;text-indent:31.7pt;line-height:normal'><span style='font-size:9.0pt'>Returns voice activity statistics. See the VAD notification for more details.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:4.3pt;margin-bottom:.0001pt;text-indent:31.7pt;line-height:normal'><span style='font-size:9.0pt'>For this to work you should set the vad parameter to at least 2 (4 for full report).</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:4.3pt;margin-bottom:.0001pt;text-indent:31.7pt;line-height:normal'><span style='font-size:9.0pt'>Note: if you call this function, VAD notifications will not be sent automatically anymore. (So you will need to continue to poll for the details).</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:4.3pt;margin-bottom:.0001pt;text-indent:31.7pt;line-height:normal'><span style='font-size:9.0pt'>More details </span><a href="start.htm#_Voice_activity_detection_1"><span style='font-size:9.0pt'>here</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_String_RTPStat()"></a>String RTPStat()</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:4.3pt;margin-bottom:.0001pt;text-indent:31.7pt;line-height:normal'><span style='font-size:9.0pt'>Returns media statistics. See the RTPSTAT notification for more details.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:4.3pt;margin-bottom:.0001pt;text-indent:31.7pt;line-height:normal'><span style='font-size:9.0pt'>For this to work you should set the vad parameter to at least 2 (4 for full report).</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:4.3pt;margin-bottom:.0001pt;text-indent:31.7pt;line-height:normal'><span style='font-size:9.0pt'>Note: </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:4.3pt;margin-bottom:.0001pt;text-indent:31.7pt;line-height:normal'><span style='font-size:9.0pt'>RTP statistics can be sent also automatically if you set the rtpstat parameter.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:4.3pt;margin-bottom:.0001pt;text-indent:31.7pt;line-height:normal'><span style='font-size:9.0pt'>if you call this function, RTPSTAT notifications will not be sent automatically anymore</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:4.3pt;margin-bottom:.0001pt;text-indent:31.7pt;line-height:normal'><span style='font-size:9.0pt'>More details </span><a href="start.htm#_Media_statistics"><span style='font-size:9.0pt'>here</span></a><span class="MsoHyperlink"><span style='font-size:9.0pt'>.</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node19" id="node19"></a>string GetVersion()</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Return the program version number.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="node20" id="node20"></a>String GetStatus(int line, int strict)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Returns line status or global status if you pass -2 as line parameter. The possible returned texts are the same like for notifications (listed below).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>If the strict variable is set to 1, then it will return “Unknown” if no such line is activated. If the strict variable is set to 0, then it will return the default active line if the line doesn’t exists.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'> You should use the notifications described below to get the actual status of AJVoIP instead of continuously polling it with this function call.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="node21" id="node21"></a>boolean SetNotificationListener(SIPNotificationListener listener)</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Subscribe to notification events.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Create a subclass of the AJVoIP SIPNotificationListener first, then pass this object as a listener. </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>You will receive the SIPNotification objects overriding the member functions. </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>More details:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_Notifications"><span style='font-style:normal'>Notifications</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html"><span style='font-style:normal'>Javadoc</span></a><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_Example_code"><span style='font-style:normal'>Code template</span></a></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.mizu-voip.com/Portals/0/Files/AJVoIPTest.zip"><span style='font-style:normal'>Full/working example code</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="_String_GetNotifications()"></a>String PollNotificationStrings ()</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'>Should be used only if you wish to receive the notifications as strings. <br> Use the SetNotificationListener() instead to receive SIPNotification objects instead of strings. <br> <br> </p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Return the notification strings. You should poll for the notifications periodically from a separate thread. It will return accumulated events since the last function call (notifications separated by \r\n -CRLF). </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>More details </span><span style='font-style:normal'>here</span><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt'>Note:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Once a notification string have been read then it will be cleared from the internal list, so it is guaranteed that you will never receive duplicates.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>The old function name as GetNotifications which was renamed for more clarity (the old way will still be kept)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="_String_GetNotificationsSync()"></a>String GetNotificationStrings ()</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'>Should be used only if you wish to receive the notifications as strings. <br> Use the SetNotificationListener() instead to receive SIPNotification objects instead of strings.</p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> Same as above PollNotificationStrings(), but will blocking wait for data (more efficient) and it should be used from a separate thread.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span><span style='font-size:9.0pt'>The old function name as GetNotificationsSync which was renamed for more clarity (the old way will still be kept)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <p class="MsoNormalCxSpMiddle" style='margin-top:10.0pt;margin-right:0in; margin-bottom:5.0pt;margin-left:0in;line-height:normal;border:none;padding: 0in'><b><span style='font-size:11.0pt;font-family:"Cambria",serif;color:#943634'>SIPNotification PollNotification()</span></b></p> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'>Use the SetNotificationListener() instead to receive the notifications as objects instead of strings.</p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> Same as above PollNotificationStrings(), but will return a SIPNotification object instead of string. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <p class="MsoNormalCxSpMiddle" style='margin-top:10.0pt;margin-right:0in; margin-bottom:5.0pt;margin-left:0in;line-height:normal;border:none;padding: 0in'><a name="_Notification_API_ParseNotification_"></a><b><span style='font-size:11.0pt;font-family:"Cambria",serif;color:#943634'>SIPNotification ParseNotification (String notificationstring)</span></b><b><span style='font-family:"Cambria",serif;color:#943634;font-style:normal'> </span></b></p> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> Convert a notification string to a SIPNotification object. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> Useful only if you receive the notifications as strings (instead of SIPNotification objects which is recommended).</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>More details </span><span style='font-style:normal'>here</span><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="_boolean_SetPushNotification(int_pus"></a>boolean SetPushNotifications(int pushnotifications, String clientid, String packagename, String gateway)</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> If you wish to use VoIP push notifications then you might use this function to have it assisted by the SIP SDK (otherwise you can implement it also separately in your code).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> Parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>pushnotifications: 0=disable,1=auto,2=direct,3=via gateway</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>clientid: your app token ID (FCM registration token returned by registering to the notification service)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>packagename: the package name of your application to be used for push notification. If empty then it will be read from your app context. If using mizu push gateway then you might leave it empty or set to "com.mizuvoip.mizudroid.app"</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>gateway: if your SIP server doesn’t support push notifications then you might use a gateway (the SIP stack will register also via this gateway)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>To activate push notifications, first you will need a </span><a href="https://console.firebase.google.com/"><span style='font-style:normal'>Firebase project</span></a><span style='font-style: normal'> and register to FCM from your own code as described </span><a href="https://firebase.google.com/docs/cloud-messaging/android/client"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Then once you call this function with the acquired client token id, the SIP stack will begin to send push bind request (extra SIP headers or tags in the REGISTER requests using the protocol specified by </span><a href="start.htm#_pushtype"><span style='font-style:normal'>pushtype</span></a><span style='font-style:normal'>).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This is required for the server side to learn your token and be able to send push notifications on incoming calls or chat.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The purpose of these notifications should be only to wake up your application if in background/sleeping mode, so it can start/register and process the incoming INVITE as normally. For chat message it should be enough if you just display the message and eventually store it (the user can launch your app by tapping on the displayed notification).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Start example: <span style='color:#984806'>SetPushNotifications(1, "TOKEN", "", "");</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Stop example: <span style='color:#984806'>SetPushNotifications(0, "", "", "");</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If you set the pushnotifications parameter to 1 (auto), then will try push with your server first (as described in RFC 8599 so your server must answer to REGISTER with Feature-Caps: *;+sip.pns="fcm") and if fails then it will try via push gateway.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For more details read </span><a href="start.htm#_VoIP_Push_notifications_1"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt'> <h5 style='margin-left:0in'><a name="node22" id="node22"></a>int GetPushNotifications()</h5> </div> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Returns the push notification subscription state from the SIP stack. This should be used only if you let the SIP stack to handle the push notifications for you by calling the above SetPushNotifications API first.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Possible return values:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>0: disabled (push notification disabled)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>1: enabled unknown (might work)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>2=success (push notification working)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings;font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>3=failed (push notification subscription failed)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Note: you can assume that push notifications are working if you were capable to subscribe to FCM and get a valid token AND the GetPushNotificatons function returns 2.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_Contacts"></a>Contacts</h5> </div> <p class="MsoNoSpacing"><span style='font-style:normal'>Contact management has little to do with the SIP stack and should be handled entirely </span><a href="start.htm#_Contact_management"><span style='font-style:normal'>by your application</span></a><span style='font-style:normal'> (except presence status). </span><span style='font-style:normal'>You can use the above AJVoIP API to add VoIP functionality to your address book or contact list and based on the user presence you can display the different buttons with your design. Near each contact you can display a call/chat button which will launch a voip endpoint instance preconfigured with the actual contact (“callto” parameter).</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>For the contact listing you can just use the native system phone-book or a separate contact list for your app if needed (or a mix of these).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For your convenience as an extra functionality the SDK also provides a simple contact management API which can be also used if for some reason you find it more suited for your needs, but in general we recommend to handle the contacts entirely in your own app since this task is more about user interface related development and less to do with the SIP specific API.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Contact parameters are stored as comma delimited strings with the following parameters:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>imstatus,name,sip,phone,phone2,phone3,othernumbers,sipcontacturi,email,web,address,speeddial,extra,internalextra</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean SetContacts(String contacts)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set all contacts (contact parameters separated by new line)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetContacts()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will return all contacts (in separated lines the parameters described above)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean DelContact(String name) </span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Delete contact.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean AddContact(String params) </span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Add a contact. Example: </span><span style='font-size:9.0pt;color:#984806;font-style:normal'>Add_Contact(‘,John Smith,jsmith,’); //here we set only the name and the SIP fields</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean SetContact(String name, String params)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Change contact.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetContact(String name)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will return a single contact in the format described above.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Helper functions to set/get individual fields:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-size:9.0pt;font-style:normal'>boolean SetContactName(String name, String param)</span></b></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'>Set contact name.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-size:9.0pt;font-style:normal'>boolean SetContactSIP(String name, String param) </span></b></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'>Set contact sip uri.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-size:9.0pt;font-style:normal'>boolean SetContactPhone(String name, String param)</span></b></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'>Set contact phone number.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-size:9.0pt;font-style:normal'>boolean SetContactSpeedDial(String name, String param) </span></b></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'>Set contact speed dial number (short number).</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-size:9.0pt;font-style:normal'>String GetContactName(String name)</span></b></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'>Get contact name.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-size:9.0pt;font-style:normal'>String GetContactSIP(String name) </span></b></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'>Get contact sip uri.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-size:9.0pt;font-style:normal'>String GetContactPhone(String name)</span></b></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'>Get contact phone number.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-size:9.0pt;font-style:normal'>String GetContactSpeedDial(String name) </span></b></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'>Get contact speed dial number (short number).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Example code for contact management can be found </span><a href="start.htm#_Contact_management"><span style='font-size:9.0pt;font-style:normal'>here</span></a><span style='font-size:9.0pt;font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_Presence"></a>Presence</h5> </div> <p class="MsoNoSpacing"><span style='font-style:normal'>Presence is based on SIP SIMPLE SUBSCRIBE/NOTIFY mechanism and it is used to detect the online status of the contacts.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>There is no need to manage the contacts within SIP endpoint (as described above) to have presence functionality (so you can manage the contacts externally in your application).</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>The following steps are required:</span></p> <p class="MsoNoSpacing" style='margin-left:.5in;text-indent:-.25in'><span style='font-style:normal'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Related settings:</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>enablepresence: 0/1</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>email = email address sent with contact info</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>presenceexpire = 3600</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>autoacceptpresencrequests = -1; //-1: not set (1), 0=auto reject all,1=ask for new users,2=yes, autoaccept new unknown users</span></p> <p class="MsoNoSpacing" style='margin-left:.5in;text-indent:-.25in'><span style='font-style:normal'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>First you should call PushContactlist to pass all the usernames and phonenumbers from your external contact list if any. This is necessary, because for existing contacts AJVoIP can accept the requests automatically, while for other it might ask for user permission</span></p> <p class="MsoNoSpacing" style='margin-left:.5in;text-indent:-.25in'><span style='font-style:normal'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>On first start you might call NumExists. If using the Mizu VoIP server, then it will return all existing contacts with SERVERCONTACTS,userlist notification where userlist are populated with the valid users and their online status.</span></p> <p class="MsoNoSpacing" style='margin-left:.5in;text-indent:-.25in'>4.<span style='font:7.0pt "Times New Roman"'> </span><span style='font-style:normal'>Call <a name="OLE_LINK2"></a><a name="OLE_LINK1">CheckPresence</a>(userlist). To save softswitch resources, you should carefully select the contacts. (Send only the contacts which are actually used and called numbers. We recommend up to 50 contacts. If the user select a contact, then you can call this function later with that single contact to request its status). </span><span style='color:#984806'>This function will start to send SUBSCRIBE requests</span>.</p> <p class="MsoNoSpacing" style='margin-left:.5in;text-indent:-.25in'>5.<span style='font:7.0pt "Times New Roman"'> </span><span style='font-style:normal'>Use the SetPresenceStatus(statustring) function call to change the user online status with one of the followings strings: Online, Away, DND, Invisible , Offline (case sensitive) . </span><span style='color:#984806'>This function will start to send NOTIFY requests to subscribed parties</span>.</p> <p class="MsoNoSpacing" style='margin-left:.5in;text-indent:-.25in'><span style='font-style:normal'>6.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Once these are done, the following notifications can be received from java sip stack:</span></p> <p class="MsoNoSpacing" style='margin-left:.5in'><span style='color:#984806; font-style:normal'>NEWUSER,peerusername,displayname,email,URI</span></p> <p class="MsoNoSpacing" style='margin-left:.5in'><span style='color:#984806; font-style:normal'>PRESENCE,peerusername,status,displayname,email</span></p> <p class="MsoNoSpacing" style='margin-left:.5in'><span style='font-style:normal'>(displayname and email can be empty)</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing" style='margin-left:.5in'><span style='font-style:normal'>On newuser, you should ask the user if wish to accept it. If accepted, call the NewUser function. The same function should be called when the user adds a new contact to its contactlist.</span></p> <p class="MsoNoSpacing" style='margin-left:.5in'><span style='font-style:normal'>For presence the following status strings are defined (be prepared to receive any of these and handle it with case insensitive by displaying red/green/gray/other icons):</span></p> <p class="MsoNoSpacing" style='margin-left:1.5in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Open/Online/Reachable/Available/Call Me/Registered [GREEN]</span></p> <p class="MsoNoSpacing" style='margin-left:1.5in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>DND (Do not disturb; halt popups and sounds) [RED]</span></p> <p class="MsoNoSpacing" style='margin-left:1.5in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Busy/Speaking (can be auto set) [ORANGE/YELLOW]</span></p> <p class="MsoNoSpacing" style='margin-left:1.5in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Pending/Forwarding [ORANGE/YELLOW]</span></p> <p class="MsoNoSpacing" style='margin-left:1.5in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Away/Idle [ORANGE/YELLOW]</span></p> <p class="MsoNoSpacing" style='margin-left:1.5in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Close/Unreachable/Offline/Unregistered [GREY/WHITE]</span></p> <p class="MsoNoSpacing" style='margin-left:1.5in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Unknown/Not Set [GREY/WHITE/NOCOLOR]</span></p> <p class="MsoNoSpacing" style='margin-left:1.5in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Invisible (no status notifications will be sent) [GREY/WHITE/NOCOLOR]</span></p> <p class="MsoNoSpacing" style='text-indent:.5in'><span style='font-style:normal'>Other suggestion for colors:</span></p> <p class="MsoNoSpacing" style='margin-left:1.5in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>red: busy/dnd</span></p> <p class="MsoNoSpacing" style='margin-left:1.5in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>bright green: online</span></p> <p class="MsoNoSpacing" style='margin-left:1.5in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>pale green: away/forwarding/pending</span></p> <p class="MsoNoSpacing" style='margin-left:1.5in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>white: user exists but unknown status or invisible</span></p> <p class="MsoNoSpacing" style='margin-left:1.5in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>no color: user doesn’t exists / no presence feature</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing" style='margin-left:.5in;text-indent:-.25in'><span style='font-style:normal'>7.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>You might use the UnSubscribe() API to unsubscribe all endpoints (this includes presence, voicemail and BLF subscribes).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_BLF"></a>BLF</h5> </div> <p class="MsoNoSpacing"><span style='font-style:normal'>BLF (Busy Lamp Field) can be used to monitor the state of an extension and it is implemented as SUBSCRIBE/NOTIFY with dialog event package as described in RFC 3265 and RFC 4235.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>Set the <span style='color:#984806'>enableblf </span>parameter to enable/disable BLF. The following values are defined:</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> 0: disable BLF</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> 1: auto (from here it will auto switch to 0 or 2 regarding the circumstances –whether BLF was initiated and succeed/failed)</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> 2: enable BLF</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> 3: force always (if you set to 3 then it can’t be switched off later and will use BLF even after failure)</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> Default value is 1.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>To subscribe to other extensions call state, you can set the <span style='color:#984806'>blfuserlist </span>parameter or use the <span style='color:#984806'>CheckBLF(userlist)</span> to subscribe to other extension(s) state changes (users separated by comma). To remove an extension, just modify the blfuserlist parameter or call the DisableBLF(userlist) API.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>Make sure that the other extension also has BLF support (so it can respond with NOTIFY for the BLF SUBSCRIBE).</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>Once the state of the remote extension(s) are changed, you will receive BLF notifications in this format:</span></p> <p class="MsoNoSpacing" style='text-indent:.5in'><span style='color:#984806; font-style:normal'>BLF,peerusername,direction,state,callid</span></p> <p class="MsoNoSpacing"><span style='color:black;font-style:normal'>Fields:</span></p> <p class="MsoNoSpacing" style='margin-left:.5in;text-indent:-.25in'><span style='font-family:Symbol;color:black;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black;font-style:normal'>BLF: </span><span style='color:black;font-style:normal'>state header string</span></p> <p class="MsoNoSpacing" style='margin-left:.5in;text-indent:-.25in'><span style='font-family:Symbol;color:black;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black;font-style:normal'>peersusername: extension username</span></p> <p class="MsoNoSpacing" style='margin-left:.5in;text-indent:-.25in'><span style='font-family:Symbol;color:black;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black;font-style:normal'>direction </span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>undefined </span><span style='font-style:normal'>(not for calls or no announced by the peer)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>initiator </span><span style='font-style:normal'>(outgoing call)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>receiver </span><span style='font-style:normal'>(incoming call)</span></p> <p class="MsoNoSpacing" style='margin-left:.5in;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>state</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>trying </span><span style='font-style:normal'>(call connect initiated)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>proceeding </span><span style='font-style:normal'>(call connecting)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>early </span><span style='font-style:normal'>(ringing or session progress)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>confirmed </span><span style='font-style:normal'>(call connected)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>terminated </span><span style='font-style:normal'>(call disconnected)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";color:black;font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>unknown</span><span style='color:black; font-style:normal'> (unrecognized call state received)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>failed </span><span style='font-style:normal'>(BLF subscribe or notify failed)</span></p> <p class="MsoNoSpacing" style='margin-left:.5in;text-indent:-.25in'><span style='font-family:Symbol;color:black;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black;font-style:normal'>callid: optional value if reported from the remote extension (the SIP call-id of the call)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_Miscellaneous"></a>Miscellaneous</h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Some other not so important API calls are listed below (helper functions):</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean Test()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You might use this function to check the API availability. Should return true.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean ServerInit(String address)</span></b><span style='font-style:normal'> -deprecated</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Call this function before to start any communication with this address (usually an IP number). This is required to release the Java security restrictions. Wait 1-2 second before calling the next function like Register or Call. This function is deprecated since v.3.8 (no need to call this, just call Register or others directly)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean MightStop()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>It is a good practice to call this function when your app might be stopped or killed soon. For example your app/activity is pausing/closing/exiting and from there the OS might kill your process. This will just make sure that the internal SIP stack settings are properly saved and the sipstack is prepared for an unexpected termination.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean Stop()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will stop all endpoints. This function call is optional when you unload AJVoIP from external app. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean Exit()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will stop all endpoints and terminates the java sip application. This function call is optional when you unload the AJVoIP java module or wish to issue a forced termination. Its behavior can be controlled by the “exitmethod” parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean ReStart()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Restart the SIP stack.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(Avoid using this API. Stop the old instance and create a new webphone object instead)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>void CheckConnection()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You might call this function to quickly recover from connection failures on events not know by AJVoIP such as app switched to foreground or activity launch (otherwise AJVoIP should auto-recover from network failures)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean CapabilityRequest(String server, String username)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will send an OPTION request to the server. Usually you should not use this function.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The server parameter can be empty if you already set it with other API calls or by parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The username parameter can be empty (in this case the “From” address will be set to “unknown”)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String LineToCallID(int line)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Get the SIP Call-ID for a line number.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>int CallIDToLine(String callid)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Get the line number for a SIP Call-ID.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'> </span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean SetLineParameter(int line, String param, String value, int permanent)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set parameter for the current/next/all/specific line. Only some of the parameters are supported by this function (listed below).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>These are advanced settings and this function might be used only if you need some specific/different behavior for a specific line only. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Otherwise, the behavior of the different lines are loaded from the global configuration (parameters), from the circumstances <br> or can be influenced by the other API functions (try to use the other API’s instead of this when possible).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Line: channel number. </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-style:normal'>If -2, then it will be set as global config like the SetParameter. </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>If -1, then for the active line. <br> If 0, then it will be applied for all next/new channel(s). </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-style:normal'>Otherwise it will be applied for the specific line.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> Param: settings key name</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Value: value as string (or "NULL" to clear any old preset)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>Permanent</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-style:normal'>If 1 then the setting will be kept for all future lines with the same line number</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-style:normal'>If 0 then the setting will be applied only for the current or very next channel with the same line</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The following parameters are supported by this function:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>peer (called number), address (will set both the serveraddress and proxyaddress), serveraddress, proxyaddress, username, authusername, password, displayname, voicerecording, muted, holded, maxsipmessagesize, codecretry, disccode, registerinterval, maxmsgresend, srtp_suite, strictsrtp, dtmfmode, rtp_timestamp, rtp_seq, rtp_ssrc, defpayload, setfinalcodec, presenceexpiresec, notifyexpiresec, sipproto, volumein, volumeout, volumering, videocalltype, videodirection, keepvideosdponhold, defvideopayload, serverdomainandport, serveraddr, serverport, serverip, proxyport, proxyip, realm, p_referred_identity, p_asserted_identity, remote_party_id, privacy, customsipheader, customsdpfield, customsdpmediafield, sip_uui,sessionid, discreason, usesdpip, transport, line, callid, state.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>All preset settings for all lines can be removed by passing 0 for the line and empty or NULL for both the key and the value.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Examples: </span></p> <p class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:#548DD4; font-style:normal'>mysipclient.SetLineParameter(1,"username", "mia",0); </span><span style='font-size:8.0pt;color:gray;font-style: normal'>//set the username to mia for the next call on line 1</span></p> <p class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:#548DD4; font-style:normal'>mysipclient.SetLineParameter(2,"username", "mia",1); </span><span style='font-size:8.0pt;color:gray;font-style: normal'>//set the username to mia for all upcoming calls on line 2</span></p> <p class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:#548DD4; font-style:normal'>mysipclient.SetLineParameter(2,"username", "NULL",1); </span><span style='font-size:8.0pt;color:gray;font-style: normal'>//clear the permanently preset username from line 2</span></p> <p class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:#548DD4; font-style:normal'>mysipclient.SetLineParameter(-1,"muted", "0",0); </span><span style='font-size:8.0pt;color:gray;font-style: normal'>//unmute the current call (use the Mute API instead)</span></p> <p class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:#548DD4; font-style:normal'>mysipclient.SetLineParameter(0,"muted", "4",0); </span><span style='font-size:8.0pt;color:gray;font-style: normal'>//set the default muted state both side mute for the next call</span></p> <p class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:#548DD4; font-style:normal'>mysipclient.SetLineParameter(0,"NULL", "NULL",1); </span><span style='font-size:8.0pt;color:gray;font-style: normal'>//clear all the permanent settings from all lines</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean SetSIPHeader(int line, String hdr)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set a custom sip header (a line in the SIP signaling) that will be sent with all messages. Can be used for various integration purposes to send auxiliary meta-data via the SIP signaling (for example for sending the http session id). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: <span style='color:#984806'>SetSIPHeader(-1, "X-MyData: VALUE”);</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Multiple headers can be separated by CRLF (\r\n). <br> You can also set this with the </span><a href="start.htm#_customsipheader"><span style='font-style:normal'>customsipheader</span></a><span style='font-style: normal'> parameter. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetSIPHeader(int line, String hdr)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return a sip header value received by AJVoIP. If not found it will return a string beginning with “ERROR:” such as “ERROR: no such line”.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean SetUUI(int line, String value, int fortarget)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set a custom UUI (User-to-User Call Control Information as described in RFC 7433).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Value is the UUI data (with or without parameters)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Fortarget specifies if the UUI have to be sent to target party with call transfer or redirect escaped. 0: no (to peer with the User-to-User header), 1: yes (to target in Contact or Refer-To URI), 2: both.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: <br> <span style='color:#984806'>SetURI(-1, "anydata”,-2);</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>SetURI(-1, "DATA;encoding=hex;purpose=foo;content=bar”,-2);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can also set this with the sip_uui parameter. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean SetSDPField (int line, String field, int type)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set a custom SDP field (a line in the SDP body) that will be sent with all messages.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set the type parameter to 0 for global values (before the m= line) or 1 for media values (after the m= line).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: <span style='color:#984806'>SetSDPField(-1, "a=3ge2ae:requested",1);</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Multiple headers can be separated by CRLF (\r\n). You can also set this with the </span><span style='font-style:normal'>customsdpfield</span><span style='font-style: normal'> and </span><span style='font-style: normal'>customsdpmediafield</span><span style='font-style:normal'> parameters. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Line -2 means all lines, -1 means current active line or use 1+ means for an existing line in call.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>You can set a SIP header for the next call by using line number -3 or clear the old header(s) by using line number 0.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean RTPHeaderExtension (int line, int profile, String extension)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set </span><a href="https://datatracker.ietf.org/doc/html/rfc3550#section-5.3.1"><span style='font-style:normal'>RTP header extension</span></a><span style='font-style:normal'> for the RTP packets.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The profile will be set as the first two bytes in the extension header (might be used as a custom identifier or parameter).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The extension can be one or multiple numbers separated by semicolon (;). These numbers will be sent as 32 bit words with the RTP header extension payload.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: <span style='color:#984806'>RTPHeaderExtension (-1, 1, "987"); </span><span style='color:gray'>//will set the profile number to 1 and the rtp extension word to 987 for the current call</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Line -2 means all lines, -1 means current active line or use 1+ means for an existing line in call.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>You can set a SIP header for the next call by using line number -3 or clear the old header(s) by using line number 0.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Set the profile to 0 and the extension string to empty to clear it.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean ED137PTT (int line, int ptt, int pttid)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>ED-137 Push to talk. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>line: channel number</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>ptt: 0: off (not speaking), 1: on (Normal PTT ON), 2: Coupling PTT ON, 3: Priority PTT ON, 4: Emergency PTT ON</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>pttid: optional PTT-ID (otherwise loaded from global config)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will return true if initiated successfully or false on failure. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The </span><a href="start.htm#node48"><span style='font-style:normal'>ed137</span></a><span style='font-style:normal'> parameter should be set to 1 before using this function. See the </span><a href="https://www.mizu-voip.com/Portals/0/Files/jvoip_ED_137.pdf"><span style='font-style:normal'>ED_137 guide</span></a><span style='font-style:normal'> for more details</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean SendSIPMessage(int line, String msg, String body, String account, String target)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Send a custom SIP signaling message (for example OPTIONS, NOTIFY, etc). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>line: endpoint where the message will be sent. -3: new endpoint, -2: all endpoints, -1: current active, 0: register endpoint, 1+: call </span><a href="start.htm#_Multiple_lines"><span style='font-style:normal'>channel number</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>msg: SIP message to send. It can be just the method name (OPTIONS,MESSAGE,NOTIFY,INVITE,etc), the full message header or the full message including also a body (such as SDP)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>body: optional SIP message body (such as SDP, xml payload or chat text, etc). Set to "null" if body must not be sent.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>account: optional SIP account details if you wish to use other parameters then the configured one. <br> same format like the </span><a href="start.htm#_extraregisteraccounts"><span style='font-style:normal'>extraregisteraccounts</span></a><span style='color:#548DD4;font-style:normal'> </span><span style='font-style:normal'>parameter</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>target: optional target username, number or SIP URI if not specified in the msg</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Examples:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; color:#984806;font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Send a custom REGISTER request: <span style='color:#984806'>mysipclient.SendSIPMessage(0, "fullregistermessagehere", "", "");</span></span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; color:#984806;font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Send UPDATE on line 1: <span style='color:#984806'>mysipclient.SendSIPMessage(1, "UPDATE", "", "");</span></span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; color:#984806;font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Send IM on line 2: <span style='color:#984806'>mysipclient.SendSIPMessage(2, "MESSAGE", "hi", "", "evelin");</span></span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; color:#984806;font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Send OPTIONS to another server: <span style='color:#984806'>mysipclient. SendSIPMessage(-3, "OPTIONS", "", "username:password@otherserveraddress.com");</span></span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; color:#984806;font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Send PUBLISH with a custom body: <span style='color:#984806'>mysipclient.SendSIPMessage(-3, "PUBLISH", "anymessagehere", "");</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The Content-Type for INFO, MESSAGE and NOTIFY requests can be specified with the <span style='color:#984806'>contenttype </span>parameter. Otherwise the content type will be auto guessed.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetSIPMessage(int line, int dir, int type)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return the last received or sent SIP signaling message as raw text.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Dir:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 0: in (incoming/received message)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 1: out (outgoing/sent message)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Type:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 0: any</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 1: SIP request (such as INVITE, REGISTER, BYE)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 2: SIP answer (such as 200 OK, 401 Unauthorized and other response codes)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 3: INVITE (the last INVITE received or sent)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 4: the last 200 OK (call connect, ok for register or other)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetLastRecInvite()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return the last received INVITE message.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetLastRecSIPMessage(String line)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Get the last received SIP message as clear text. Line is the line number or the SIP call id.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetLastRecFileName (String line)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Returns the last recorded file name.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String SendChatIsComposing (String line, String number)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Send typing notification.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetAddress() </span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return the local SIP listener address (IP:port)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean IsOnline() </span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return true if network is present</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean IsRegistered() </span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return true if AJVoIP is registered (“connected”) to the SIP server.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>int IsRegisteredEx() </span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Returns extended registration state: 0=unknown,1=not needed,2=yes,3=working yes,4=working unknown,5=working no,6=unregistered,7=no (failed)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>int IsInCall() </span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return whether the sip stack is in call: 0=no,1=ringing,2=speaking</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean IsIncomingVideo()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return true if the current incoming call has video offer or false if it has only audio offer</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;font-style:normal'>Example code:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#984806;font-style:normal'> if(mysipclient.IsIncomingVideo()) //check incoming call type</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#984806;font-style:normal'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#984806;font-style:normal'> //auto accept video call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#984806;font-style:normal'> mysipclient.AcceptVideo(fragmentResId, fragmentinstance);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#984806;font-style:normal'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#984806;font-style:normal'> else</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#984806;font-style:normal'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#984806;font-style:normal'> //auto accept audio call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#984806;font-style:normal'> mysipclient.Accept(-1);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#984806;font-style:normal'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>int GetCurrentConnectedCallCount() </span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Get number of current connected calls </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'> </span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetRegFailReason(boolean extended)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will return a text about the reason of the last failed registration. Set the extended parameter to true to get more details</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetDiscReasonText()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return the disconnect reason of the last disconnected call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>int GetAccountRegState(String domain, String proxy, String username, String sipusername, boolean pushnotify, boolean strict)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Query account register state. Useful if you are using multiple accounts.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Returns -1: no such account register ep, 0: working, 1: success, 2: failed, 3: unregistered.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters domain, proxy, username, sipusername will be used to match the account.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If the pushnotify is true, then it will look after push register endpoints (useful if push via gateway).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If the strict parameter is false, then will check the best matching account after the passed parameters.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If the strict parameter is true, then will enforce exact parameter match when checking after the endpoints (server domain/username/etc).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetAccountRegStateString(String domain, String proxy, String username, String sipusername, boolean pushnotify, boolean strict)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Query account register state. Useful if you are using multiple accounts.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return status text (for example "Registered" if the account is registered to the server).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters domain, proxy, username, sipusername will be used to match the account.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If the pushnotify is true, then it will look after push register endpoints (useful if push via gateway).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If the strict parameter is false, then will check the best matching account after the passed parameters.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If the strict parameter is true, then will enforce exact parameter match when checking after the endpoints (server domain/username/etc).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetCallerID(int line) </span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will return the remote party name</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetIncomingDisplay(int line)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Get incoming caller id (might return two lines: caller id \n caller name)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetLastCallDetails()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Get details about the last finished call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetMySIPURI(boolean all)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will return the SIP URI on which the current endpoint can be reached such as </span><a href="mailto:username@server.com"><span style='font-style:normal'>username@server.com</span></a><span style='font-style:normal'> or username@localip:port.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If all is true, then it will return all possible URI’s separated by comma.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>void AddLog(String msg)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Add a message to AJVoIP log.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean HoldChange(int line)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Same as Hold, but without the second parameter. This call will always invert the hold status for an endpoint (If the call was active, then it will switch to held status and if the call was in hold, then it will reactivate it).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String VAD()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Returns voice activity statistics. See the VAD notification for more details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: if you call this function, VAD will not be sent automatically anymore. (So you will need to continue to poll for the details).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String HTTPGet(String url)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Send a HTTP GET request. Check if return string begins with “ERROR”.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You should never call http requests from your main GUI thread, otherwise it will fail with a NetworkOnMainThreadException exception (This exception will occur only internally, not thrown to you).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For development, you might remove the restriction:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>StrictMode.ThreadPolicy policy = new StrictMode.ThreadPolicy.Builder().permitAll().build();</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>StrictMode.setThreadPolicy(policy);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean HTTPPost(String url, String data)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Send a HTTP POST request.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You should not call this function from your main GUI thread.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String HTTPReq(String url, String data)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Send a HTTP POST or GET request. (If data is empty, then GET will be sent). Can be tunneled. Can block for up to 20 seconds.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You should not call this function from your main GUI thread.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean HTTPReqAsync(String url, String data)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Send a HTTP POST or GET request. (If data is empty, then GET will be sent). Can be tunneled. The result will be returned in notifications with “ANSWER” header.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>It is safe to call this function also from the main GUI thread.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean SaveFile(String filename, String content)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will save the text file to local disk AJVoIP working directory in encrypted format (use SaveFileRaw to save as-is)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String LoadFile(String filename)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Load file from local disk.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean SaveFileRemote(String filename, String content)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Save file to remote storage (preconfigured ftp or http server )</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean LoadFileRemote(String filename)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Load file from remote storage. The download process is performed asynchronously. You need to call this function only once and then a few seconds later call the LoadFile function with the same file name. It will contain “ERROR: reason” text if the download failed.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String LoadFileRemoteSync(String filename)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will download the specified file from remote storage synchronously (will block until done or fails).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetBlacklist()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Get blacklist</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean SetBlacklist(String str)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set whole blacklist (users/numbers separated by comma)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean AddToBlacklist(String str)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Add to blacklist</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean ClearCredentials()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Clear existing user account details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean DelSettings (int level)</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Delete settings and data. Levels: 0: nothing, 1: settings, 2: everything</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>int IsEncrypted ()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Returns whether the connection is encrypted. -1: unknown, 0=no,1=partially/weak yes,2=yes,3=always strong</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetLogs()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Can be used to get the logs (which are otherwise written also to standard output and to Logcat). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The logpolling parameter must be set to 1 for this to work. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will store up to 20000 log entries (so you might call this periodically if you don’t wish to loose past logs)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetBindir()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Returns the application path (folder with the app binaries or app home folder)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetWorkdir()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Returns the application working directory (data folder).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Based on:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt'>appcontext.getFilesDir().getPath();</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt'>Environment.getDataDirectory().getPath();</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetAltWorkdir()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Returns the application alternative working directory (such as folder on external SD card).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetLogPath()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will return the log file path. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>By default the log file path will be set automatically, usually inside the work directory. It can be modified with the <span style='color:#984806'>logpath </span>parameter. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Logs are written to file only if the </span><a href="start.htm#_canlogtofile"><span style='color:#00007F;font-style:normal'><span style='color:windowtext'>canlogtofile</span></span></a><span style='color:#984806; font-style:normal'> </span><span style='font-style:normal'>parameter is set to <span style='color:#984806'>1 </span>or<span style='color:#984806'> 2</span>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The log file might be in use while AJVoIP is running and you will be able to access it only in shared read mode. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>int ShouldReset()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Check if the sipstack should be restarted. Usually this is required only on local network change (such as IP change or changing from mobile data to wifi).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible return values: 0=no,1=not registered for a while,2=network changed</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean ShouldResetBeforeCall()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This function might be called before calls and you should quickly restart the sipstack if returns true (then continue to make the call).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean RecFiles_Del()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Delete local recorded files.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>boolean GetDeviceID()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Returns an unique device ID.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>String GetVersion()</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return the program version number.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Most of the API functions were covered above in this guide, however you might find also some additional helper functions exposed. You should be able to cover all your needs using the above functions and most of the additional API’s are redundant or needed only in very special circumstances.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>See the </span><a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc.zip"><span style='font-style:normal'>Javadoc</span></a><span style='font-style:normal'> for a complete listing of all public functions.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:solid #C0504D 1.0pt;border-left:solid #C0504D 6.0pt; padding:0in 4.0pt 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h2 style='margin-left:0in'><a name="_Toc506369849"></a><a name="_Toc255049844"></a><a name="_Notifications"></a>Notifications</h2> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Notifications means events received from the SIP library when something is happening/happened.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>To be able to get events from AJVoIP you will need to extend the <span style='color:#984806'>SIPNotificationListener </span>class and subscribe for the notification events with the <span style='color:#984806'>SetNotificationListener</span> function call. Then in your NotificatioListener subclass you will receive the notifications as <span style='color:#984806'>SIPNotification </span>objects or its subclasses.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>class MySIPNotificationListener extends SIPNotificationListener</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>{</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'> public void onAll(SIPNotification e) {</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'> Log.v("AJVoIP","Notification received: " + e.toString());</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'> }</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'> public void onStatus (SIPNotification.Status e) {</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'> Log.v("AJVoIP","STATUS notification received: " + e.</span><span style='font-size:11.0pt'> </span><span style='color:#984806;font-style:normal'>getStatusText());</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'> } </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>}</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>mysipclient.SetNotificationListener(new MySIPNotificationListener());</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>See the </span><a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html"><span style='font-style:normal'>javadoc</span></a><span style='font-style:normal'> for a more structured help about the notification objects and their fields. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="https://www.mizu-voip.com/Portals/0/Files/AJVoIPTest.zip"><span style='font-style:normal'>Here</span></a><span style='font-style:normal'> is a simple working example code. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For maximum flexibility, the AJVoIP SIP library implements also receiving notifications as strings (instead of SIPNotification objects). In case if somehow you are interested in these, see the details here.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The SIPNotification base class has a <span style='color:#984806'>toString() </span>function which can be used to convert the event to string. (The string format is better explained </span><span style='font-style:normal'>here</span><span style='font-style:normal'>)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Many notifications has a line field to be queried with the <span style='color:#984806'>getline() </span>function returning the SIP endpoint channel number as described </span><a href="start.htm#_Line_parameter"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You don’t necessarily have to handle all notification events in your SIPNotificationListener subclass. Override only the members you are interested at.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The easiest way to get started is to just log out all messages at first and from there the usage should be obvious. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Below we describe most notifications as strings and field names. See the </span><a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html"><span style='font-style:normal'>javadoc</span></a><span style='font-style:normal'> for the actual SIPNotification class functions and/or use the auto-complete functionality from your IDE.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>The following notifications are defined:</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'> </span></b></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_STATUS,line,statustext,peername,loc"></a><a name="_Status"></a><span style='font-size:12.0pt'>Status</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You will receive STATUS notifications when the SIP session state is changed (SIP session state machine changes) or periodically even if there was no any change. Usually you will have to display the call state for the user, and when a call arrives you might have to display an accept/reject button.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>STATUS,line,statustext,peername,localname,endpointtype</span><br> A typical status as string looks like this:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='color:#548DD4;font-style:normal'>STATUS,line,statustext,peername,localname,endpointtype,peerdisplayname,[callid],online,registered,incall,mute,hold,encrypted,video,group,</span></b><span style='font-size:11.0pt'> </span><b><span style='color:#548DD4;font-style:normal'>rtpsent,rtprec,rtploss,rtplosspercet,videohold,videosent,videorec,serverstats</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: not all fields/functions are meaningful for all notifications. For example getRtpsent() should be queried only for endpoints in calls (status between STATUS_CALL_SETUP/ STATUS_CALL_CONNECT and STATUS_CALL_FINISHED) and it is meaningless for STATUS_REGISTER.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.Status methods:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getLine()</span></b><span style='font-style:normal'>: The line parameter can be -1 for global status or a positive value for the different lines.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Global status means the state of the “best” endpoint. For example if one line is disconnected and another is in Speaking, then the global state will be Speaking.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can receive the same STATUS notification multiple times: for the particular endpoint, for the global status and repeatedly if the state remains the same. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You might decide to parse only general status messages (where the line is -1), messages for specific line (where line is a positive number) or both.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getStatus()</span></b><span style='font-style:normal'>: The global or endpoint state. One of the following constants: STATUS_UNKNOWN, STATUS_NOTREADY, STATUS_INITIALIZING, STATUS_READY, STATUS_OUTBAND, STATUS_REGISTER, STATUS_REGISTERED, STATUS_REGISTERFAILED, STATUS_UNREGISTER, STATUS_SUBSCRIBE, STATUS_MESSAGE, STATUS_CALL_SETUP, STATUS_CALL_ROUTED, STATUS_CALL_PROGRESS, STATUS_CALL_SESSIONPROGRESS, STATUS_CALL_RINGING, STATUS_CALL_CONNECT, STATUS_CALL_SPEAKING, STATUS_CALL_MIDCALL, STATUS_CALL_MUTE, STATUS_CALL_HOLD, STATUS_CALL_FINISHING, STATUS_CALL_FINISHED, STATUS_DELETABLE, STATUS_ERROR</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getStatusText()</span></b><span style='font-style:normal'>: the status as string as described </span><span style='font-style:normal'>here</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getPeer():</span></b><span style='font-style:normal'> the other party username (if any)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getLocalname():</span></b><span style='font-style:normal'> the local user name (or username).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getEndpointType()</span></b><span style='font-style:normal'>: check if it is a server or client endpoint. Will return one of the following constants: </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>DIRECTION_UNKNOWN</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>DIRECTION_OUT: for sessions initiated by AJVoIP such as outbound calls where AJVoIP acts as a client</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>DIRECTION_IN: for inbound sessions such as incoming calls when AJVoIP acts as a server endpoint</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getEndpointTypeText()</span></b><span style='font-style:normal'>: endpoint state as string</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getPeerDisplayname()</span></b><span style='font-style:normal'>:<b> </b>the other party display name if any</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getCallID()</span></b><span style='font-style:normal'>: SIP session id (SIP call-id)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getOnline()</span></b><span style='font-style:normal'>: network state. NETWORK_STATE_UNKNOWN, NETWORK_STATE_OFFLINE (no network or internet connection), NETWORK_STATE_ONLINE (connectivity detected)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getOnlineText()</span></b><span style='font-style:normal'>: online state as string</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getRegistered()</span></b><span style='font-style:normal'>: registration state. REGISTER_STATE_UNKNOWN, REGISTER_STATE_NOTNEEDED, REGISTER_STATE_YES, REGISTER_STATE_WORKING_YES, REGISTER_STATE_WORKING_UNKNOWN, REGISTER_STATE_WORKING_NO, REGISTER_STATE_UNREGISTERED, REGISTER_STATE_FAILED</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getRegisteredText()</span></b><span style='font-style:normal'>: registration state as string</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getIncall()</span></b><span style='font-style:normal'>: phone/line is in call. CALL_STATE_UNKNOWN, CALL_STATE_NO, CALL_STATE_CONNECTING, CALL_STATE_CONNECTED</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getIncallText()</span></b><span style='font-style:normal'>: call state as string</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getMute()</span></b><span style='font-style:normal'>: is muted state. MUTE_STATE_NO, MUTE_STATE_UNKNOWN, MUTE_STATE_PLAY, MUTE_STATE_REC, MUTE_STATE_BOTH</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getMuteText()</span></b><span style='font-style:normal'>: mute state as string</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getHold()</span></b><span style='font-style:normal'>: is on hold state: HOLD_STATE_NO, HOLD_STATE_UNKNOWN, HOLD_STATE_SENDONLY, HOLD_STATE_RECVONLY, HOLD_STATE_BOTH</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getHoldText()</span></b><span style='font-style:normal'>: hold state as string</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getEncrypted()</span></b><span style='font-style:normal'>: encryption state: ENCRYPTION_STATE_UNKNOWN, ENCRYPTION_STATE_NO, ENCRYPTION_STATE_YES_WEAK, ENCRYPTION_STATE_YES, ENCRYPTION_STATE_YES_STRONG</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getEncryptedText()</span></b><span style='font-style:normal'>: encryption state as string</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getVideo()</span></b><span style='font-style:normal'>: video state: VIDEO_STATE_UNKNOWN, VIDEO_STATE_NO, VIDEO_STATE_INITIALIZED, VIDEO_STATE_OFFERED, VIDEO_STATE_RTPREADY, VIDEO_STATE_STARTED, VIDEO_STATE_STREAMING</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getVideodText()</span></b><span style='font-style:normal'>: video state as string</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getGroup()</span></b><span style='font-style:normal'>: group string for group chat and conference calls (members separated by | )</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getRtpsent()</span></b><span style='font-style:normal'>: number of sent RTP packets (only if endpoint is in call)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getRtprec()</span></b><span style='font-style:normal'>: number of received RTP packets (only if endpoint is in call)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getRtploss()</span></b><span style='font-style:normal'>: number of lost RTP packets (only if endpoint is in call)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getRtplosspercent()</span></b><span style='font-style:normal'>: percent of the lost RTP packets (only if endpoint is in call)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getVideoHold()</span></b><span style='font-style:normal'>: video on hold state: HOLD_STATE_NO, HOLD_STATE_UNKNOWN, HOLD_STATE_SENDONLY, HOLD_STATE_RECVONLY, HOLD_STATE_BOTH</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getVideoHoldText</span></b><span style='font-style:normal'>(): video hold state as string</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getVideoRtpsent()</span></b><span style='font-style:normal'>: number of sent video RTP packets (only if endpoint is in video call)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getVideoRtprec()</span></b><span style='font-style:normal'>: number of received video RTP packets (only if endpoint is in video call)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getServerstats()</span></b><span style='font-style:normal'>: RTP statistics received from the server, if any (only if endpoint is in call)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.Status in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>STATUS string examples:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>The following status means that there is an incoming call ringing from 2222 on the first line:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='color:#548DD4;font-style:normal'>STATUS,1,Ringing,2222,1111,<b>2</b>,Katie,[callid]</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>The following status means an outgoing call in progress to 2222 on the second line:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='color:#548DD4;font-style:normal'>STATUS,2,Speaking,2222,1111,<b>1</b>,,[callid]</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>The following status means that the call was disconnected:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='color:#548DD4;font-style:normal'>STATUS,2,Finished,2222,1111,1,,[callid]</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note:</p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span>To verify the connection/registration state you might use the below REGISTER notification instead or as described<span style='font-size:11.0pt'> </span><a href="start.htm#_How_to_register?">here</a>.</p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span>If the “stats” parameter is on (set to a value higher than 0) then you will receive periodic status messages during calls (might be useful if you are interested in RTP statistics during a call).</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_REGISTER,line,state,text,mainaccoun"></a><span style='font-size:12.0pt'>Register</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This notification is received for register state changes from registrar endpoints. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Registration means connection and authentication on your SIP server. </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>REGISTER,line,state,text,main,fcm,user,reason</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.Register methods: </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getLine()</span></b><span style='font-style:normal'>: channel number (should be always 0 for register)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><b><span style='font-style:normal'>getStatus()</span></b><span style='font-style:normal'>: registration state: STATUS_INPROGRESS, STATUS_SUCCESS, STATUS_FAILED, STATUS_UNREGISTERED</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getText()</span></b><span style='font-style:normal'>: register state as string</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getIsMain()</span></b><span style='font-style:normal'>: true for primary account, false for secondary registrations (if you are using </span><a href="start.htm#_Multiple_account_registration_1"><span style='font-style:normal'>multiple accounts</span></a><span style='font-style:normal'>)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getFcm()</span></b><span style='font-style:normal'>: not used (ignore)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getUser()</span></b><span style='font-style:normal'>: local username (useful if you are using multiple accounts)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getReason()</span></b><span style='font-style:normal'>: failure reason text if any</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.Register in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>and the <a href="start.htm#_How_to_register?">How to register</a> FAQ point for more details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note: This notification can be disabled by setting the <span style='color:#984806'>sendregisternotifications </span>parameter to <span style='color:#984806'>0</span> (for compatibility reasons with old versions).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node23" id="node23"></a><span style='font-size:12.0pt'>Presence</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This notification is received for presence changes (peers online state).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>PRESENCE,peername,state,details,displayname,email</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.Presence methods:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getPeer()</span></b><span style='font-style:normal'>: username of the peer</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getStatus()</span></b><span style='font-style:normal'>: presence state. One of the following constants: PRESENCE_UNKNOWN, PRESENCE_OFFLINE, PRESENCE_DND, PRESENCE_AWAY, PRESENCE_BUSY, PRESENCE_ONLINE, PRESENCE_PENDING</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getStatusText()</span></b><span style='font-style: normal'>: presence state as string </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getDetails()</span></b><span style='font-style:normal'>: presence details if any</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getPeerDisplayname()</span></b><span style='font-style:normal'>: peer full name if received (it can be empty)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getEmail()</span></b><span style='font-style:normal'>: peer email address if received (it can be empty)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.Presence in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>More details about presence handling can be found <a href="start.htm#_Presence">here</a>. </p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><u><span style='font-style:normal'>Notes for the state and detail strings:</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The state and the details strings are usually the followings: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>CallMe,Available,Open,Pending,Other,CallForward,CallSetup,Speaking,Busy,Idle,DoNotDisturb,DND,Unknown,Away,Offline,Closed,Close,Unreacheable,</span><span style='font-size:11.0pt'> </span><span style='font-style:normal'>Unregistered,Invisible,Exists,NotExists,Unknown,Not Set or as reported by the peer</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>One of these fields might be empty in some circumstances and might not be a string in the above list (especially the details).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The <span style='color:#984806'>details </span>field will provide a more exact description (for example “Unreachable”) while the <span style='color:#984806'>state </span>field will provide a more exact one (for example “Close”). For this reason if you have a presence control to be changed and you are looking for the strings instead of using the getstatus function, then check the <span style='color:#984806'>details </span>string first and if you can’t recognize its content, then check the <span style='color:#984806'>state</span> string. For displaying the state as text, you should display the <span style='color:#984806'>details </span>field (and display the <span style='color:#984806'>state </span>field only if the <span style='color:#984806'>details </span>string is empty).</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_DTMF,line,msg"></a><span style='font-size:12.0pt'>DTMF</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Incoming DTMF notification.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Msg is a string parameter representing the incoming DTMF digit. Usually one of the followings: 0123456789*#ABCDF</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Supported receive dtmf methods are SIP INFO in SIP signaling and NTE (RFC 2833 in RTP).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>DTMF,line,msg</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: <span style='color:#984806'>DTMF,1,7 </span><span style='color:gray'>(dtmf digit”7” received on first line)</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:gray;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.DTMF members:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getLine()</span></b><span style='font-style:normal'>: returns the channel number</span><span style='font-size:11.0pt;font-style:normal'> </span><span style='font-style:normal'>(the endpoint which received the DTMF message)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getMsg()</span></b><span style='font-style:normal'>: returns the DTMF message (one or more DTMF digits)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:gray;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.DTMF in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:gray;font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_INFO,type,line,peername,text"></a><span style='font-size:12.0pt'>INFO</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Notifications about incoming/outgoing </span><a href="start.htm#_INFO,type,line,peername,text"><span style='font-style:normal'>INFO</span></a><span style='font-style:normal'> or </span><a href="start.htm#_DTMF,line,msg"><span style='font-style:normal'>DTMF</span></a><span style='font-style:normal'> messages.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: for incoming DTMF you should watch for the above described DTMF notification instead of this! DTMF notification will be triggered even if the message was received with SIP INFO.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>INFO,type,line,peername,text</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.INFO members:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getType()</span></b><span style='font-style:normal'>: will return one of the following constants: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>INFO_UNKNOWN: this should never be emitted</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>INFO_ERROR: Outgoing DTMF (Dtmf()) or INFO (Info()) message failed</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>INFO_WARNING: Outgoing DTMF failover from SIP INFO to RFC 2833 or In-Band on answer timeout or error response</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>INFO_OK: Outgoing DTMF (Dtmf()) or INFO (Info()) was sent successfully</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>INFO_REC: Incoming INFO message received. Note that if the incoming message is a dtmf digit, then a DTMF notification will be triggered instead of INFO</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getTypeText()</span></b><span style='font-style:normal'>: type as string</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getLine()</span></b><span style='font-style:normal'>: Phone line</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getPeer()</span></b><span style='font-style:normal'>: Other party username</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getText()</span></b><span style='font-style:normal'>: INFO message body when type is REC or any additional info if type us ERROR, WARNING or OK.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.INFO in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Examples: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='color:#984806;font-style:normal'>INFO,ERROR,1,1111,timeout </span><span style='color:gray;font-style:normal'>(on Dtmf() or Info() message send failed to 1111 on line 1)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='color:#984806;font-style:normal'>INFO,WARNING,1,1111,failback to rfc2833 </span><span style='color:gray;font-style:normal'>(on Dtmf() failback from INFO to rfc2833 or in-band)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='color:#984806;font-style:normal'>INFO,OK,1,1111 </span><span style='color:gray;font-style:normal'>(on Dtmf() or Info() message sent successfully to 1111 on line 1)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='color:#984806;font-style:normal'>INFO,REC,1,1111,hello </span><span style='color:gray;font-style:normal'>(on SIP INFO message received from 1111 which is not DTMF)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>When sending DTMF in RTP (inband or rfc2833) then it is not possible to get feedback whether the message was actually delivered. In this case you will receive an INFO,OK when the message send was initiated successfully. Otherwise if SIP INFO is used, then you will receive INFO,OK only on 2xx answer from the server or the other peer.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node24" id="node24"></a><span style='font-size:12.0pt'>BLF</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This notification is received for incoming BLF messages.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>BLF,peerusername,direction,state,callid</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Described at the </span><a href="start.htm#_BLF"><span style='font-style:normal'>BLF section above</span></a><span style='font-style: normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_USSD,line,status,text"></a><span style='font-size:12.0pt'>USSD</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This notification is received about incoming USSD messages or report about success/failure about the outgoing USSD messages sent by </span><a href="start.htm#_Boolean_SendUSSD(int_line,"><span style='font-style:normal'>SendUSSD</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>USSD,line,status,text</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.USSD members:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getLine()</span></b><span style='font-style:normal'>: the session line</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getStatus()</span></b><span style='font-style:normal'>: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>USSD_UNKNOWN: should never be emitted</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>USSD_FAILED: send failed</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>USSD_SENT: send succeeded</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>USSD_RECEIVED: received</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getStatusText()</span></b><span style='font-style: normal'>: the status as string</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getText()</span></b><span style='font-style:normal'>: text is the received USDD string (if status is 2) otherwise it might contain an error (if status is 0)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'>See the SIPNotification.USSD in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>More details about USSD handling can be found </span><a href="start.htm#_How_to_USSD"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_CHAT,line,peername,text"></a><span style='font-size:12.0pt'>Chat</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a name="_CHATREPORT,line,peername,status,sta"></a><span style='font-style:normal'>This notification is received for incoming chat messages.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>CHAT,line,peername,text</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.Chat members:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getLine()</span></b><span style='font-style:normal'>: used phone line</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getPeer()</span></b><span style='font-style:normal'>: username of the peer</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getText()</span></b><span style='font-style:normal'>: the message body as-is</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getMsg()</span></b><span style='font-style:normal'>: chat text</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getGroup()</span></b><span style='font-style:normal'>: group name (only for multi-user/group messages, otherwise will return empty string)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getMultiparCurrent()</span></b><span style='font-style:normal'>: multipart current fragment (only for </span><a href="start.htm#_ims3gpp"><span style='font-style:normal'>3gpp</span></a><span style='font-style:normal'> multipart messages)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getMultiparTotal()</span></b><span style='font-style: normal'>: multipart total fragments (only for 3gpp multipart messages)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.Chat in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node25" id="node25"></a><span style='font-size:12.0pt'>ChatReport</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Chat transmission status report so you can process if outgoing message sent with the </span><a href="start.htm#_boolean_SendChat(int_line,"><span style='font-style:normal'>SendChat</span></a><span style='font-style:normal'> was delivered successfully or failed.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>CHATREPORT,line,peername,status,statustext,group,md5,id</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.ChatReport members:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getLine():</span></b><span style='font-style:normal'> used phone line</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getPeer()</span></b><span style='font-style:normal'>: username of the peer</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getStatus()</span></b><span style='font-style:normal'>: one of the following constants:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>STATUS_UNKNOWN: should never be emitted</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>STATUS_INIT: means chat send initialized</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>STATUS_SENDING: means sending in progress</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>STATUS_SENT: means successfully sent</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>STATUS_FAILED: means failed</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>STATUS_QUEUED: means queued for later send</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getStatusText()</span></b><span style='font-style: normal'>: status text if any (such as delivery error reason if status is 3)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getGroup()</span></b><span style='font-style:normal'>: optional parameter for group chat (member names separated by | )</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getMD5()</span></b><span style='font-style:normal'>: the MD5 checksum of the message text</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getID()</span></b><span style='font-style:normal'>: message ID (user supplied msgid, 3gpp message reference or generated id)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.ChatReport in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> This notification is sent also for SMS messages.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> If the offline messaging is not disabled (<span style='color:#984806'>offlinechat </span>parameter is not set to <span style='color:#984806'>0</span>) then AJVoIP can retry later (on next start and/or when any SIP request is received from the target user) reporting status 4 instead of 3 on failed delivery. The MD5 checksum in this case will be calculated from concatenated pending message text and not for the last message. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> A STATUS_QUEUED is reported also if your SIP server responds with 202 (Accepted) instead of 200 (OK). This (the 202 response code) should indicate that the request has been accepted but the processing has not been completed, however some servers (such as Asterisk) might always (incorrectly) answer with 202 for the MESSAGE requests instead of 200. You might set the <span style='color:#984806'>chatacceptasok </span>parameter to <span style='color:#984806'>1 </span>to report status STATUS_SENT for these instead of status STATUS_QUEUED.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_CHATCOMPOSING,line,peername,status"></a><span style='font-size:12.0pt'>ChatComposing</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Chat “is composing” notifications are usually emitted when the other party starts or stops typing. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>CHATCOMPOSING,line,peername,status</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.ChatComposing members:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getLine()</span></b><span style='font-style:normal'>: used phone line</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getPeer()</span></b><span style='font-style:normal'>: username of the peer</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getStatus()</span></b><span style='font-style:normal'>: STATUS_TYPING means other party is typing, STATUS_IDLE means other party is idle or stopped typing</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getStatusText()</span></b><span style='font-style: normal'>: status as string</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.ChatComposing in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_CDR"></a><span style='font-size:12.0pt'>CDR</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>After each call, you will receive a CDR (call detail record) with the details about the call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>CDR,line, peername,caller,called,peeraddress,connecttime,duration,discparty,reasontext</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.CDR members:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getLine()</span></b><span style='font-style:normal'>: used phone line</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getPeer()</span></b><span style='font-style:normal'>: other party username, phone number or SIP URI</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getCaller()</span></b><span style='font-style:normal'>: the caller party name (our username in case when we are initiated the call, otherwise the remote username, displayname, phone number or URI)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getCalled()</span></b><span style='font-style:normal'>: called party name (our username in case when we are receiving the call, otherwise the remote username, phone number or URI)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getPeerAddress()</span></b><span style='font-style: normal'>: other endpoint address (usually the VoIP server IP or domain name)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getConnectTime()</span></b><span style='font-style: normal'>: milliseconds elapsed between call initiation and call connect (or until reject/hangup if the call was not connected)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getDuration()</span></b><span style='font-style:normal'>: milliseconds elapsed between call connect and hangup (0 for not connected calls. Divide by 1000 to obtain seconds.)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getDiscParty()</span></b><span style='font-style: normal'>: the party which was initiated the disconnect: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>DISCBY_NOTSET: not set</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>DISCBY_LOCAL: local AJVoIP</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>DISCBY_REMOTE: peer</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>DISCBY_UNKNOWN: undefined/timeout</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getDiscReason()</span></b><span style='font-style: normal'>: a </span><a href="start.htm#_Disconnect_reasons"><span style='font-style:normal'>text</span></a><span style='font-style:normal'> about the reason of the call disconnect (SIP disconnect code, CANCEL, BYE or some other error text)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.CDR in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node26" id="node26"></a><span style='font-size:12.0pt'>MWI</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Voicemail notifications.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Messages are received on new voicemail notifications if you have enabled voicemail and there are pending new messages.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This notification might be set by the SIP server without asking or depending on the </span><a href="start.htm#_voicemail"><span style='font-style:normal'>voicemail</span></a><span style='font-style:normal'> parameter or requested by </span><a href="start.htm#_boolean_CheckVoicemail(int_line)"><span style='font-style:normal'>CheckVoicemail</span></a><span style='font-style: normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>MWI,hasvoicemail,voicemailnumber,to,count,message</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example string: <span style='color: #548DD4'>MWI,yes,5001,1111,3,3/0</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.MWI methods:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>getHasMessage()</span></b><span style='font-style:normal'>: “yes” or “no” (Messages-Waiting indicator, whether if there are message(s) pending)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>getVMNumber()</span></b><span style='font-style:normal'>: the voicemail access number (as configured or as received in Message-Account. see </span><a href="start.htm#_voicemailnum"><span style='font-style:normal'>voicemailnum</span></a><span style='font-style:normal'>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>getTo()</span></b><span style='font-style:normal'>: username from the SIP To header (Message-Account; usually the local account username, useful if you have multiple accounts)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>getCount()</span></b><span style='font-style:normal'>: number of new pending messages (Messages-Waiting)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>getMessage()</span></b><span style='font-style:normal'>: message text if sent by the server (Voice-Message)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.MWI in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_PlayReady"></a><span style='font-size: 12.0pt'>PlayReady</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Audio streaming finished (initiated by PlaySound() to remote peer).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>PLAYREADY,line,callid</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.PlayReady members: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><b><span style='font-style:normal'>getLine()</span></b><span style='font-style:normal'>:<b> </b>endpoint channel number</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><b><span style='font-style:normal'>getCallID()</span></b><span style='font-style:normal'>: SIP Call-ID</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.PlayReady in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: this notification is not sent with call disconnect (call disconnect will always terminate the audio streaming).</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_Vrec"></a><span style='font-size:12.0pt'>Vrec</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Voice upload status (for voice recording / call recording).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>VREC,line,stage,type,path,reason,source</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.Vrec members:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getLine()</span></b><span style='font-style:normal'>: channel number </span><span style='font-size:9.0pt'>(note: with stage 3 and 4 it will always report -1 or -2 means default/not specified)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getStatus()</span></b><span style='font-style:normal'>: call recording state: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>STAGE_DISABLED: no such state should be reported</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>STAGE_INIT: call record begin</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>STAGE_SAVING: save begin</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>STAGE_SAVED: save success</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>STAGE_FAILED: save fail</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>STAGE_UNKNWON: no such state should be reported</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getStatusText()</span></b><span style='font-style: normal'>: state as string</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getType()</span></b><span style='font-style:normal'>: upload method: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>TYPE_UNKNOWN: unknown</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>TYPE_FILE: local file</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>TYPE_FTP: ftp</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>TYPE_HTTP: http</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>TYPE_SERVER: server</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>TYPE_SIPREC: siprec</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getTypeText()</span></b><span style='font-style:normal'>: the type as string</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getPath()</span></b><span style='font-style:normal'>: upload URL or file path </span><span style='font-size:9.0pt'>(</span><span style='font-size:9.0pt'>note: </span><span style='font-size:9.0pt'>if stage is 1 then type and path is not reported yet)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getReason()</span></b><span style='font-style:normal'>: failure reason </span><span style='font-size:9.0pt'>(if stage is 4)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getSource()</span></b><span style='font-style:normal'>: who initiated the recording: SOURCE_USER, SOURCE_SIPREC, SOURCE_AUTO, SOURCE_UNKNOWN</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getSourceText()</span></b><span style='font-style: normal'>: the source as text (USER, SIPREC or AUTO)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.Vrec in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object and the <a href="start.htm#_Call_recording">call recording FAQ</a> for more details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node27" id="node27"></a><span style='font-size:12.0pt'>SIP</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Notifications for received/sent SIP signaling messages.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Can be enabled by the </span><span style='font-style:normal'>sipmsgnotifications</span><span style='font-style:normal'> parameter (disabled/not sent by default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>SIP,direction,address,message</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.SIP members:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getDirection()</span></b><span style='font-style: normal'>: DIRECTION_UNKNOWN, DIRECTION_OUT, DIRECTION_IN</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getDirectionText()</span></b><span style='font-style: normal'>: “in” (for outgoing messages sent by AJVoIP) or “out” (for incoming messages received by AJVoIP)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getAddress()</span></b><span style='font-style:normal'>: peer IP:port</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getMessage()</span></b><span style='font-style:normal'>: the whole SIP signaling message text</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.SIP in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note: if the message already belongs to a session, then you can get the endpoint line by extracting the Call-ID value and passing it to the </span><span style='font-size:9.0pt'>CallIDToLine() function.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node28" id="node28"></a><span style='font-size:12.0pt'>Block</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This notification is emitted when AJVoIP blocks a signaling message only if the <span style='color:#984806'>sendblocknotifications </span>parameter is set to <span style='color:#984806'>1</span>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>BLOCK,type,message</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.Block members:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getType()</span></b><span style='font-style:normal'>: TYPE_UNKNOWN,</span><span style='font-size:11.0pt'> </span><span style='font-style:normal'>TYPE_BLACKLIST, TYPE_WHITELIST</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getTypeText()</span></b><span style='font-style:normal'>: the type as string</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getMessage()</span></b><span style='font-style:normal'>: the SIP message being blocked / ignored</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.Block in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_VAD,parameters"></a><span style='font-size:12.0pt'>VAD</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Voice Activity Detection.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This is sent in around every 3000 milliseconds (3 seconds) by default (configurable with the vadstat_ival parameter in milliseconds) if you set the “vadstat” parameter to 3 or 4 it can be requested with the VAD() function. Also make sure that the “vad” parameter is set to at least “2”.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This notification can be used to detect speaking/silence or to display a visual voice activity indicator.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>VAD,parameters</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>String format:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#548DD4;font-style:normal'>VAD,local_vad: ON local_avg: 0 local_max: 0 local_speaking: no remote_vad: ON remote_avg: 0 remote_max: 0 remote_speaking: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#548DD4;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If the <span style='color:#984806'>vadbyline </span>parameter is set to <span style='color:#984806'>1</span> then individual lines will report in the following format: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#548DD4;font-style:normal'>VAD,line: X remote_vad: ON remote_avg: 0 remote_max: 0 remote_speaking: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.VAD members:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getLine()</span></b><span style='font-style:normal'>: endpoint channel number</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getParameters()</span></b><span style='font-style:normal'>: returns all parameters</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getLocalValid()</span></b><span style='font-style:normal'>: whether VAD is measured for microphone: ON or OFF</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getLocalAvg()</span></b><span style='font-style:normal'>: average signal level from microphone</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getLocalMax()</span></b><span style='font-style:normal'>: maximum signal level from microphone</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getLocalSpeaking()</span></b><span style='font-style:normal'>: local user speak detected: yes or no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getRemoteValid()</span></b><span style='font-style:normal'>: whether VAD is measured from peer to speaker out: ON or OFF</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getRemoteAvg()</span></b><span style='font-style:normal'>: average signal level from peer to speaker out</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getRemoteMax()</span></b><span style='font-style:normal'>: maximum signal level from peer to speaker out</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>getRemoteSpeaking()</span></b><span style='font-style:normal'>: peer user speak detected: yes or no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.VAD in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.<br> <br> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>More details about VAD handling can be found </span><a href="start.htm#_Voice_activity_detection_1"><span style='font-style: normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_RTPE"></a><span style='font-size:12.0pt'>RTPE</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Reports about </span><a href="https://datatracker.ietf.org/doc/html/rfc3550#section-5.3.1"><span style='font-style:normal'>RTP extra header</span></a><span style='font-style: normal'> changes.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This is sent only if there RTP header extensions are received and the <span style='color:#984806'>rtpextraheadernotify </span>parameter is set to <span style='color:#984806'>1</span>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>RTPE,line,profile,extension</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: <span style='color:#548DD4'>RTPE,1,1,98;76543</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.RTPE members:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getLine()</span></b><span style='font-style:normal'>: the session endpoint line number </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getProfile()</span></b><span style='font-style:normal'>: identifier or parameter extracted from the first two byte of the extension header</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getExtension()</span></b><span style='font-style: normal'>: 32 bit words as int converted to string. If there are more then one then separated by semicolon (;)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.RTPE in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_RTPSTAT,quality,sent,rec,issues,los"></a><span style='font-size:12.0pt'>RTPStat</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Media quality reports.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Can be enabled by the </span><a href="start.htm#_rtpstat"><span style='font-style:normal'>rtpstat</span></a><span style='font-style:normal'> parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The parameters are calculated since the last RTPSTAT notification (for the past x seconds).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>RTPSTAT,quality,sent,rec,issues,loss</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.RTPStat members:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>getQuality()</span></b><span style='font-style:normal'>: quality points between 0 and 5. The calculations considers many factors such as RTP issues, RTCP reports, codec problems, packet loss, packet delay, jitter and processing delay.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>The following values are defined:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>QUALITY_UNKNOWN: unrecognizable (-1)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>QUALITY_NO: no audio or non-recognizable voice (0)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>QUALITY_LOWEST: very bad quality (1)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>QUALITY_LOW: bad quality (2)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>QUALITY_MEDIUM: medium quality (3)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>QUALITY_HIGH: good quality (4)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>QUALITY_HIGHEST: excellent quality (5)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>getQualityText()</span></b><span style='font-style:normal'>: the quality as string</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>getSent()</span></b><span style='font-style:normal'>: RTP packets sent</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>getRec()</span></b><span style='font-style:normal'>: RTP packets received and played</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>getIssues()</span></b><span style='font-style:normal'>: number of issues (any issues are counted, such as sequence number mismatch or packet drop)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>getLoss(): lost packets</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.RTPStat in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>More details </span><a href="start.htm#_Media_statistics"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node29" id="node29"></a><span style='font-size:12.0pt'>Group</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Sent for conference calls. You might update the displayed peer name with the peers strings received here. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>GROUP,line,peers</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.Group members: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><b><span style='font-style:normal'>getLine()</span></b><span style='font-style:normal'>:<b> </b>endpoint channel number</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><b><span style='font-style:normal'>getPeers()</span></b><span style='font-style:normal'>: list of members separated by |. For example: Kate | John | Linda</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.Group in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node30" id="node30"></a><span style='font-size:12.0pt'>Start</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This message is sent immediately after startup (so from here you can also know that the SIP engine was started successfully).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>START,what</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.Start members:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getWhat()</span></b><span style='font-style:normal'>: START_API or START_SIP</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getWhatText()</span></b><span style='font-style:normal'>: the what value as string:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>“api” -api is ready to use</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>“sip” –sipstack was started</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.Start in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node31" id="node31"></a><span style='font-size:12.0pt'>Stop</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This message is sent when the SIP stack is terminated/destroyed.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>STOP,api</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.Stop members:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getWhat()</span></b><span style='font-style:normal'>: STOP_API or STOP_SIP</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><b><span style='font-style:normal'>getWhatText()</span></b><span style='font-style:normal'>: the what value as string:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>“api” -api is not available anymore</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>“sip” –sipstack was stopped (might not be emitted)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.Stop in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node32" id="node32"></a><span style='font-size:12.0pt'>ShouldReset</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You should restart AJVoIP (or re-init the library) when you receive this notification.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This is usually sent when network was changed (connection type, IP address), thus it might be best to reinitialize the whole SIP stack to recalculate the optimized environment variables and perform the auto network discovery process again (such as STUN lookup, but there are many others).<br> The message is not sent while in call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>SHOULDRESET,reason text</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.ShouldReset members:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><b><span style='font-style:normal'>getReason()</span></b><span style='font-style:normal'>: reason text</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.ShouldReset in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node33" id="node33"></a><span style='font-size:12.0pt'>Line</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This message is sent when the active line is changed (the line parameter is the current active line). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>LINE,line</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.Line members:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><b><span style='font-style:normal'>getLine()</span></b><span style='font-style:normal'>: the new active line number</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.Line in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_EVENT,TYPE,txt"></a><span style='font-size:12.0pt'>Event</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Important events which should be displayed for the user.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>EVENT,TYPE,txt</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: <span style='color:#548DD4'>EVENT,EVENT,any text</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#548DD4;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.Event members: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><b><span style='font-style:normal'>getType()</span></b><span style='font-style:normal'>:<b> </b>the event type: TYPE_EVENT, TYPE_WARNING, TYPE_ERROR, TYPE_CRITICAL, TYPE_UNKNOWN</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><b><span style='font-style:normal'>getTypeText()</span></b><span style='font-style:normal'>: the type as string: EVENT, WARNING, ERROR</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><b><span style='font-style:normal'>getText()</span></b><span style='font-style:normal'>: the message string</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#548DD4;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.Event in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: These messages will not be received if you set the “events” parameter below 2 (default is 2) or the loglevel parameter below 1. </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node34" id="node34"></a><span style='font-size:12.0pt'>Popup</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Should be displayed for the users in some way (hint/toast).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>POPUP,txt</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.Popup members: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><b><span style='font-style:normal'>getText()</span></b><span style='font-style:normal'>: the message string</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.Popup in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example display: <span style='color:#632423'>Toast.makeText(appcontext, txt, Toast.LENGTH_LONG).show();</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_LOG,TYPE,txt"></a><span style='font-size: 12.0pt'>Log</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Detailed logs (may include also the SIP signaling).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Template string: <span style='color:#548DD4'>LOG,TYPE,txt</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIPNotification.Log members: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><b><span style='font-style:normal'>getType()</span></b><span style='font-style:normal'>:<b> </b>the log type: TYPE_EVENT, TYPE_WARNING, TYPE_ERROR, TYPE_CRITICAL, TYPE_UNKNOWN</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><b><span style='font-style:normal'>getTypeText()</span></b><span style='font-style:normal'>: the type as string: EVENT, WARNING, ERROR, CRITICAL, RTP</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><b><span style='font-style:normal'>getText()</span></b><span style='font-style:normal'>: the log string</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the SIPNotification.Log in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: These messages will be received only if you set the <a href="start.htm#_events">events</a> parameter to 3 and also depends on the loglevel.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>With RTP you might receive the media stream details at the end of the calls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: RTP: sent 15695 lasts: 0 (p2p: 0 sdp: 0 rrp: 15695 tnl: 15701), rec: 17281 lastr: 0, loss: 201 1%, vsent: 0/0, vrecv: 0/0, cpu: 0.0%, cpurel: 0.0% (0.0), srvsent: 10326 srvrec: 10302 srvloss: 10 0%</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a name="_LOG,RTP,txt"></a><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="node35" id="node35"></a><span style='font-size:12.0pt'>Other notifications</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Some other rarely required/used notifications are described below:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Format: messageheader, messagetext. </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>“<b>CREDIT</b>” messages are received with the user balance status if the server is sending such messages. </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-style:normal'>Example: “CREDIT,Credit: 2 USD”</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'>See the SIPNotification.Credit in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>“<b>RATING</b>” messages are received on call setup with the current call cost (tariff) or maximum call duration if the server is sending such messages.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> Example: “RATING,15 cents/min”</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'>See the SIPNotification.Rating in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>“<b>NEWUSER</b>” new contact request </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> Example: NEWUSER,usrname,displayname</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'>See the SIPNotification.NewContact in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>“<b>SERVERCONTACTS</b>” contact found at local VoIP server (only by supported servers)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> Example: SERVERCONTACTS,details</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'>See the SIPNotification.ServerContacts in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>“<b>ANSWER</b>” answer for previous request (usually http requests)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> Example: ANSWER,RESULT:the_answer, REQUEST:the_request,EOFANSWER</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'>See the SIPNotification.Answer in the <a href="https://www.mizu-voip.com/Portals/0/Files/ajvoip_javadoc/index.html">javadoc</a><span style='font-style:normal'> </span>for the SIPNotification object details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:dotted #C0504D 1.0pt;border-bottom: dotted #C0504D 1.0pt;border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left: 4.3pt;margin-right:0in'> <h5 style='margin-left:0in'><a name="_Example_session"></a><span style='font-size:12.0pt'>Example session</span></h5> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Here is how the notifications looks like in a typical session (start, register, make a call, hangup, terminate):</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>START,api</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>START,sip</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,-1,Initialized</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,-1,Register...</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>EVENT,EVENT,Connecting...</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,-1,Registering...</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,0,Registering,istvantest2,istvantest2,1,voip.mizu-voip.com,[2e1123294504249584311k49333rmwp],,1,4,0,0,0,0,0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>CREDIT,Credit: 4.2 USD</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,-1,Registered.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>EVENT,EVENT,Authenticated successfully. [ep: 0 2e1123294504249584311k49333rmwp Registering 12538]</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,0,Registered,istvantest2,istvantest2,1,voip.mizu-voip.com,[2e1123294504249584311k49333rmwp],,1,2,0,0,0,0,0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,-1,Starting call to testivr3</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>EVENT,EVENT,call [wpmain]</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,-1,Call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,-1,Call Initiated</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,1,CallSetup,testivr3,istvantest2,1,testivr3,0,0,0,100,,[6e4351661777543861707k49334rmwp],1,2,1,0,0,0,0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,1,Routed,testivr3,istvantest2,1,testivr3,[6e4351661777543861707k49334rmwp],,1,2,1,0,0,0,0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,1,InProgress,testivr3,istvantest2,1,testivr3,[6e4351661777543861707k49334rmwp],,1,2,1,0,0,0,0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,-1,Calling...</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,1,Ringing,testivr3,istvantest2,1,testivr3,[6e4351661777543861707k49334rmwp],,1,2,1,0,0,0,0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,-1,Ringing...</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,1,CallConnect,testivr3,istvantest2,1,testivr3,0,0,0,100,,[6e4351661777543861707k49334rmwp],1,2,2,0,0,0,0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,1,Speaking,testivr3,istvantest2,1,testivr3,[6e4351661777543861707k49334rmwp],,1,2,2,0,0,0,0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,-1,Speaking (0 sec)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,-1,Hangup</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,-1,Speaking (2 sec)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>EVENT,EVENT,hangup [wpmain]</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,1,CallDisconnect,testivr3,istvantest2,1,testivr3,98,98,0,100,,[6e4351661777543861707k49334rmwp],1,2,0,0,0,0,0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,-1,Call Finished</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>CDR,1,testivr3,istvantest2,testivr3,voip.mizu-voip.com,1499,1969,1,User Hung Up (exD),[6e4351661777543861707k49334rmwp]</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,1,Finishing,testivr3,istvantest2,1,testivr3,[6e4351661777543861707k49334rmwp],,1,2,0,0,0,0,0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>EVENT,EVENT,Call duration: 2 sec [ep: 1 6e4351661777543861707k49334rmwp Finishing 12538]</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,1,Finished,testivr3,istvantest2,1,testivr3,[6e4351661777543861707k49334rmwp],,1,2,0,0,0,0,0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,-1,Registered.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STOP,api</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a name="_Example"></a><a name="_Parse_notifications_example"></a><a name="_Parse_notifications_code"></a><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc506369850"></a><a name="_Toc373962382"></a><a name="_Toc373958117"></a><a name="_Toc373366285"></a><a name="_Parameters"></a><span style='font-size:12.0pt;line-height:112%'>Parameters</span></h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The Android SDK is very flexible and you have a long list of parameters that you can use, however this doesn’t mean that the usage is difficult. You can ignore most of these them and use only those few relevant for your needs also outlined in the usage example. Usually you only have to pass the basic parameters and change the advanced parameters only if really required for you specific use-case.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'><br> Parameters can be specified with the </span><a href="start.htm#_boolean_API_SetParameter(String_par"><span style='font-style:normal'>SetParameter</span></a><span style='font-style:normal'> or </span><a href="start.htm#_boolean_SetParameters(String_parame"><span style='font-style:normal'>SetParameters</span></a><span style='font-style:normal'> API calls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: </span><span style='color: #984806;font-style:normal'>mysipclient.SetParameter("username","sdktest2"); </span><span style='font-style:normal'><br> All parameters can be passed as strings and will be converted to the proper type internally by the Android SIP library .<br> <br> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: </p> <p class="MsoListParagraph" style='margin-top:0in;margin-right:0in;margin-bottom: 0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in;line-height: normal'><span style='font-size:9.0pt;font-family:Wingdings;color:#984806; font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span>Once a parameter is set, it might be cached by AJVoIP and used even if you remove it later. To prevent this, always set all the parameters to their value if you changed it before. Strings can be set to “DEF” or “NULL”. So instead of just deleting, set its value to “DEF” or “NULL”. “DEF” means that it will use the parameter default value if any. “NULL” means empty for strings, otherwise the parameter default value. Example: <span style='font-size:9.0pt;color:#984806'>transport=DEF</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806'> </span></p> <p class="MsoListParagraph" style='margin-top:0in;margin-right:0in;margin-bottom: 0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in;line-height: normal'><span style='font-size:8.0pt;font-family:Wingdings;color:#984806; font-style:normal'>§<span style='font:7.0pt "Times New Roman"'> </span></span>Not all parameters can be changed at runtime. It is recommended to set all the relevant parameters (with the SetParameter or SetParameters functions) before to call the Start function. You can just restart the sip stack if you need reconfiguration at runtime (stop the current AJVoIP instance and create a new one).</p> <div style='border:solid #C0504D 1.0pt;border-left:solid #C0504D 6.0pt; padding:0in 4.0pt 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h2 style='margin-left:0in'><a name="_Toc506369851"></a><a name="_Main_Parameters"></a><a name="_Basic_Parameters"></a><span style='font-size:12.0pt;line-height:112%'>Basic Parameters</span></h2> </div> <p class="MsoNormal"><br> <span style='font-size:9.0pt;line-height:120%'>These are the most important parameters.</span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369852"></a><a name="_Toc506243957"></a><a name="_Toc373962384"></a><a name="_Toc373958119"></a><a name="_Toc373366287"></a><a name="_Toc319361627"></a><a name="_Toc255049776"></a><a name="_serveraddress"></a>serveraddress</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The domain name or IP address of your SIP server. By default it uses the standard SIP port (5060). If you need to connect to other port, you can append the port after the address separated by colon. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Examples:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> <span style='color:#984806'>“mydomain.com” </span><span style='color:gray'> -this will use the default SIP port: 5060</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style: normal'>“sip.mydomain.com:5062”</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style: normal'>“10.20.30.40:5065”</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>If not set, then you (or the users) will be able to call only using full SIP URI and it is more difficult to accept incoming calls. If set, then any username/phone number can be called what is accepted by the server.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>As the SIP server you can use any softswitch, IP-PBX, SIP proxy server or SIP gateway (with or without registration). Some SIP services requires the use of an </span><a href="start.htm#_proxyaddress"><span style='font-size:9.0pt'>outbound proxy</span></a><span style='font-size:9.0pt'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369853"></a><a name="_Toc506243958"></a><a name="_Toc373962385"></a><a name="_Toc373958120"></a><a name="_Toc373366288"></a><a name="_Toc319361628"></a><a name="_Toc255049778">username</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This is the SIP username (A number/Caller-ID for the outgoing calls). The AJVoIP SIP endpoint will authenticate with this username on your SIP server.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>When compact is true, then this parameter must be filled properly. Otherwise it can be empty or omitted so the users will have to type it.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is empty. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: If you need a different name for SIP user name and Auth name (authorization name) then you can use the <a href="start.htm#_sipusername">sipusername</a> parameter.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369854"></a><a name="_Toc506243959"></a><a name="_Toc373962386"></a><a name="_Toc373958121"></a><a name="_Toc373366289"></a><a name="_Toc319361629"></a><a name="_Toc255049779">password</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SIP authentication password. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If your server doesn’t require digest authentication or if you need only peer to peer calls then this parameter can be omitted.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:solid #C0504D 1.0pt;border-left:solid #C0504D 6.0pt; padding:0in 4.0pt 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h2 style='margin-left:0in'><a name="_Toc506369858"></a><a name="_Appearance_Parameters"></a><a name="_Advanced_Parameters"></a><span style='font-size:12.0pt;line-height:112%'>Advanced Parameters</span></h2> </div> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:120%'><br> These parameters are more rarely used and should be set only if you have a specific need or a good VoIP/Android knowledge. You should modify only those parameters which you fully understand, otherwise better if you leave all with the default values (the default values are already optimized for production).</span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369859"></a><a name="_Toc506243964"></a><a name="_Toc427878404"></a><a name="_Toc414335082"></a><a name="_Toc373962514"></a><a name="_Toc373958249"></a><a name="_Toc373366417"></a><a name="_Toc319361729"></a><a name="_Toc255049827"></a><a name="_sipusername"></a><span style='font-size: 10.0pt'>sipusername</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify default SIP username. Otherwise the “username” parameter will be used for both the username and the authentication name.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If this is not specified, then the “username” will be used for the From field and also for the authentication.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If both username and sipusername is set then</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-the username will be used in the From and Contact fields (CLI/caller-id)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-the sipusername will be used for authentication only</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369860"></a><a name="_Toc506243965"></a><a name="_Toc427878405"></a><a name="_Toc414335083"></a><a name="_Toc373962515"></a><a name="_Toc373958250"></a><a name="_Toc373366418"></a><a name="_Toc319361730"></a><a name="_Toc255049828"><span style='font-size:10.0pt'>displayname</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify default display name used in “from” and “contact” headers (Enduser full name).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is empty (the “username” field will be displayed for the peers) </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:120%'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369861"></a><a name="_Toc506243966"></a><a name="_Toc427878315"></a><a name="_Toc414334991"></a><a name="_Toc373962430"></a><a name="_Toc373958165"></a><a name="_Toc373366333"></a><a name="_Toc319361670"></a><a name="_Toc255049805">transport</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Transport protocol for the SIP signaling</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1: auto (auto guess)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: UDP (User Datagram Protocol. The most commonly used transport for SIP)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: TCP (signaling via TCP. RTP will remain on UDP)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: TLS (encrypted signaling)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: HTTP tunneling (both signaling and media. Supported only by mizu server or mizu tunnel)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: HTTP proxy connect (requires tunnel server)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5: Auto (automatic failover from UDP to HTTP if needed)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is -1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>TLS/SIPS notes: </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>To enable full encryption set both the transport and the mediaencryption parameters to 2.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>If you set TLS (2), then make sure that you are using the correct <a href="start.htm#_serveraddress">serveraddress</a> parameter. SIP servers usually listens for TLS on port 5061, thus the serveraddress should look like yourdomain:5061.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>If the SIP port is configured to 5061 and the transport parameter is not set (-1), then it might default to 2 (TLS).</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>TLS 1.3 enabled by default from API level 29.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>If you need strict TLS certificate validations (not only encryption) then you might set the <span style='color:#984806'>tlspolicy </span>parameter to 3 (0: def-auto, 1: allows self signed or invalid cert, 2: medium with warning if fails but continue, 3: with server cert validation and disconnect if not secure not allowing failbacks, 4: perform also domain validation). </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Client side certificate can be also set (ask mizutech support if you need this feature).<br> There is also a <span style='color:#984806'>SetSSLContext </span>function if you wish to set your custom SSLContext.</p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:120%'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369862"></a><a name="_Toc506243967"></a><a name="_Toc427878316"></a><a name="_Toc414334992">mediaencryption</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Media encryption method (encryption for the RTP streams)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1: auto (will try SRTP if transport is TLS)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: not encrypted (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: auto (will encrypt if initiated by other party)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: SRTP </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: ZRTP (experimental)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is -1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: To enable full encryption set both the transport and the mediaencryption parameter to 2.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369863"></a><a name="_Toc506243968"></a><a name="_Toc427878317"></a><a name="_Toc414334993">strictsrtp</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Media encryption method</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: most compatible</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: default auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: strict (might disconnect if peer is not respect the standard or on protocol error)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: allow only strict SRTP call, otherwise disconnect</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default: 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node36" id="node36"></a>inet</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Internet protocol (IP layer).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify if you wish to prefer IPv4 or IPv6.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1: Auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: IPv4 only (disable IPv6)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: IPv4 (parse also IPv6)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: Both (prefer IPv4)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: Both (no preference)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: Both (prefer IPv6)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5: IPv6 only (disable IPv4)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is -1/Auto (auto guessed from configurations such as serveraddress and from the SIP signaling / SDP). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Other IP related parameters (all are set based on this inet parameter, but can be set also separately if you have some special requirement): <br> hasipv4 (true/false), hasipv6 (true/false), listenonipv6 (true/false), ipvdualstack (true/false), cropipv6scopeid (true/false), preferipv (-1: auto (def to 1), 0: no preference, 1: prefer ipv4, 2: prefer ipv6)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369864"></a><a name="_Toc506243969"></a><a name="_Toc427878312"></a><a name="_Toc414334987"></a><a name="_Toc373962426"></a><a name="_Toc373958161"></a><a name="_Toc373366329"></a><a name="_Toc319361666"></a><a name="_Toc255049777"></a><a name="_proxyaddress"></a>proxyaddress</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Outbound proxy address (Examples: mydomain.com, mydomain.com:5065, 10.20.30.40:5065)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Leave it empty if you don’t have a stateless proxy. (Use only the serveraddress parameter)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is empty. </span></p> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:120%;font-style: normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369865"></a><a name="_Toc506243970"></a><a name="_Toc427878400"></a><a name="_Toc414335078"></a><a name="_Toc373962510"></a><a name="_Toc373958245"></a><a name="_Toc373366413"></a><a name="_Toc319361725"><span style='font-size:10.0pt'>md5</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Instead of using the password parameter you can pass an MD5 checksum for better protection: MD5(username:realm:password)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>(The parameters are separated with the ‘:’ character)<span style='font-style:normal'><br> </span>The realm is usually your server domain name or IP address (otherwise it is set on your server)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>If you are not sure, you can find out the realm in the “Authenticate” headers sent by your server with the” 401 Unauthorized” messages. Example:</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806'>WWW-Authenticate: Digest realm="YOURREALM", nonce="xxx", stale=FALSE, algorithm=MD5</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369866"></a><a name="_Toc506243971"></a><a name="_Toc427878401"></a><a name="_Toc414335079"></a><a name="_Toc373962511"></a><a name="_Toc373958246"></a><a name="_Toc373366414"></a><a name="_Toc319361726"><span style='font-size:10.0pt'>realm</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set if your server realm (SIP domain) is not the same with the “serveraddress” parameter. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If the “md5” parameter was set, then this must match with the realm used to calculate the md5 checksum.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is empty, which means that the “serveraddress” will be used.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369855"></a><a name="_Toc506243960"></a><a name="_Toc373962387"></a><a name="_Toc373958122"></a><a name="_Toc373366290"></a><a name="_Toc319361630"></a><a name="_Toc255049780"></a><a name="_register"></a>register</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>With this parameter you can set whether the SIP UA should register (connect) to the sip server.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: auto guess (yes if username/password is set, otherwise no)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>AJVoIP will also reregister automatically based on the “registerinterval” parameter. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc427878305"></a><a name="_Toc414334979"></a><a name="_Toc373962419"></a><a name="_Toc373958154"></a><a name="_Toc373366322"><span style='font-size:10.0pt'>registerinterval</span></a><span style='font-size: 10.0pt'> </span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Registration interval in <b>seconds</b> (used by the re-registration expires timer).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is -1 (auto guess) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Valid range is -1 (auto) or between 10 and 30000. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Notes:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Many servers will not accept values above 3600 (although the SIP stack can be auto adjust it based on server negotiation)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>The actual resend of the REGISTER messages might be done at a shorter interval to cover any potential packet loss and network/server delays.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>When set to auto guess (-1), it will calculate an optimal interval depending on the circumstances such as network type, server load, transport method, data saver settings and others. It will result to around 90-180 under normal conditions on UDP or 600 on TCP.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>If your softswitch supports keep-alive messages (to prevent NAT binding timeouts), then you might set to a longer interval (~3600 sec) to prevent high CPU usage on your server especially if you have many hundreds of SIP UA running at the same time. If your server doesn’t support keep-alive, then you might set this to a lower value (between 30 and 90 sec. 60 sec is a good choice for most NAT devices and routers). Note that usually this is not necessary because server side support is not needed to keep the NAT bindings.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>If the register expire interval is not accepted by the server, then the SIP stack is capable to automatically negotiate a new value as directed by the server Min-Expire header or auto-guess.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>The register expires might be auto set to a higher value if push notifications are enabled to reduce the need of push re-register/rebind requests.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369875"></a><a name="_Toc506243980"></a><a name="_Toc427878306"></a><a name="_Toc414334981">needunregister</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to false to prevent unregister messages to be sent by AJVoIP (for example to prevent unregister on web page reload).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is true</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369876"></a><a name="_Toc506243981"></a><a name="_extraregisteraccounts"></a>extraregisteraccounts</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Use this setting for multi-account registration.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can specify multiple SIP accounts in the following format:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>IP,usr,pwd,t,proxy,realm,authuser;IP2,usr2,pwd2;IP3,usr3,pwd3, , ,realm3;IP4,usr4,pwd4…</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>where:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>IP: is the SIP server address (domain or IP:port)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>usr: is the SIP username</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>pwd: is the SIP password</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>t: is the register timeout in seconds (optional)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>proxy: SIP proxy (optional)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>realm: SIP realm (optional)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>authusr: auth (sipusername if separate extension id and authorization username have to be used)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>See the <a href="start.htm#_Multiple_account_registration_1">Multiple account registration</a> FAQ for more details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369877"></a><a name="_Toc506243982"></a><a name="_Toc427878307"></a><a name="_Toc414334982"></a><a name="_Toc373962421"></a><a name="_Toc373958156"></a><a name="_Toc373366324">acceptsrvexpire</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Accept the expires interval sent by the server.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: yes (prioritize the contact expire)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: yes (prioritize the global expire)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc427878304"></a><a name="_Toc414334978"></a><a name="_Toc373962418"></a><a name="_Toc373958153"></a><a name="_Toc373366321"></a><a name="_Toc319361660">keepaliveival</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>NAT keep-alive packet send interval in milliseconds.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Keep-alive is a mechanism to keep the NAT open between register resends (so the server can initiate a new incoming transaction on the same stream with no issues, such as incoming call).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>-1: auto (will default to around 28000 -28 sec- on UDP and 600000 – 10 min- on TCP)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>0: disabled</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>other: interval in milliseconds (must be above 3000, otherwise treated as seconds)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is -1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369872"></a><a name="_Toc506243977"></a><a name="_Toc427878303"></a><a name="_Toc414334977"></a><a name="_Toc373962417"></a><a name="_Toc373958152"></a><a name="_Toc373366320"></a><a name="_Toc319361659">keepalivetype</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>NAT keep-alive packet type.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no keep-alive</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=space + CRLF (_\r\n) (very efficient because low bandwidth and low server usage)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=NOTIFY (standard method)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=CRLF (\r\n) (very efficient because low bandwidth and low server usage. Not recommended)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4=CRLFCRLF (\r\n\r\n) (very efficient because low bandwidth and low server usage. After RFC draft)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 4.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369856"></a><a name="_Toc506243961"></a><a name="_Toc427878272"></a><a name="_Toc373962388"></a><a name="_Toc373958123"></a><a name="_Toc373366291"></a><a name="_Toc319361631"></a><a name="_Toc255049781">autocall</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If set to true then the Android SIP library will immediately starts the call with the given parameters (for example with your page load). The serveraddress, username, password, callto must be also set for this to work.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369857"></a><a name="_Toc506243962"></a><a name="_Toc373962389"></a><a name="_Toc373958124"></a><a name="_Toc373366292"></a><a name="_Toc319361632"></a><a name="_Toc255049782">callto</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Can be any phone number/username that can be accepted by your server or a SIP URI. Used with “autocall” to specify the destination number.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369867"></a><a name="_Toc506243972"></a><a name="_Toc427878299"></a><a name="_Toc414334973"></a><a name="_Toc373962414"></a><a name="_Toc373958149"></a><a name="_Toc373366317"></a><a name="_Toc319361656"></a><a name="_Toc255049783">use_rport</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Check rport in SIP signaling (requested and received from the SIP server by the VIA header) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=don’t ask (rtport request will not be added to the VIA header)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=use only for symmetric NAT (only when it is sure that the public address will be correct)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=always (always request and use the returned value except if already on public ip)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=request even on public IP (meaningless in most cases)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>9=request with the signaling, but don’t use the returned value (good If you want to keep the local IP and for peer to peer calls)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Change to 0 or 2 only if you have NAT issues (depending on your server type and settings)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(You might adjust also the use_fast_stun parameter if you change the use_rport) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369868"></a><a name="_Toc506243973">upnpnat</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Nat traversal via UpNP supported routers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: disable</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: enable</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369869"></a><a name="_Toc506243974"></a><a name="_Toc427878300"></a><a name="_Toc414334974">use_fast_ice</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Fast ICE negotiations (for p2p rtp routing):</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no (set to 0 only if your server needs to always route the media)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=always (not recommended)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: if set to 1 or 2 then the stun should not be disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369870"></a><a name="_Toc506243975"></a><a name="_Toc427878301"></a><a name="_Toc414334975"></a><a name="_Toc373962415"></a><a name="_Toc373958150"></a><a name="_Toc373366318"></a><a name="_Toc319361657"></a><a name="_Toc255049784">use_fast_stun</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Fast stun request on startup.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1=force private address (if the client has both private and public IP, than the private IP will be sent in the signaling)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=use only for stable symmetric NAT </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=use only if both tests match even if not symmetric (recommended)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=use for symmetric NAT even if only one match</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4=always</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5=use even on public IP</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Change if you have NAT issues (depending on your server type and settings)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(You might adjust also the use_rport parameter if use_fast_stun is changed)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369871"></a><a name="_Toc506243976"></a><a name="_Toc427878302"></a><a name="_Toc414334976"></a><a name="_Toc373962416"></a><a name="_Toc373958151"></a><a name="_Toc373366319"></a><a name="_Toc319361658">udpconnect</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify whether the UDP have to be connected before sending on the socket. (Some IP-PBX might require udp connect and in this way the Android SIP library can always detect its local address correctly. However this should not be used whit multiple servers or separate domain and outbound proxy)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=on init</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=on first send (not recommended. can block)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=on both or any (not recommended)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value: 0</span><br> <br> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369878"></a><a name="_Toc506243983"></a><a name="_Toc427878308"></a><a name="_Toc414334983"></a><a name="_Toc373962422"></a><a name="_Toc373958157"></a><a name="_Toc373366325"></a><a name="_Toc319361662">changesptoring</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If to treat session progress (183) responses as ringing (180). This is useful because some IP-PBX never sends the ringing message, only a session progress and might start to send in-band ringing (or some announcement)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The following values are defined:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: do nothing,</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: change status to ring</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: start local ring and be ready to accept media (which is usually a ringtone or announcement)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: start media receive and playback (and media recording if the “earlymedia” parameter is set)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: change status to ringing and start media receive and playback (and media recording if the “earlymedia” parameter is set to true)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 2.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>*Note: on ringing status AJVoIP is able to generate local ringtone. However this locally generated ringtone playback is stopped immediately when media is started to be received from the server (allowing the user to hear the server ringback tone or announcements)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369879"></a><a name="_Toc506243984">allowcallredirect</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to 1 to auto-redial on 301/302 call forward.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to 0 to disable auto call forward.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369880"></a><a name="_Toc506243985"></a><a name="_Toc427878309"></a><a name="_Toc414334984"></a><a name="_Toc373962423"></a><a name="_Toc373958158"></a><a name="_Toc373366326"></a><a name="_Toc319361663">natopenpackets</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Change this option only if you have RTP setup issues with your server(s).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>UDP packets to send to open the NAT device and initiate the RTP. Some servers will require at least 5 packets before starting to send the media after the 183 “session in progress” response. In this case set this value to 10 (In this way the server will receive at least 5 packets even on high packet loss networks)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: write only an empty udp packet</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: write a normal RTP packet</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3 or more: write this number of RTP packets</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>*Note: instead of sending more “fake” packets, you can set the “earlymedia” to 1 or more to begin the rtp stream immediately.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>*Note: you can use the “natopenpackettype” to specify the format. 1 means short CRLFCRLF packet (default). 2 means full RTP packet with zeroed content.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369881"></a><a name="_Toc506243986"></a><a name="_Toc427878310"></a><a name="_Toc414334985"></a><a name="_Toc373962424"></a><a name="_Toc373958159"></a><a name="_Toc373366327"></a><a name="_Toc319361664">earlymedia</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Start to send media when session progress is received.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: reserved</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: auto (will early open audio if wideband is enabled to check if supported)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: just early open the audio</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: null packets only when sdp received</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5: yes when sdp received</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>6: always forced yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>*Note: For the early media to work, AJVoIP has to open the NAT when SDP is received. This can be done by sending a few fake rtp packets or by starting to send the media immediately when session in progress is received. The first method consume less bandwidth, but it is not supported by some softswitch.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369883"></a><a name="_Toc506243988"></a><a name="_Toc427878313"></a><a name="_Toc414334988"></a><a name="_Toc373962427"></a><a name="_Toc373958162"></a><a name="_Toc373366330"></a><a name="_Toc319361667">usehttpproxy</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Used only for HTTP tunneling with Mizu VoIP servers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: same as sip proxy (proxyaddress)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: system default</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: manual (must be set by the httpproxyurl parameter –deprecated after version 3.5)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 4.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369884"></a><a name="_Toc506243989"></a><a name="_Toc427878314"></a><a name="_Toc414334990"></a><a name="_Toc373962429"></a><a name="_Toc373958164"></a><a name="_Toc373366332"></a><a name="_Toc319361669">httpserveraddress</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Useful when the transport parameter is set to 4 (auto) to specify the http tunneling gateway address.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is null (address loaded from the “serveraddress” parameter)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 5.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in;border:none;padding:0in'><a name="_Toc506369885"></a><a name="_Toc506243990"></a><a name="_Toc427878319"></a><a name="_Toc414334995"></a><a name="_Toc373962432"></a><a name="_Toc373958167"></a><a name="_Toc373366335"></a><a name="_Toc319361671"></a><a name="_dtmfmode"></a>dtmfmode</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>DTMF send method</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=SIP INFO method (out-of-band in SIP signaling INFO messages)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=auto (auto guess from peer advertised capabilities)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=INFO + NTE</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4=NTE (Named Telephone Events as specified in RFC 2833 and RFC 4733)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5=In-Band (DTMF audio tones in the RTP stream)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>6=INFO + InBand</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2 (and you should change it only if you have a good reason to do so, since the auto-detect should work in all circumstances, except if your SIP server is sending bogus DTMF capabilities).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: When more than one method is used (dtmfmode 3 or 6), the receiver might receive duplicated dtmf digits. </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 5.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in;border:none;padding:0in'><a name="_Toc506369886"></a><a name="_Toc506243991">sendearlydtmf</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify whether to allow sending DTMF digits before call connect</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=auto (yes if rfc2833 or inband is allowed and already sent/received rtp packets)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=yes (always send)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default: 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369887"></a><a name="_Toc506243992"></a><a name="_Toc427878320"></a><a name="_Toc414334996"></a><a name="_Toc373962433"></a><a name="_Toc373958168"></a><a name="_Toc373366336"></a><a name="_Toc319361673"></a><a name="_voicemail"></a>voicemail</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Subscribe to voicemail notifications (MWI). Accepted values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=display voicemail only if NOTIFY is received automatically without subscription</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=auto-detect if voicemail SUBSCRIBE is needed </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=subscribe for voicemail messages after successful registration</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4=subscribe for voicemail messages on startup</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 2. Set to 3 if your server has support for MWI to be sure that AJVoIP will check the voicemail.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For voicemail you can receive MWI </span><a href="start.htm#_Notifications"><span style='font-style:normal'>notifications</span></a><span style='font-style:normal'> in the following format: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>MWI,hasvoicemail,voicemailnumber,to,count,message</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>hasvoicemail: yes or no (Messages-Waiting indicator)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>voicemailnumber: voicemail number (as configured or as received in Message-Account)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>to: username from the SIP To header (usually the local account username, useful if you have multiple accounts)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>count: number of pending messages</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>message: message text if sent by the server (Voice-Message)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: MWI,yes,5001,1111,3,3/0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369888"></a><a name="_Toc506243993"></a><a name="_Toc427878321"></a><a name="_Toc414334997"></a><a name="_Toc373962434"></a><a name="_Toc373958169"></a><a name="_Toc373366337"></a><a name="_Toc319361674"></a><a name="_voicemailnum"></a>voicemailnum</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(String)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify the voicemail address. Most IP-PBX will automatically send the voicemail access number so you don’t need to set this parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369889"></a><a name="_Toc506243994"></a><a name="_Toc427878322"></a><a name="_Toc414334998"></a><a name="_Toc373962435"></a><a name="_Toc373958170"></a><a name="_Toc373366338"></a><a name="_Toc319361675"></a><a name="_Toc255049806"></a><a name="_transfertype"></a>transfertype</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1=default transfer type (same as 6)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=call transfer is disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=transfer immediately and disconnect with the A user when the Transf button is pressed and the number entered (unattended transfer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=transfer the call only when the second party is disconnected (attended transfer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=transfer the call when AJVoIP is disconnected from the second party (attended transfer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4=transfer the call when any party is disconnected except when the original caller was initiated the disconnect (attended transfer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5=transfer the call when AJVoIP is disconnected from the second party. Put the caller on hold during the call transfer (standard attended transfer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>6=transfer the call immediately with hold and watch for notifications (unattended transfer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>7=transfer with no hold and no disconnect</span><span style='font-style:normal'> (simplest unattended transfer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>8=transfer with conference (will put the parties to conference on transfer; will mute or hold the old party by default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is -1 (which is the same as 6)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Unattended means simple immediate transfer (just a REFER message sent)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Attended transfer means that there will be a consultation call first</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>The most popular transfertypes are 1, 5 and 6</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>If you have any incompatibility issue, then set to 7 (unattended is the simplest way to transfer a call and all sip server and device should support it correctly)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>More details can be found </span><a href="start.htm#_Transfer_API_usage"><span style='font-size:9.0pt'>here</span></a><span style='font-size:9.0pt'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369890"></a><a name="_Toc506243995"></a><a name="_Toc427878323"></a><a name="_Toc414334999"></a><a name="_Toc373962436"></a><a name="_Toc373958171"></a><a name="_Toc373366339"></a><a name="_Toc319361676"><span style='font-size:9.0pt'>transfwithreplace</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Specify if replace should be used with transfer so the old call (dialog) is not disconnected but just replaced.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>This way the A party is never disconnected, just the called party is changed. The A party must be able to handle the replace header for this.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>-1=auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>1=yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Default is -1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369891"></a><a name="_Toc506243996"></a><a name="_Toc427878324"></a><a name="_Toc414335000"></a><a name="_Toc373962437"></a><a name="_Toc373958172"></a><a name="_Toc373366340"><span style='font-size:9.0pt'>allowreplace</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Allow incoming replace requests.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>1=yes and always disconnect old ep</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>2=yes and don't disconnect if in transfer</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>3=yes but never disconnect old ep</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Default is 2.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369892"></a><a name="_Toc506243997"></a><a name="_Toc427878325"></a><a name="_Toc414335002"></a><a name="_Toc373962439"></a><a name="_Toc373958174"></a><a name="_Toc373366342"><span style='font-size:9.0pt'>discontransfer</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Specify if line should disconnect after transfer if not determined by the other transfer related configurations.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>-1=auto<br> 0=never</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>1= on C party connected status </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>2= on timeout</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>3= on connected or timeout</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>4= on ok for refer</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Default is -1<br> <br> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369893"></a><a name="_Toc506243998"></a><a name="_Toc427878326"></a><a name="_Toc414335003"></a><a name="_Toc373962440"></a><a name="_Toc373958175"></a><a name="_Toc373366343"><span style='font-size:9.0pt'>disconincomingrefer</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Specify if line should disconnect after incoming</span><span style='font-size:9.0pt'> </span><span style='font-size:9.0pt;font-style:normal'>transfer</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>-1=auto<br> 0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>1= yes </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Default is -1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369894"></a><a name="_Toc506243999"></a><a name="_Toc427878327"></a><a name="_Toc414335004"></a><a name="_Toc373962441"></a><a name="_Toc373958176"></a><a name="_Toc373366344"></a><a name="_Toc319361678"><span style='font-size:9.0pt'>transferdelay</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Milliseconds to wait before sending REFER/INVITE while in transfer.<br> Default value is 400.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369895"></a><a name="_Toc506244000"></a><a name="_Toc427878328"></a><a name="_Toc414335005"></a><a name="_Toc373962442"></a><a name="_Toc373958177"></a><a name="_Toc373366345"><span style='font-size:9.0pt'>checksubscriptionstate</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Specify if to handle transfer subscription state (such as reload the call on transfer failure)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>-1=auto<br> 0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>1= disconnect</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>2= reload </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Default is -1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369896"></a><a name="_Toc506244001"></a><a name="_Toc427878329"></a><a name="_Toc414335006"></a><a name="_Toc373962443"></a><a name="_Toc373958178"></a><a name="_Toc373366346"><span style='font-size:9.0pt'>subscribefortransfer</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Create subscribe dialog for call transfer.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>-1=auto<br> 0=never</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>1= if no notify received</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>2= always</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Default is -1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369897"></a><a name="_Toc506244002">enabledirectcalls</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Specify whether to enable direct call to SIP URI (peer to peer or via server)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>0=no (so you should use only the username part of the SIP URI to make calls. set the domain part as the sipserveraddress parameter)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>1=check IP in URI (will recognize full SIP URI if the domain part can be resolved to a valid IP)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>2=always check (so you can make calls to full SIP URI without a SIP server to be set)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>3=crossdomain (so you can register to domain A and make direct call to domain B)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Default is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369898"></a><a name="_Toc506244003"></a><a name="_Toc427878281"></a><a name="_Toc414334955"><span style='font-size:10.0pt'>charset</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set the character decoding for SIP signaling.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is empty (will load the local system default).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>More details:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html"><span style='font-style:normal'>http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="http://www.iana.org/assignments/character-sets/character-sets.xhtml"><span style='font-style:normal'>http://www.iana.org/assignments/character-sets/character-sets.xhtml</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369899"></a><a name="_Toc506244004"></a><a name="_Toc427878330">checksrvrecords</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SRV DNS record lookup setting:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1: auto (will check SRV record for the VoIP server, but remembers if fails and will not check again next time)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: don’t lookup (will use only A record) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: lookup A record first. If fails then lookup srv record (because mostly the srv record is not set anyway) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: lookup SRV record first for VoIP server address. If fails then lookup A record (RFC compliant)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: always lookup SRV record first. If fails then lookup A record</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: check also without the _sip._udp. prefix</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If the SRV lookup returns multiple records, than SIP UA will failover to the next server on connection failures.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is -1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369900"></a><a name="_Toc506244005"></a><a name="_Toc427878331"></a><a name="_Toc414335008"></a><a name="_Toc373962445"></a><a name="_Toc373958180"></a><a name="_Toc373366348">dnslookup</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Domain record lookup mode</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=auto (same as 2)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=yes always re-query</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=use cache if needed (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=use cache whenever possible</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4=from cache only</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5=disable</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 0.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369901"></a><a name="_Toc506244006">forcewifi</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Force WiFi network.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=lock in call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=lock always</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4=always</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5=always lock</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>6=extra</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value: 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369902">keepdeviceawakeincall</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Keep device awake during calls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=basic only</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=full then partial</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4=always full only </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value: 2</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node37" id="node37"></a>cpupartiallock</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Keep a partial lock on the CPU while in call to prevent sleep.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is true.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369903">cpualwayspartiallock</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Always keep a partial lock on the CPU to prevent sleep.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node38" id="node38"></a>unlockphone</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Auto handle keyguard lock.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is true.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369904"></a><a name="_Toc506244007">proximitysensor</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Enable/disable proximity sensor during calls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=disable</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=software based (deprecated)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=hardware based</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value: 2</span></p> <p class="MsoNormal"><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node39" id="node39"></a>checknativecall</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify how to handle if there is a native/mobile call in progress.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal"><span style='font-style:normal'>0=don’t check (will behave as it would be without native call in progress)<br> 1=basic behavior changes (such as no ring)<br> 2=don’t alter the audio<br> Default value: 1<br> </span>Should be set to 1 if using connection service or keep 1 always.</p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369906"></a><a name="_Toc506244009">autousebluetooth</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify when to use Bluetooth device.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=guess</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value: 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Set this parameter to 2 before the call if you have Bluetooth connectivity issues.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_video"></a>video</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Enable/disable video.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><a name="OLE_LINK8"></a><a name="OLE_LINK7"><span style='line-height:120%; font-style:normal'>-1: auto</span></a><span style='line-height:120%;font-style: normal'> (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: disable</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: enable</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: force always</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>RTC capabilities must be available for video to work.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369905"></a><a name="_Toc506244008">aspeakermode</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Speaker device to be used.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal"><span style='font-style:normal'>0=default (usually speakerphone/headphone)<br> 1=headphone (speakerphone/headphone)<br> 2=speakerphone (loudspeaker)<br> Default value: 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node40" id="node40"></a>audiomanagermode</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Overwrite audio mode which is set by AJVoIP by calling the AudioManager.setMode API.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>By default AJVoIP will set the audio mode depending on the circumstances (call type, OS version, etc). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You might use this parameter to force an audio mode after your needs. It can be also changed at runtime and it will be applicable for the next setMode function calls. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-9: automatically managed by AJVoIP (recommended)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-8: never change</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: MODE_NORMAL</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: MODE_RINGTONE</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: MODE_IN_CALL</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: MODE_IN_COMMUNICATION</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: MODE_CALL_SCREENING</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5: MODE_CALL_REDIRECT</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>6: MODE_COMMUNICATION_REDIRECT</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value: -9</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369907"></a><a name="_Toc506244010">focusaudio</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify whether to use audio “focus”. (Auto decrease the volume of other apps).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value: 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369908"></a><a name="_Toc506244011">speakerphoneoutput</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Speakerphone output device.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: Auto guess</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: Speaker</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: Speaker Forced</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: VoIP</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: Bluetooth</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5: No changes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value: 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369909"></a><a name="_Toc506244012">audiorecorder</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Audio recorder stream.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: Default</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: Auto guess</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: Mic</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: Voice call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: Voice downlink</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5: Voice uplink</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>6: Voice communication</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value: 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(Normally it should be set to 0,1 or 2. Other values are very unusual)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369910"></a><a name="_Toc506244013">audioplayer</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Audio player stream for calls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: STREAM_VOICE_CALL</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: STREAM_SYSTEM</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: STREAM_RING</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: STREAM_MUSIC</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: STREAM_ALARM</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5: STREAM_NOTIFICATION</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value: 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369911"></a><a name="_Toc506244014">speakerphoneplayer</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Audio speakerphone player stream.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: STREAM_VOICE_CALL</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: STREAM_SYSTEM</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: STREAM_RING</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: STREAM_MUSIC</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: STREAM_ALARM</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5: STREAM_NOTIFICATION</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>6: default</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value: 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369912"></a><a name="_Toc506244015">incomingcallalert</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Audio player stream for ring.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: STREAM_VOICE_CALL</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: STREAM_SYSTEM</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: STREAM_RING</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: STREAM_MUSIC</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: STREAM_ALARM</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5: STREAM_NOTIFICATION</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value: 2</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node41" id="node41"></a>audioplayerusage</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>With this, you might overwrite the setUsage parameter for the </span><a href="https://developer.android.com/reference/android/media/AudioAttributes.Builder"><span style='font-style:normal'>AudioAttributes</span></a><span style='font-style: normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is USAGE_VOICE_COMMUNICATION.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369913"></a><a name="_Toc506244016">speakermode</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify when to switch to speaker mode.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: auto </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: never</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: always</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value: 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node42" id="node42"></a>useaudiodevicerecord</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to false if you wish to disable audio recording from the local audio device. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You might set it to false if you wish to only receive the audio from the peer (not send) or if you will </span><a href="start.htm#_How_to_send"><span style='font-style:normal'>stream</span></a><span style='font-style:normal'> from an external source or from your app.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is true.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_useaudiodeviceplayback"></a>useaudiodeviceplayback</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to false if you wish to disable audio playback on the local audio device. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You might set it to false if you wish to only send the audio from the peer (not receive) or if you will </span><span style='font-style:normal'>process the incoming audio stream</span><span style='font-style:normal'> yourself in your app. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is true.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369914"></a><a name="_Toc506244017">enableaudiostreams</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can disable audio playback and/or recording streams with this option (will still open the device, but will not record/playback)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=disable all</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=disable recording</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=disable playback</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=enable all</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 3.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_useaudiodevicerecord"></a>useaudiodevicerecord</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to false to disable using the audio input device (microphone). In this case you should also set the mediatimeout parameter to 0.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is true.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node43" id="node43"></a>useaudiodeviceplayback</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to false to disable using the audio output device (speaker/earphone). In this case you should also set the mediatimeout parameter to 0.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is true.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369915">vibrate</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Vibrate on incoming call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=auto (depends on phone settings)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 0.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369916"></a><a name="_Toc506244021"></a><a name="_Toc427878335"></a><a name="_Toc414335012"></a><a name="_Toc373962449"></a><a name="_Toc373958184"></a><a name="_Toc373366352"></a><a name="_Toc319361680"></a><a name="_Toc255049807">playring</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Generate ringtone for incoming and outgoing calls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no (you can generate ringtone also by using the Java API to playback a sound file when you receive ringing notifications)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=play ringtone for incoming calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=play ringtone for incoming and outgoing calls. (ringtone for outgoing calls can be generated also by your VoIP sever. When remote ringtone is received, java softphone will stop the local ringtone playback immediately and starts to play the received ringtone or announcement)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369917"></a><a name="_Toc506244022"></a><a name="_Toc427878336"></a><a name="_Toc414335013"></a><a name="_Toc373962450"></a><a name="_Toc373958185"></a><a name="_Toc373366353"></a><a name="_Toc319361681">ringtone</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify a ringtone sound file or URI (system ring tones) to be used.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>If you use a file instead of a system ringtone URI:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Set only the file name, not the full path. Copy the file to your app folder or near the AJVoIP library</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>The file should be in the following format: PCM SIGNED 8000.0 Hz (8 kHz) 16 bit mono (2 bytes/frame) in little-endian (128 kbits).</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>You can use any sound editor to convert your file to this format (usually from File menu -> Save as).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is empty. If not specified, then AJVoIP will use the default ringtone for call alert.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><u><span style='font-style:normal'>Example:</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal"><span style='line-height:120%;font-style:normal'>This example code illustrates how to present the UI for the user for choosing a native ringtone from android device ad how to get the path of the ringtone audio file:</span></p> <p class="MsoNormal"><span style='line-height:120%;font-style:normal'>Open ringtone UI:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;background: white'><b><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New"; color:navy;font-style:normal'>public final int </span></b><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New";color:black; font-style:normal'>RINGTONE_REQCODE = </span><span style='font-size:8.0pt; line-height:120%;font-family:"Courier New";color:blue;font-style:normal'>123456</span><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New";color:black; font-style:normal'>;</span><span style='font-size:9.0pt;line-height:120%; color:#7F7F7F;font-style:normal'> // request code used in onActivityResult</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;background: white'><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New"; color:black;font-style:normal'>String title = </span><b><span style='font-size: 8.0pt;line-height:120%;font-family:"Courier New";color:green;font-style:normal'>"Select your ringtone"</span></b><span style='font-size:8.0pt;line-height:120%; font-family:"Courier New";color:black;font-style:normal'>;<br> <br> Intent intent = </span><b><span style='font-size:8.0pt;line-height:120%; font-family:"Courier New";color:navy;font-style:normal'>new </span></b><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New";color:black; font-style:normal'>Intent(RingtoneManager.ACTION_RINGTONE_PICKER);<br> intent.putExtra(RingtoneManager.EXTRA_RINGTONE_TITLE, title);<br> intent.putExtra(RingtoneManager.EXTRA_RINGTONE_SHOW_SILENT, </span><b><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New";color:navy; font-style:normal'>false</span></b><span style='font-size:8.0pt;line-height: 120%;font-family:"Courier New";color:black;font-style:normal'>);<br> intent.putExtra(RingtoneManager.EXTRA_RINGTONE_SHOW_DEFAULT, </span><b><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New";color:navy; font-style:normal'>true</span></b><span style='font-size:8.0pt;line-height: 120%;font-family:"Courier New";color:black;font-style:normal'>);<br> intent.putExtra(RingtoneManager.EXTRA_RINGTONE_TYPE, RingtoneManager.TYPE_ALL);<br> startActivityForResult(intent, RINGTONE_REQCODE);</span></p> <pre style='background:white'><span style='font-family:"Calibri",sans-serif; font-style:normal'> </span></pre><pre style='background:white'><span style='font-family:"Calibri",sans-serif;font-style:normal'>Get the path to the selected ringtone in </span><span style='font-size:8.0pt;color:black;font-style:normal'>onActivityResult:</span></pre> <p class="MsoNormal"><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;background: white'><b><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New"; color:navy;font-style:normal'>protected void </span></b><span style='font-size: 8.0pt;line-height:120%;font-family:"Courier New";color:black;font-style:normal'>onActivityResult(</span><b><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New";color:navy; font-style:normal'>int </span></b><span style='font-size:8.0pt;line-height: 120%;font-family:"Courier New";color:black;font-style:normal'>requestCode, </span><b><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New";color:navy; font-style:normal'>int </span></b><span style='font-size:8.0pt;line-height: 120%;font-family:"Courier New";color:black;font-style:normal'>resultCode, Intent data)<br> {<br> </span><b><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New"; color:navy;font-style:normal'>if </span></b><span style='font-size:8.0pt; line-height:120%;font-family:"Courier New";color:black;font-style:normal'>(requestCode == RINGTONE_REQCODE)<br> {<br> </span><b><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New"; color:navy;font-style:normal'>if</span></b><span style='font-size:8.0pt; line-height:120%;font-family:"Courier New";color:black;font-style:normal'>(resultCode == RESULT_OK)<br> {<br> String ringTonePath = </span><b><span style='font-size:8.0pt; line-height:120%;font-family:"Courier New";color:green;font-style:normal'>""</span></b><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New";color:black; font-style:normal'>;<br> Uri uri = data.getParcelableExtra(RingtoneManager.EXTRA_RINGTONE_PICKED_URI);<br> </span><b><span style='font-size:8.0pt;line-height:120%;font-family: "Courier New";color:navy;font-style:normal'>if </span></b><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New";color:black; font-style:normal'>(uri != </span><b><span style='font-size:8.0pt;line-height: 120%;font-family:"Courier New";color:navy;font-style:normal'>null</span></b><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New";color:black; font-style:normal'>)<br> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;background: white'><span style='font-size:9.0pt;line-height:120%;color:#7F7F7F;font-style: normal'> // the absolute path to the ringtone audio file selected by the user</span><span style='font-size:8.0pt;line-height:120%; font-family:"Courier New";color:black;font-style:normal'><br> ringTonePath = uri.toString();<br> Log.v(</span><b><span style='font-size:8.0pt;line-height:120%; font-family:"Courier New";color:green;font-style:normal'>"AJVOIP"</span></b><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New";color:black; font-style:normal'>, </span><b><span style='font-size:8.0pt;line-height:120%; font-family:"Courier New";color:green;font-style:normal'>"User selected ringtone path: " + </span></b><span style='font-size:8.0pt;line-height: 120%;font-family:"Courier New";color:black;font-style:normal'>ringTonePath);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;background: white'><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New"; color:black;font-style:normal'> </span><span style='font-size:9.0pt; line-height:120%;color:#7F7F7F;font-style:normal'> // pass it to AJVoIP</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;background: white'><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New"; color:black;font-style:normal'> mysipclient.SetParameter("ringtone", ringTonePath);<br> }<br> }<br> </span><b><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New"; color:navy;font-style:normal'>if </span></b><span style='font-size:8.0pt; line-height:120%;font-family:"Courier New";color:black;font-style:normal'>(resultCode == RESULT_CANCELED)<br> { <br> Log.v(</span><b><span style='font-size:8.0pt;line-height:120%; font-family:"Courier New";color:green;font-style:normal'>"AJVOIP"</span></b><span style='font-size:8.0pt;line-height:120%;font-family:"Courier New";color:black; font-style:normal'>, </span><b><span style='font-size:8.0pt;line-height:120%; font-family:"Courier New";color:green;font-style:normal'>"user canceled ringtone selection"</span></b><span style='font-size:8.0pt;line-height: 120%;font-family:"Courier New";color:black;font-style:normal'>);<br> }<br> }<br> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369918"></a><a name="_Toc506244023"></a><a name="_Toc427878337"></a><a name="_Toc414335014"><span style='font-size:10.0pt'>ringincall</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Ring while in call if incoming or outgoing call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=No</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=Only a beep for incoming call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=Yes, normal ring</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369919"></a><a name="_Toc506244024"></a><a name="_Toc427878341"></a><a name="_Toc414335018"><span style='font-size:10.0pt'>checkvolumesettings</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Check if audio device is muted or volume settings are too low (and un-mute and/or increase volume if necessary).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: at first run</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: always</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369920"></a><a name="_Toc506244025"></a><a name="_Toc427878338"></a><a name="_Toc414335015"></a><a name="_Toc373962451"></a><a name="_Toc373958186"></a><a name="_Toc373366354"></a><a name="_Toc319361682"></a><a name="_Toc255049808"><span style='font-size:10.0pt'>volumein</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default microphone volume in percent from 0 to 100. 0 means muted. 100 means maximum volume, 0 is muted.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 50% (not changed)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The result volume level might be affected by the AGC if it is enabled.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Volume levels above 70% might result in distorted sound.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Usually it should not be changed as users should control the volume by OS level volume controls.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369921"></a><a name="_Toc506244026"></a><a name="_Toc427878339"></a><a name="_Toc414335016"></a><a name="_Toc373962452"></a><a name="_Toc373958187"></a><a name="_Toc373366355"></a><a name="_Toc319361683"></a><a name="_Toc255049809"><span style='font-size:10.0pt'>volumeout</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default speaker volume in percent from 0 to 100. 0 means muted. 100 means maximum volume, 0 is muted.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 50% (not changed)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The result volume level might be affected by the AGC if it is enabled.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Volume levels above 70% might result in distorted sound.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Usually it should not be changed as users should control the volume by OS level volume controls.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369922"></a><a name="_Toc506244027"></a><a name="_Toc427878340"></a><a name="_Toc414335017"></a><a name="_Toc373962453"></a><a name="_Toc373958188"></a><a name="_Toc373366356"><span style='font-size:10.0pt'>volumering</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default ringback volume in percent from 0 to 100. 0 means muted. 100 means maximum volume, 0 is muted.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 50% (not changed)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: Usually it should not be changed as users should control the ringer by OS level volume controls.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369923"></a><a name="_Toc506244028"></a><a name="_Toc427878342"></a><a name="_Toc414335019"></a><a name="_Toc373962454"></a><a name="_Toc373958189"></a><a name="_Toc373366357"><span style='font-size:10.0pt'>beeponconnect</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will play a short sound when calls are connected</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=Disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=For auto accepted incoming calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=For incoming calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=For outgoing calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4=For all calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node44" id="node44"></a><span style='font-size:10.0pt'>playdtmfsound</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>DTMF sounds on key press.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=No</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=Yes for one digit</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=Yes also if multiple digits</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369924"></a><a name="_Toc506244029"></a><a name="_Toc427878343"></a><a name="_Toc414335020"></a><a name="_Toc373962455"></a><a name="_Toc373958190"></a><a name="_Toc373366358"></a><a name="_Toc319361684"><span style='font-size:10.0pt'>agc</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Automatic gain control. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=Disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=For recording only</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=Both for playback and recording</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=Guess</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 3</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>This will also change the effect of the volumein and volumeout settings.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369926"></a><a name="_Toc506244031"></a><a name="_Toc427878345"></a><a name="_Toc414335022"></a><a name="_Toc373962457"></a><a name="_Toc373958192"></a><a name="_Toc373366360"></a><a name="_Toc319361686"><span style='font-size:10.0pt'>plc</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Enable/disable packet loss concealment</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is true (enabled)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369927"></a><a name="_Toc506244032"></a><a name="_Toc427878346"></a><a name="_Toc414335023"></a><a name="_Toc373962458"></a><a name="_Toc373958193"></a><a name="_Toc373366361"></a><a name="_vad"></a><span style='font-size:10.0pt'>vad</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Enable/disable voice activity detection.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: yes for player (will help the jitter)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: yes for recorder</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: yes for both</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Notes: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-The vad parameter is automatically set to 4 by default if the aec2 algorithm is used.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-If you wish to use VAD related statistics in your application, you might have to also set the “vadstat” parameter after your needs. Possible values: 0=no,1=auto (default),2=detect no mic audio,3=send statistics. See the VAD notification and VAD for more details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-If you want to disable audio related notifications (microphone warning on no signal detected) then set the “enablenomicvoicewarning” parameter to 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_rtpstat"></a><span style='font-size:10.0pt'>rtpstat</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Enable/disable RTP statistics by triggering </span><a href="start.htm#_RTPSTAT,quality,sent,rec,issues,los"><span style='font-style:normal'>RTPSTAT</span></a><span style='font-style:normal'> notifications.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1: auto (will trigger RTPSTAT events in every 6-7 seconds and more frequently at the beginning of the calls)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Positive value: seconds to generate RTPSTAT events.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 0 (disabled)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>More details </span><a href="start.htm#_Media_statistics"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 0in;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in;border:none;padding:0in'><a name="_Toc506369928"></a><a name="_Toc506244033"></a><a name="_Toc427878347"></a><a name="_Toc414335024"></a><a name="_Toc373962459"></a><a name="_Toc373958194"></a><a name="_Toc373366362"></a><a name="_Toc319361687"></a><a name="_aec"></a><span style='font-size:10.0pt'>aec</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Enable/disable acoustic echo cancellation</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=yes except if headset usage guessed</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=yes if supported</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=forced yes even if not supported (might result in unexpected errors)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The aec decision might be overwritten or modified by the aectype parameter.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>After tests, the success rate of the built-on AEC algorithms is above 90%. This is considered a good value as there are no any perfect aec algorithms, but it might not work (or partially work) in some devices or circumstances (depends on many factors such as audio hardware, driver, OS/device, environment/room, codec, network delay).</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For more details, read <a href="start.htm#_The_remote_party">here</a>.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 0in;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in;border:none;padding:0in'><a name="_Toc506369929"></a><a name="_Toc506244034"></a><a name="_Toc427878348"></a><a name="_Toc414335025"></a><a name="_Toc373962460"></a><a name="_Toc373958195"></a><a name="_Toc373366363"></a><a name="_aectype"></a><span style='font-size:10.0pt'>aec</span><span style='font-size:10.0pt'>type</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>AEC algorithm(s) to use. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>One or more of the following strings separated by comma:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>auto: will select automatically based on circumstances (CPU power, device capabilities, network)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>none: disable aec</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>software: software aec (requires extra CPU processing)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>hardware: android hardware aec capabilities (not supported on all phones)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>fast: a fast software aec implementation (used preferably on slow/old devices or in addition for the above algorithms)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>volume: this will just decrease the volume when speech detected from other end (using VAD)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is auto.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note:</p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span>It is recommended to leave both the aec and aectype values with its default values</p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span>To force all echo cancellations algorithms you might set the aec to “2” and the aectype to “software,hardware,fast,volume” (this might be too much, forcing the software to do unnecessary processing and in some circumstances it might remove too much audio)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For more details, read <a href="start.htm#_The_remote_party">here</a>.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369930"></a><a name="_Toc506244035"></a><a name="_Toc427878349"></a><a name="_Toc414335026"></a><a name="_Toc373962461"></a><a name="_Toc373958196"></a><a name="_Toc373366364"></a><a name="_Toc319361688"></a><a name="_denoise"></a><span style='font-size:10.0pt'>denoise</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Noise suppression.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=Disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=For recording only</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=Both for playback and recording</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=Auto guess</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 3</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369931"></a><a name="_Toc506244036"></a><a name="_Toc427878350"></a><a name="_Toc414335027"></a><a name="_Toc373962462"></a><a name="_Toc373958197"></a><a name="_Toc373366365"></a><a name="_Toc319361689"><span style='font-size:10.0pt'>silencesupress</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Enable/disable silence suppression</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Usually not recommended unless your bandwidth is really bad and expensive.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1=auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no (disabled)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is -1 (which means no, except mobile devices with low bandwidth)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 0in;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in;border:none;padding:0in'><a name="_Toc506369932"></a><a name="_Toc506244037"><span style='font-size:10.0pt'>hardwaremedia</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Enable the usage of OS/hardware level audio processing for aec/denoise/silence suppress.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: even if this is set to 2, the media stack might not use the android hardware capabilities if you disable aec/denoise/silencesupress by their respective parameters</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369933"></a><a name="_Toc506244038"></a><a name="_Toc427878351"></a><a name="_Toc414335028"></a><a name="_Toc373962463"></a><a name="_Toc373958198"></a><a name="_Toc373366366"></a><a name="_Toc319361690"><span style='font-size:10.0pt'>rtcp</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Enable/disable rtcp. (RFC 3550. Partial support)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_codec"></a><span style='font-size:10.0pt'>codec</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>List of allowed audio codec’s separated by comma.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Will accept one or more of the following strings (upper or lower case doesn’t matter): <br> </span><span style='font-style:normal'>pcmu, pcma, g711 (for both PCMU and PCMA), g719, gsm, ilbc, speex, speexwb, speexuwb, opus, opuswb, opusuwb, opusswb, def</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>By default the Android SIP library will automatically choose the best codec depending on available codec’s, circumstances (network/device) and peer capabilities.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set this parameter only if you have some special requirements such as forcing a specific codec, regardless of the circumstances.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default: empty (which means auto detection and negotiation)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Recommended value: leave it empty for “best” codec negotiation unless if you have some specific requirement.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Example: <span style='color:#984806'>OpusWB,G.729,PCMU</span> (This will disable Speex, GSM, iLBC, GSM and PCMA).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can also set one single codec (if your server/peers allows only one codec or for testing to rule out all kind of codec negotiation related issues).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can set to “<span style='color:#984806'>def</span>” to enable all the default codec’s again.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Under normal circumstances, the following is the built-in codec priority:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.5in'><span style='font-size:9.0pt;line-height:120%'><span style='font:7.0pt "Times New Roman"'> </span>I.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>Wideband Speex and Opus (These are set with top priority as they have the best quality. Likely used for VoIP to VoIP calls if the peer also has support for wideband)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.5in'><span style='font-size:9.0pt;line-height:120%'><span style='font:7.0pt "Times New Roman"'> </span>II.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>G.729 (Usually the preferred codec for VoIP trunks used for mobile/landline calls because it’s excellent compression/quality ratio for narrowband)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.5in'><span style='font-size:9.0pt;line-height:120%'><span style='font:7.0pt "Times New Roman"'> </span>III.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>iLBC, GSM (If G.729 is not supported then these are good alternatives. iLBC has better characteristics and GSM is better supported by legacy hardware)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.5in'><span style='font-size:9.0pt;line-height:120%'><span style='font:7.0pt "Times New Roman"'> </span>IV.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>G.711: PCMU and PCMA (Requires more bandwidth, but has the best narrowband quality)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>The default codec order will highly depends on the device CPU power (high-complexity codec’s are deprioritized on low-end devices) and network type (high bandwidth codec’s are deprioritized on slow networks such as GPRS, 2G or slow 3G). On a decent device with good internet connection (WiFi, LTE, 5G, 4G or good 3G) the softphone should pick up the Opus wideband if peer has support for this codec. If peer has support only for narrowband then G.729 should be selected, otherwise another codec negotiated with the peer endpoint.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>More details </span><a href="start.htm#_What_is_the"><span style='font-size:9.0pt;line-height:120%'>here</span></a><span style='font-size:9.0pt;line-height:120%'>.</span><span style='line-height:120%; font-style:normal'><br> <br> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: for the codec configuration, either use the codec/prefcodec settings OR the use_xxx settings (where xxx is the codec name; listed below). <br> You can achieve similar result with both. The use_xxx settings are a little bit more flexible regarding the codec prioritization.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_prefcodec"></a><span style='font-size: 10.0pt'>prefcodec</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set your preferred audio codec. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Will accept one the following strings (upper or lower case doesn’t matter): <br> </span><span style='font-style:normal'>pcmu, pcma, g711 (for both PCMU and PCMA), g719, gsm, ilbc, speex, speexwb, speexuwb, opus, opuswb, opusuwb, opusswb</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty which means the built-in optimal </span><a href="http://www.mizu-voip.com/Support/Blog/tabid/100/EntryID/7/Default.aspx"><span style='line-height:120%;font-style:normal'>prioritization</span></a><span style='line-height:120%;font-style:normal'>. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:120%;font-style:normal'>By default the SIP stack will present the codec list optimized regarding the circumstances (the combination of the followings):</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:8.0pt;line-height:120%;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:8.0pt;line-height:120%;font-style:normal'>available client codec set (not all engines supports all codecs)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:8.0pt;line-height:120%; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:8.0pt;line-height:120%;font-style:normal'>server codec list (depending on your server, peer device or carrier)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:8.0pt;line-height:120%; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:8.0pt;line-height:120%;font-style:normal'>internal/external call: for IP to IP calls will prioritize wideband codecs if possible, while for outbound calls usually G.729 will be selected if available</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:8.0pt;line-height:120%; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:8.0pt;line-height:120%;font-style:normal'>network quality (bandwidth, delay, packet-loss, jitter): for example iLBC is more tolerant to network problems if supported</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:8.0pt;line-height:120%;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:8.0pt;line-height:120%;font-style:normal'>device CPU: some old mobile devices might not be able to handle high-complexity codec’s such as opus or G.729. G711 and GSM has low computational costs</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:120%;font-style:normal'>You can also fine-tune the codec settings with the use_xxx settings described below.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_vcodec"></a><span style='font-size:10.0pt'>vcodec</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>List of allowed video codec’s separated by comma</span><span lang="HU" style='line-height:120%;font-style:normal'> (H264, VP8, VP9</span><span style='line-height:120%;font-style:normal'>).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You might use this parameter to exclude some codec from the offer list. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>For example if you wish to use only H.364, then set this to: </span><span style='font-size:11.0pt;line-height:120%'> “</span><span style='line-height:120%;color:#984806;font-style:normal'>H264</span><span style='line-height:120%;font-style:normal'>”</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default: empty (which means auto detection and negotiation)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node45" id="node45"></a><span style='font-size:10.0pt'>video_bandwidth</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Max bandwidth for video in kbits.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>It will be sent also with SDP “b:AS” attribute.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 0 which means auto negotiated via RTCP and congestion control.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node46" id="node46"></a><span style='font-size:10.0pt'>video size parameters</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can suggest the size of the video (in pixels) with the following parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>video_width</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>video_height</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>video_min_width</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>video_min_height</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>video_max_width</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>video_max_height</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369934"></a><a name="_Toc506244039"></a><a name="_Toc427878352"></a><a name="_Toc414335029"></a><a name="_Toc373962464"></a><a name="_Toc373958199"></a><a name="_Toc373366367"></a><a name="_Toc319361691"></a><a name="_Toc255049811"><span style='font-size:10.0pt'>use_gsm</span></a><span style='font-size:10.0pt'> </span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>GSM codec setting. 0=never,1=don’t offer,2=yes with low priority,3=yes with high priority</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b> </b></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369935"></a><a name="_Toc506244040"></a><a name="_Toc427878353"></a><a name="_Toc414335030"></a><a name="_Toc373962465"></a><a name="_Toc373958200"></a><a name="_Toc373366368"></a><a name="_Toc319361692"><span style='font-size:10.0pt'>use_ilbc</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>iLBC codec setting. 0=never,1=don’t offer,2=yes with low priority,3=yes with high priority</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b> </b></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369936"></a><a name="_Toc506244041"></a><a name="_Toc427878354"></a><a name="_Toc414335031"></a><a name="_Toc373962466"></a><a name="_Toc373958201"></a><a name="_Toc373366369"></a><a name="_Toc319361693"></a><a name="_Toc255049812"><span style='font-size:10.0pt'>use_speex</span></a><span style='font-size:10.0pt'> </span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Narrowband speex codec setting. 0=never,1=don’t offer,2=yes with low priority,3=yes with high priority</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1</span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369937"></a><a name="_Toc506244042"></a><a name="_Toc427878355"></a><a name="_Toc414335032"></a><a name="_Toc373962467"></a><a name="_Toc373958202"></a><a name="_Toc373366370"></a><a name="_Toc319361694"></a><a name="_Toc255049813"><span style='font-size:10.0pt'>use_speexwb</span></a><span style='font-size:10.0pt'> </span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Wideband speex codec setting. 0=never,1=don’t offer,2=yes with low priority,3=yes with high priority</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369938"></a><a name="_Toc506244043"></a><a name="_Toc427878356"></a><a name="_Toc414335033"></a><a name="_Toc373962468"></a><a name="_Toc373958203"></a><a name="_Toc373366371"></a><a name="_Toc319361695"></a><a name="_Toc255049814"><span style='font-size:10.0pt'>use_speexuwb</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Ultra wideband speex codec setting. 0=never,1=don’t offer,2=yes with low priority,3=yes with high priority</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369939"></a><a name="_Toc506244044"></a><a name="_Toc427878357"></a><a name="_Toc414335034"></a><a name="_Toc373962469"></a><a name="_Toc373958204"></a><a name="_Toc373366372"><span style='font-size:10.0pt'>use_opus</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Narrowband (8000 Hz) opus codec setting. 0=never,1=don’t offer,2=yes with low priority,3=yes with high priority</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369940"></a><a name="_Toc506244045"></a><a name="_Toc427878358"></a><a name="_Toc414335035"></a><a name="_Toc373962470"></a><a name="_Toc373958205"></a><a name="_Toc373366373"><span style='font-size:10.0pt'>use_opuswb</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Wideband (16000 Hz) opus codec setting. 0=never,1=don’t offer,2=yes with low priority,3=yes with high priority</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369941"></a><a name="_Toc506244046"></a><a name="_Toc427878359"></a><a name="_Toc414335036"></a><a name="_Toc373962471"></a><a name="_Toc373958206"></a><a name="_Toc373366374"><span style='font-size:10.0pt'>use_opusswb</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Super wideband (24000 Hz) opus codec setting. 0=never,1=don’t offer,2=yes with low priority,3=yes with high priority</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: this codec might not work on all devices, depending on the audio device and driver capabilities!</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369942"></a><a name="_Toc506244047"></a><a name="_Toc427878360"></a><a name="_Toc414335037"></a><a name="_Toc373962472"></a><a name="_Toc373958207"></a><a name="_Toc373366375"><span style='font-size:10.0pt'>use_opusuwb</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Ultra wideband (fullband at 48000 Hz) opus codec setting. 0=never,1=don’t offer,2=yes with low priority,3=yes with high priority</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369944"></a><a name="_Toc506244049"></a><a name="_Toc427878363"></a><a name="_Toc414335040"></a><a name="_Toc373962475"></a><a name="_Toc373958210"></a><a name="_Toc373366378"></a><a name="_Toc319361698"></a><a name="_Toc255049815"><span style='font-size:10.0pt'>use_g729</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>G.729 codec setting. 0=never,1=don’t offer,2=yes with low priority,3=yes with high priority</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>*</span>In some countries a license/patent is required if you use G.729 so enable only if you have licenses or licenses are not required in your case (consult your lawyer if you are not sure)<br> <br> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369945"></a><a name="_Toc506244050"></a><a name="_Toc427878364"></a><a name="_Toc414335041"></a><a name="_Toc373962476"></a><a name="_Toc373958211"></a><a name="_Toc373366379"></a><a name="_Toc319361699"></a><a name="_Toc255049816"><span style='font-size:10.0pt'>use_pcma</span></a><span style='font-size:10.0pt'> </span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>G711alaw codec. 0=never,1=don’t offer,2=yes with low priority,3=yes with high priority</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369946"></a><a name="_Toc506244051"></a><a name="_Toc427878365"></a><a name="_Toc414335042"></a><a name="_Toc373962477"></a><a name="_Toc373958212"></a><a name="_Toc373366380"></a><a name="_Toc319361700"></a><a name="_Toc255049817"><span style='font-size:10.0pt'>use_pcmu</span></a><span style='font-size:10.0pt'> </span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>G711ulaw codec. 0=never, 1=don’t offer, 2=yes with low priority, 3=yes with high priority</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369943"></a><a name="_Toc506244048"></a><a name="_Toc427878362"></a><a name="_Toc414335039"></a><a name="_Toc373962474"></a><a name="_Toc373958209"></a><a name="_Toc373366377"></a><a name="_Toc319361697"><span style='font-size:10.0pt'>disablewbforpstn</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This setting will disable speex and opus wideband and ultrawideband for outgoing calls to regular phone numbers since these are usually not supported for pstn calls and they might requires longer initialization.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: check at first call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: check all calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 0. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369882"></a><a name="_Toc506243987"></a><a name="_Toc427878311"></a><a name="_Toc414334986"></a><a name="_Toc373962425"></a><a name="_Toc373958160"></a><a name="_Toc373366328"></a><a name="_Toc319361665">setfinalcodec</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Some server cannot handle the final codec offer in the ACK message correctly.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>In this case you will have to set this setting to 0, otherwise you will have one way audio.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=never (RFC compliant)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=auto guess (not send in case of certain servers and autocorrect in subsequent calls)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=when multiple codecs are received</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=always reply with the final codec in the ACK message </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 1. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_ims3gpp"></a>ims3gpp</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Enable </span><a href="https://tools.ietf.org/html/rfc4083"><span style='font-style:normal'>3GPP</span></a><span style='font-style:normal'> (</span><a href="https://en.wikipedia.org/wiki/IP_Multimedia_Subsystem"><span style='font-style:normal'>IMS</span></a><span style='font-style:normal'>/5G/VoLTE) features.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:<br> -1: auto detect (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: disable</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: basic</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: full/all</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>It is also possible to enable only certain </span><a href="https://www.sharetechnote.com/"><span style='font-style: normal'>3GPP features</span></a><span style='font-style:normal'>. In this case use the following parameters instead of <span style='color:#984806'>ims3gpp</span>:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>ims3gpp_phonenum</span><span style='font-style:normal'>: use tel URI and set user=phone (-1: auto, 0: no, 1: user=phone, 2: also tel uri). Note: you might also use the <span style='color:#984806'>sipproto </span>param.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>ims3gpp_minphonelen</span><span style='font-style:normal'>: tel uri only if phone number is longer then this. Default is 4. Set to 0 to use tel also for non-phone number peers</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>ims3gpp_authuname</span><span style='font-style:normal'>: auth username must contain the domain (-1: auto, 0: no. 1: yes)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>ims3gpp_ussd</span><span style='font-style:normal'>: IMS </span><a href="start.htm#_How_to_USSD"><span style='font-style:normal'>USSD</span></a><span style='font-style:normal'> described at </span><a href="https://www.etsi.org/deliver/etsi_ts/124300_124399/124390/12.01.00_60/ts_124390v120100p.pdf"><span style='font-style:normal'>3GPP TS 24.390</span></a><span style='font-style: normal'>. Send with </span><a href="start.htm#_Boolean_SendUSSD(int_line,"><span style='font-style:normal'>SendUSSD</span></a><span style='font-style:normal'>, receive as </span><a href="start.htm#_USSD,line,status,text"><span style='font-style: normal'>USSD</span></a><span style='font-style:normal'> notifications (-1: auto, 0: no, 1: yes)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>ims3gpp_sms</span><span style='font-style:normal'>: </span><a href="https://www.etsi.org/deliver/etsi_ts/124300_124399/124341/09.01.00_60/ts_124341v090100p.pdf"><span style='font-style:normal'>+g.3gpp.smsip</span></a><span style='font-style:normal'> with MESSAGE using binary encoded </span><a href="http://betelco.blogspot.com/2009/10/sms-over-3gpp-ims-network.html"><span style='font-style:normal'>PDU</span></a><span style='font-style:normal'>’s described in </span><a href="https://portal.3gpp.org/desktopmodules/Specifications/SpecificationDetails.aspx?specificationId=1017"><span style='font-style:normal'>3GPP TS 24.011</span></a><span style='font-style: normal'> (-1: auto, 0: no, 1: yes)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>ims3gpp_smsc</span><span style='font-style:normal'>: SMSC Center Address number. Otherwise AJVoIP will use the destination number (if that is a phone number)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node47" id="node47"></a>enable_3pcc</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify if to enable 3PCC Third Party Call Control as described at </span><a href="https://tools.ietf.org/html/rfc3725"><span style='font-style:normal'>RFC 3725</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: 3PCC has nothing to do with 3GPP. They are completely different technologies.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This feature is often used in callcenters or for click-to-call to setup calls between two or more other parties.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:<br> 0: disable (block 3PCC requests)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: don't handle</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: accept (handle incoming requests)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: initiate 3PCC calls by sending with no SDP</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: initiate 3PCC calls by sending SDP with connect IP set 0.0.0.0 </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5: initiate 3PCC calls by sending SDP with no media line</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If 3pcc is enabled, then AJVoIP will send the codec answer in ACK if not received by INVITE or it will re-INVITE if received SDP with no media line or with 0.0.0.0 contact IP, thus allowing all the possible third party call controls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Some more related information can be found </span><a href="https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.152.1610&rep=rep1&type=pdf"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>, </span><a href="https://docs.genesys.com/Documentation/SESN/latest/Overview/AnswerCallFunctionality"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>, </span><a href="https://docs.genesys.com/Documentation/SIPS/8.1.1/IntegrationReferenceManual/CUCMOverview"><span style='font-style:normal'>here</span></a><span style='font-style:normal'> and </span><a href="https://www.dialogic.com/webhelp/IMG1010/10.5.3/WebHelp/description/sip/sip_3pcc_call_flows.htm"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You might also set the <span style='color:#984806'>autoaccept </span>parameter to <span style='color:#984806'>true</span> if AJVoIP acts as an auto-responder.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node48" id="node48"></a>ed137</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Enable/disable the ED-137 behavior to be used for air traffic management services. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to 0 to ignore the ED-137 specification (act as normally)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to 1 to turn on the ED-137. This will change a list of internal settings and behaviors to conform with the ED-137 specification.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 0.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>See the </span><a href="https://www.mizu-voip.com/Portals/0/Files/jvoip_ED_137.pdf"><span style='font-style:normal'>ED-137 guide</span></a><span style='font-style:normal'> for more details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369947"></a><a name="_Toc506244052"></a><a name="_Toc427878366"></a><a name="_Toc414335043"></a><a name="_Toc373962478"></a><a name="_Toc373958213"></a><a name="_Toc373366381"><span style='font-size:10.0pt'>alwaysallowlowcodec</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to 2 to always put low computational and low bandwidth codec in the offer list, specifically GSM and PCMU. Low CPU or bandwidth devices might choose these codecs (such as a mobile phone on 3G).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to 0 to disable.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1 (auto)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369948"></a><a name="_Toc506244053"></a><a name="_Toc427878367"></a><a name="_Toc414335044"></a><a name="_Toc373962479"></a><a name="_Toc373958214"></a><a name="_Toc373366382"></a><a name="_Toc319361701"><span style='font-size:10.0pt'>codecframecount</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Number of payloads in one UDP packet.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>By default it is set to 0 which means 2 frames for G729 and 1 frame for all other codec.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369949"></a><a name="_Toc506244054"></a><a name="_Toc427878368"></a><a name="_Toc414335045"></a><a name="_Toc373962480"></a><a name="_Toc373958215"></a><a name="_Toc373366383"></a><a name="_Toc319361702"><span style='font-size:10.0pt'>udptos</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Sets traffic class or type-of-service octet in the IP header for packets sent from UDP socket which can be used to fine-tune the QoS in your network. As the underlying network implementation may ignore this value applications should consider it a hint.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The value must be between 0 and 255.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Valid values:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings; font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>0: disabled</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings; font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>1: automatic (set to 10 under normal conditions and disabled when in tunneling)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings; font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>2: low-cost routing</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings; font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>4: reliable routing</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings; font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>8: throughput optimized routing</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings; font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>10: low-delay routing</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings; font-style:normal'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>or’ing the above values (from above 2)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Notes:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>for Internet Protocol v4 the value consists of an number with precedence and TOS fields as detailed in RFC 1349. The TOS field is bitset created by bitwise-or'ing values such the following :</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> IPTOS_LOWCOST: 2</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> IPTOS_RELIABILITY: 4</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> IPTOS_THROUGHPUT: 8</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> IPTOS_LOWDELAY: 16</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>The last low order bit is always ignored as this corresponds to the MBZ (must be zero) bit.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>For Internet Protocol v6 tc is the value that would be placed into the sin6_flowinfo field of the IP header.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>This parameter might work only in preset environments; the runtime might not have enough rights to modify the IP headers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369950"></a><a name="_Toc506244055"></a><a name="_Toc427878369"></a><a name="_Toc414335046"></a><a name="_Toc373962481"></a><a name="_Toc373958216"></a><a name="_Toc373366384"></a><a name="_Toc319361703"></a><a name="_Toc255049818"><span style='font-size:10.0pt'>automute</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify if other lines will be muted on new call<br> 0=no (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=on incoming call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=on outgoing call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=on incoming and outgoing calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4=on other line button click</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369951"></a><a name="_Toc506244056"></a><a name="_Toc427878370"></a><a name="_Toc414335047"></a><a name="_Toc373962482"></a><a name="_Toc373958217"></a><a name="_Toc373366385"></a><a name="_Toc319361704"></a><a name="_Toc255049819"><span style='font-size:10.0pt'>autohold</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify if other lines will be put on hold on new call<br> 0=no (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=on incoming call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=on outgoing call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=on incoming and outgoing calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4=on other line button click</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369952"></a><a name="_Toc506244057"></a><a name="_Toc427878371"></a><a name="_Toc414335048"></a><a name="_Toc373962483"></a><a name="_Toc373958218"></a><a name="_Toc373366386"><span style='font-size:9.0pt'>holdontransfer</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify if line should disconnect after transfer</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1=auto<br> 0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1= yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2= hold and reload if needed</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is -1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369953"></a><a name="_Toc506244058"></a><a name="_Toc427878372"></a><a name="_Toc414335049"><span style='font-size:9.0pt'>holdtypeonhold</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify call hold type. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Call hold is usually initiated by the </span><a href="start.htm#_boolean_Hold(int_line,"><span style='font-style:normal'>Hold</span></a><span style='font-style:normal'> function and with parameter you can specify which type of call hold do you wish to request.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-2: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1: auto (defaults to 2)<br> 0: no (don’t hold. a=sendrecv)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: reserved (not used)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: hold: instructs the peer to not send audio (mute speaker. Local AJVoIP: a=sendonly, peer: a=recvonly)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: hold: not sending audio to the other (mute microphone. Local AJVoIP: a=recvonly, peer: a=sendonly)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: hold: both (mute both in/out audio. a=inactive)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is -1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>By default the hold will check the previous state. For example if previously it was local hold (2) and you switch to remote hold (3) then actually will switch o both hold. <br> There is also a <span style='color:#632423'>holdexplicite </span>parameter which if set to <span style='color:#632423'>1</span>, then the hold will be done strictly after the holdtypeonhold parameter, without considering previous state. This way you can also change between local and remote hold without the need to unhold first.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node49" id="node49"></a><span style='font-size:9.0pt'>muteonhold</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify if call also have to be muted with hold (stop recording/playback and stop the according RTP stream).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-2: no mute, </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: mute in and out </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: mute out (speakers) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: mute in (microphone) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: mute in and out (same as 0) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: mute default </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5: according to call hold.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 5.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Usually you should set this either to -2 or 5.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node50" id="node50"></a><span style='font-size:9.0pt'>musiconhold</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify if to play music on hold (MOH). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1: auto (defaults to 0/disabled)<br> 0: no/disabled </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: yes on hold with a=sendonly request initiated locally</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: yes on hold with a=recvonly received from the peer</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is -1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note:</p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span>Option 1 (hold with <span style='font-style:normal'>a=sendonly</span> initiated locally) is the recommended value if you wish to enable music on hold</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span>For MOH to work, you must have a “music.wav” resource file. You might use <a href="https://www.mizu-voip.com/Portals/0/Files/music.wav">this file</a>.</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span>MOH might be played only if the holdtype is -1 (auto) or 2 (sendonly). </p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span>MOH might be handled on the SIP server side instead. </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369954"></a><a name="_Toc506244059"></a><a name="_Toc427878373"></a><a name="_Toc414335050"></a><a name="_Toc373962484"></a><a name="_Toc373958219"></a><a name="_Toc373366387"><span style='font-size:9.0pt'>defmute</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default mute direction</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: both</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: mute out (speakers)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: mute in (microphone)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: both</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: both</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5: disable mute</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369955"></a><a name="_Toc506244060"></a><a name="_Toc427878374"></a><a name="_Toc414335051"></a><a name="_Toc373962485"></a><a name="_Toc373958220"></a><a name="_Toc373366388"></a><a name="_Toc319361705"><span style='font-size:10.0pt'>ackforauthrequest</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If to send ACK for authentication requests (401,407).<br> 0=no </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=yes (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Should be changed only if you have compatibility issues with the server used.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369956"></a><a name="_Toc506244061"></a><a name="_Toc427878375"></a><a name="_Toc414335052"></a><a name="_Toc373962486"></a><a name="_Toc373958221"></a><a name="_Toc373366389"></a><a name="_Toc319361706"></a><a name="_Toc255049821"><span style='font-size:10.0pt'>favorizecontactaddr</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You may change it if you have compatibility issues with stateless proxies<br> 0=never</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2= conform RFC </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3= yes. Sending for both server and contact URI (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4=always</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369957"></a><a name="_Toc506244062"></a><a name="_Toc427878376"></a><a name="_Toc414335053"></a><a name="_Toc373962487"></a><a name="_Toc373958222"></a><a name="_Toc373366390"></a><a name="_Toc319361707"><span style='font-size:10.0pt'>prack</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Enable 100rel (PRACK)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to false if you have incompatibility issues.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369958"></a><a name="_Toc506244063"></a><a name="_Toc427878377"></a><a name="_Toc414335054"></a><a name="_Toc373962488"></a><a name="_Toc373958223"></a><a name="_Toc373366391"></a><a name="_Toc319361708"><span style='font-size:10.0pt'>sendmac</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will send the client MAC address with all signaling message in the X-MAC header parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: The SDK might not have enough rights to read the MAC address.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc42017048"><span style='font-size:10.0pt'>useragent</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> (string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This will overwrite the default User-Agent setting.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Do not set this when used with mizu VoIP servers because the server detects extra capabilities by reading this header.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node51" id="node51"></a><span style='font-size:10.0pt'>sendsessionid</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> (int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify if to send the Session-ID header as specified in RFC 7989.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-1: if received (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: no (disable)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: yes (enable)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is -1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc427878378"></a><a name="_Toc414335055"></a><a name="_Toc373962489"></a><a name="_Toc373958224"></a><a name="_Toc373366392"></a><a name="_Toc319361709"></a><a name="_Toc506369959"></a><a name="_Toc506244064"></a><a name="_customsipheader"></a><span style='font-size:10.0pt'>customsipheader</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set a custom sip header (a line in the SIP signaling) that will be sent with all messages. Can be used for various integration purposes (for example for sending the http session id). You can also change this parameter runtime with the SetSIPHeader function.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <p class="MsoNormalCxSpMiddle" style='margin-top:10.0pt;margin-right:0in; margin-bottom:5.0pt;margin-left:0in;line-height:normal;border:none;padding: 0in'><b><span style='font-family:"Cambria",serif;color:#943634'>customsdpmediafield</span></b></p> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set a custom media SDP field (a line in the SDP body after the m= line) that will be sent with all messages. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>It can be set also at runtime with the </span><a href="start.htm#_Miscellaneous"><span style='font-style:normal'>SetSDPField</span></a><span style='font-style:normal'> function.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is empty. Multiple lines can be separated by semicolon (;).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <p class="MsoNormalCxSpMiddle" style='margin-top:10.0pt;margin-right:0in; margin-bottom:5.0pt;margin-left:0in;line-height:normal;border:none;padding: 0in'><a name="_rtpextraheader"></a><b><span style='font-family:"Cambria",serif; color:#943634'>rtpextraheader</span></b></p> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set </span><a href="https://datatracker.ietf.org/doc/html/rfc3550#section-5.3.1"><span style='font-style:normal'>RTP extra header</span></a><span style='font-style: normal'> bytes.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The string will be converted to RTP extra header word(s).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If only one extra word needs to be set, then pass it as an integer (integer value converted to string).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Multiple words can be set by separating them with semicolon (;) .Example: 98;76543 will set the first word to 98 and the second word to 76543.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>It can be set also at runtime with the </span><a href="start.htm#_Miscellaneous"><span style='font-style:normal'>RTPHeaderExtension</span></a><span style='font-style:normal'> function “extension” parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>See the </span><a href="start.htm#node79"><span style='font-style:normal'>RTP header extension</span></a><span style='font-style:normal'> FAQ point for more details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <p class="MsoNormalCxSpMiddle" style='margin-top:10.0pt;margin-right:0in; margin-bottom:5.0pt;margin-left:0in;line-height:normal;border:none;padding: 0in'><a name="_rtpextraheader_profile"></a><b><span style='font-family:"Cambria",serif; color:#943634'>rtpextraheader_profile</span></b></p> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set the profile number (the first two bytes) for the </span><a href="https://datatracker.ietf.org/doc/html/rfc3550#section-5.3.1"><span style='font-style:normal'>RTP extra header</span></a><span style='font-style: normal'> if required.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If not set then the profile bytes will be set to 0.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>It can be set also at runtime with the </span><a href="start.htm#_Miscellaneous"><span style='font-style:normal'>RTPHeaderExtension</span></a><span style='font-style:normal'> function “profile” parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>See the </span><a href="start.htm#node79"><span style='font-style:normal'>RTP header extension</span></a><span style='font-style:normal'> FAQ point for more details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_sip_uui"></a><span style='font-size:10.0pt'>sip_uui</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify UUI data (User-to-User Call Control Information as described in RFC 7433). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Can be used to send data to other endpoints. Not all endpoints and SIP servers supports this feature.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>If prefixed with *0: then the UUI will be sent only to peer with the User-to-User header.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>If prefixed with *1: then the UUI will be sent only to target party with call transfer or redirect escaped in Contact or Refer-To URI.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>If not prefixed or prefixed with *2: the UUI will be sent both way.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>It can be set also at runtime with the SetUUI function.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Simple example: <span style='color: #984806'>mydata</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>Example with parameters: </span><span style='color:#984806;font-style:normal'>*2:mydata;encoding=hex;purpose=foo;content=bar</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369960"></a><a name="_Toc506244065"></a><a name="_Toc427878379"></a><a name="_Toc414335056"></a><a name="_Toc373962490"></a><a name="_Toc373958225"></a><a name="_Toc373366393"></a><a name="_Toc319361710"></a><a name="_Toc255049823"><span style='font-size:10.0pt'>techprefix</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Add any prefix for the called numbers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node52" id="node52"></a><span style='font-size:10.0pt'>normalizenumber</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Normalize (called) numbers by removing .-,;()[]: and space if the string otherwise doesn't contains a-z or A-Z characters (looks like a phone number).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1: auto (usually defaults to 1 yes, except if self username also contains special characters)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is -1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node53" id="node53"></a><span style='font-size:10.0pt;font-style:normal'>honordatasaver</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Take in consideration Android OS Data Saver settings.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If 1, then it will change a few internal settings to use less data such as longer kee-palive and reregister interval, prioritizing codec’s which requires less bandwidth, auto enable silence suppression and more.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node54" id="node54"></a><span style='font-size:10.0pt;font-style:normal'>honordnd</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Take in consideration Android DND settings (Do Not Disturb).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node55" id="node55"></a><span style='font-size:10.0pt;font-style:normal'>honorairplan</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Take in consideration Android OS Airplane mode settings.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If 1, then it will not force network (and wifi) reconnect if no network.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369961"></a><a name="_Toc506244066"></a><a name="_Toc427878380"></a><a name="_Toc414335057"></a><a name="_Toc373962491"></a><a name="_Toc373958226"></a><a name="_Toc373366394"></a><a name="_Toc319361712"><span style='font-size:10.0pt;font-style:normal'>mustconnect</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If set to true, than users must register before to make any calls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369962"></a><a name="_Toc506244067"><span style='font-size:10.0pt;font-style:normal'>rejectonphonebusy</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to true to reject the incoming calls if there is already a native phone call in progress (GSM/mobile call).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: Reject calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: Allow calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: Forward calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For better accuracy, this feature requires “dangerous” READ_PHONE_STATE permission.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369963"></a><a name="_Toc506244068"></a><a name="_Toc427878381"></a><a name="_Toc414335058"></a><a name="_Toc373962492"></a><a name="_Toc373958227"></a><a name="_Toc373366395"></a><a name="_Toc319361711"><span style='font-size:10.0pt;font-style:normal'>rejectonbusy</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to true to reject the incoming calls if there is already a VoIP call in progress.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This feature might not be enabled by default as it requires dangerous READ_PHONE_STATE permission.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369964"></a><a name="_Toc506244069"></a><a name="_Toc427878382"></a><a name="_Toc414335059"></a><a name="_Toc373962493"></a><a name="_Toc373958228"></a><a name="_Toc373366396"></a><a name="_Toc319361672">callforwardonbusy</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(String)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify a number where calls should be forwarded when the user is already in a call. (Otherwise the new call alert will be displayed for the user or a message will be sent on the API)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369965"></a><a name="_Toc506244070"></a><a name="_Toc427878383"></a><a name="_Toc414335060"></a><a name="_Toc373962494"></a><a name="_Toc373958229"></a><a name="_Toc373366397">callforwardalways</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(String)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify a number where ALL calls should be forwarded. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369966"></a><a name="_Toc506244071"></a><a name="_Toc427878384"></a><a name="_Toc414335061"></a><a name="_Toc373962495"></a><a name="_Toc373958230"></a><a name="_Toc373366398">calltransferalways</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(String)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify a number where ALL calls should be transferred. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>This might be used if your softswitch doesn’t support call forward (302 answers).</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369967"></a><a name="_Toc506244072"></a><a name="_Toc427878385"></a><a name="_Toc414335062"></a><a name="_Toc373962496"></a><a name="_Toc373958231"></a><a name="_Toc373366399"><span style='font-size:10.0pt'>autoignore</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to ignore all incoming calls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=don’t ignore</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=silently ignore</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=reject</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 0.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369968"></a><a name="_Toc506244073"></a><a name="_Toc427878386"></a><a name="_Toc414335063"></a><a name="_Toc373962497"></a><a name="_Toc373958232"></a><a name="_Toc373366400"></a><a name="_Toc319361713"></a><a name="_autoaccept"></a><span style='font-size:10.0pt'>autoaccept</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to true to automatically accept all incoming calls (auto answer).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: Autoanswer can be also forced from the server by the “P-Auto-Answer: normal” SIP header.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369969"></a><a name="_Toc506244074"></a><a name="_Toc427878387"></a><a name="_Toc414335064"><span style='font-size:10.0pt'>blacklist</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Block incoming communication from these users. (users/numbers separated by comma).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node56" id="node56"></a><span style='font-size:10.0pt'>whitelist</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Allow incoming SIP requests only from these users (users/numbers separated by comma).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Be aware that your server might send requests on it’s own, such as OPTION requests. In this case the username used by the server should be also allowed, otherwise such requests will be ignored. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node57" id="node57"></a><span style='font-size:10.0pt'>blockmode</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify how to apply the blacklist and the whitelist. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: disable (black/white list will be applied only for presence and BLF)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: ignore messages at transport level</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: reject call sessions</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: both</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default: 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369970"></a><a name="_Toc506244075"></a><a name="_Toc427878388"></a><a name="_Toc414335065"><span style='font-size:10.0pt'>rejectcallto</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to ignore calls if target doesn’t match</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=accept all incoming calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=check if target user match</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=check rinstance</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=check rinstance strict</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4=check all strict</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 0.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369971"></a><a name="_Toc506244076"><span style='font-size:10.0pt'>hideautocall</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to 1 to suppress notifications (STATUS, CDR) from automatically handled calls (ignored, forwarded, rejected and similar).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=send status notifications also about auto handled calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=do not send status notifications from auto handled calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 0.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369972"></a><a name="_Toc506244077"></a><a name="_Toc427878389"></a><a name="_Toc414335066"></a><a name="_Toc373962498"></a><a name="_Toc373958233"></a><a name="_Toc373366401"></a><a name="_Toc319361714"><span style='font-size:10.0pt'>ringtimeout</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Maximum ring time allowed in millisecond.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 90000 (90 second)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369973"></a><a name="_Toc506244078"></a><a name="_Toc427878390"></a><a name="_Toc414335067"></a><a name="_Toc373962499"></a><a name="_Toc373958234"></a><a name="_Toc373366402"></a><a name="_Toc319361715"><span style='font-size:10.0pt'>calltimeout</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Maximum speech time allowed in millisecond.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 10800000 (3 hours)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369974"></a><a name="_Toc506244079"></a><a name="_Toc427878391"></a><a name="_Toc414335068"></a><a name="_Toc373962500"></a><a name="_Toc373958235"></a><a name="_Toc373366403"></a><a name="_startsipstack"></a><span style='font-size:10.0pt'>startsipstack</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Automatically start the sipstack after a specified time.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no (the sipstack will be started on the first register or call event)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=on startup if not tunneling or serveraddress/username/password are set (the sipstack will be started at app init)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=on startup always (the sipstack will be started at app init)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Other=seconds (the sipstack will be started after the specified seconds)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can set to 0 if there is less change that AJVoIP will be used once the users will open the webpage hosting AJVoIP.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can set to 1 or higher if there is a high probability that the user will use AJVoIP to make calls (this will shorten the setup time for the first call)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369975"></a><a name="_Toc506244080"></a><a name="_Toc427878392"></a><a name="_Toc414335069"></a><a name="_Toc373962501"></a><a name="_Toc373958236"></a><a name="_Toc373366404"></a><a name="_Toc319361716"></a><a name="_Toc255049822"><span style='font-size:10.0pt'>timer</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can slow down or speed up the SIP protocol timers with this setting. You may set it to 15 if you have a slow server or slow network.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 10.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369976"></a><a name="_Toc506244081"></a><a name="_Toc427878393"></a><a name="_Toc414335070"></a><a name="_Toc373962502"></a><a name="_Toc373958237"></a><a name="_Toc373366405"></a><a name="_Toc319361717"></a><a name="_Toc255049824"><span style='font-size:10.0pt'>timer2</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Same as “timer” but it affects idle, connect and ring timeout and maximum call durations.<br> Default value is 10.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369977"></a><a name="_Toc506244082"></a><a name="_Toc427878394"></a><a name="_Toc414335071"></a><a name="_Toc373962503"></a><a name="_Toc373958238"></a><a name="_Toc373366406"></a><a name="_Toc319361718"><span style='font-size:10.0pt'>mediatimeout</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>RTP timeout in seconds to protect again dead sessions.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Calls will be disconnected if no media packet is sent and received for this interval.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You might increase the value if you expect long call hold or one way audio periods.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to 0 to disable call cut off on no media.<br> Default value is 300 (5 minute)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369978"></a><a name="_Toc506244083"></a><a name="_Toc427878395"></a><a name="_Toc414335072"></a><a name="_Toc373962504"></a><a name="_Toc373958239"></a><a name="_Toc373366407"></a><a name="_Toc319361719"><span style='font-size:10.0pt'>mediatimeout_notify</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>RTP timeout in seconds for API notify.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>After this timeout a warning message is sent via notifications without any further action.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The following log will be generated: “WARNING,media timeout (notify)”<br> Default value is 0 (disabled)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369979"></a><a name="_Toc506244084"></a><a name="_Toc427878396"></a><a name="_Toc414335073"></a><a name="_Toc373962505"></a><a name="_Toc373958240"></a><a name="_Toc373366408"></a><a name="_Toc319361720">rtpkeepaliveival</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>RTP stream keep-alive packet send interval in milliseconds.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This is useful if your PBX has an RTP timeout setting to prevent disconnects when the java softphone is hold or muted.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 0. (You might set it to 25000 for example)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369980"></a><a name="_Toc506244085"></a><a name="_Toc427878397"></a><a name="_Toc414335074"></a><a name="_Toc373962506"></a><a name="_Toc373958241"></a><a name="_Toc373366409"></a><a name="_Toc319361721">sendrtponmuted</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Send rtp even if muted (zeroed packets)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to true only if your SIP server is malfunctioning when no RTP is received.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369981"></a><a name="_Toc506244086"></a><a name="_Toc427878398"></a><a name="_Toc414335075"></a><a name="_Toc373962507"></a><a name="_Toc373958242"></a><a name="_Toc373366410"></a><a name="_Toc319361722"><span style='font-size:10.0pt'>discmode</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For call disconnect compatibility improvements. Some VoIP devices might have bugs with CANCEL forking, so it is better to always send a BYE after the CANCEL message on call disconnect. In this case set the discmode parameter to 3.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: quick</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: conform the RFC</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: send BYE after CANCEL when needed</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: double: always repeat the CANCEL and the BYE messages</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 2.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369982"></a><a name="_Toc506244087"></a><a name="_Toc427878399"></a><a name="_Toc414335076"></a><a name="_Toc373962508"></a><a name="_Toc373958243"></a><a name="_Toc373366411"></a><a name="_Toc319361723"><span style='font-size:10.0pt'>waitforunregister</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Maximum time in milliseconds to wait for unregistration when the Unregister is called or the java sip stack is closed.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If set to 0 that an unregister message is sent (REGISTER with Expires set to 0) but AJVoIP is not waiting for the response, which means that it will not repeat the un-register in case if the UDP packet was lost.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 2000.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node58" id="node58"></a><span style='font-size:10.0pt'>detectlanpeers</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Auto detect other SIP endpoints on the same LAN (broadcast message) such as colleagues at the network place or family members behind the home wifi.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>When other user is found, a NEWUSER event notification is triggered.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: no (will disable also the listener so other endpoints will not be able to detect it)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: listen only (will be discoverable)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: yes find others</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_haschat"></a><span style='font-size:10.0pt'>textmessaging</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify text messaging mode (IM/chat/SMS/API)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-1: auto guess or ask (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: disable all</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: disable incoming messages and auto guess outgoing mode</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: disable message sending and auto guess incoming mode</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3: reserved (you might implement HTTP API based chat for this externally)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>4: reserved (you might implement native SMS for this externally)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>5: VoIP SMS</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>6: VoIP IM/chat (SIP MESSAGE)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set the </span><a href="start.htm#_ims3gpp"><span style='font-style:normal'>ims3gpp_sms</span></a><span style='color:black; font-style:normal'> parameter to 1 or 2 to use 3GPP binary encoded messages for SIP MESSAGE or to 0 to always disable.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Note: the old haschat and chatsms parameters are deprecated now but still supported</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_offlinechat"></a><span style='font-size: 10.0pt'>offlinechat</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will try to resend not delivered messages later (on next register and/or when any message received from peer). The offline message queuing will take care of filtering out duplicates and will try to resend the message multiple times on failure until max number of resend or timeout reached.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> (int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1=auto (usually yes, no for 3gpp sms)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no (disable offline chat)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=yes (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=force always</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is -1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369983"></a><a name="_Toc506244088"></a><a name="_Toc427878402"></a><a name="_Toc414335080"></a><a name="_Toc373962512"></a><a name="_Toc373958247"></a><a name="_Toc373366415"></a><a name="_Toc319361727"></a><a name="_Toc255049825"><span style='font-size:10.0pt'>encrypted</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify if the transport will be encrypted (both media and the signaling)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Compatible only with Mizu VoIP servers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Automatically turned on when using http tunneling.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For standard encryption you can use TLS/SRTP with the transport/mediaencryption parameters.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369984"></a><a name="_Toc506244089"></a><a name="_Toc427878403"></a><a name="_Toc414335081"></a><a name="_Toc373962513"></a><a name="_Toc373958248"></a><a name="_Toc373366416"></a><a name="_Toc319361728"></a><a name="_Toc255049826"><span style='font-size:10.0pt'>authtype</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Some IP-PBX doesn’t allow “web” or “proxy” authentication. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=normal</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=only proxy auth</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=only simple auth</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369985"></a><a name="_Toc506244090"></a><a name="_Toc427878406"></a><a name="_Toc414335084"></a><a name="_Toc373962516"></a><a name="_Toc373958251"></a><a name="_Toc373366419"></a><a name="_Toc319361731"></a><a name="_Toc255049829"><span style='font-size:10.0pt'>pwdencrypted</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify if you will supply encrypted passwords via parameters or via the Java API<br> 0=no (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=xor</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=des+base64</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=xor+base64 (this is the preferred method; easiest but still secure enough)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4= base64</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This method is deprecated from version 3.4. All parameters can be passed encrypted now by just prefixing them with the “encrypted__X__” string where X means the id of the encryption method used.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>From version 4.8 there is no need to specify this parameter anymore. Just prefix any parameter with encrypted_X as described </span><a href="https://www.mizu-voip.com/Portals/0/Files/WebPhoneParameterEncoding.pdf"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369986"></a><a name="_Toc506244091"></a><a name="_Toc427878407"></a><a name="_Toc414335085"></a><a name="_Toc373962517"></a><a name="_Toc373958252"></a><a name="_Toc373366420"></a><a name="_Toc319361732"></a><a name="_voicerecording"></a><span style='font-size:10.0pt'>voicerecording</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=local (in the user home directory)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=remote ftp or http upload</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=both</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369987"></a><a name="_Toc506244092"></a><a name="_Toc427878408"></a><a name="_Toc414335086"></a><a name="_Toc373962518"></a><a name="_Toc373958253"></a><a name="_Toc373366421"></a><a name="_Toc319361733"><span style='font-size:10.0pt;font-style:normal'>voicerecfilename</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The format of the recorded filenames.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=date-time + peer name (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=date-time + sip call-id</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=sip call-id</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=date-time + username</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4=date-time + username + peer name</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The date-time will be formatted in the following way: yyyyMMddhhmmss</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note: You can also use the “voicerecfilenameprefix” parameter to add a prefix for the file name.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369988"></a><a name="_Toc506244093"></a><a name="_Toc427878409"></a><a name="_Toc414335087"></a><a name="_Toc373962519"></a><a name="_Toc373958254"></a><a name="_Toc373366422"></a><a name="_Toc319361734"><span style='font-size:10.0pt'>voicerecftp_addr</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>FTP location for the recorded voice files if the “voicerecording” parameter is set to 2 or 3.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Format: </span><a href="ftp://USER:PASS@HOST:PORT/PATH/TO/THEFILE"><span style='font-style:normal'>ftp://USER:PASS@HOST:PORT/PATH/TO/THEFILE</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: </span><a href="ftp://user01:pass1234@ftp.foo.com/FILENAME"><span style='font-style:normal'>ftp://user01:pass1234@ftp.foo.com/FILENAME</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The FILENAME part of the string will be replaced with the file name according to the “voicerecfilename” parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369989"></a><a name="_Toc506244094"></a><a name="_Toc427878410"></a><a name="_Toc414335088"></a><a name="_Toc373962520"></a><a name="_Toc373958255"></a><a name="_Toc373366423"></a><a name="_Toc319361735"><span style='font-size:10.0pt;font-style:normal'>voicerecformat</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Recorded file compression.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: PCM wave stereo files with separate channels for in/our (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: raw gsm. 2 files will be generated for each call. One for the recorder file and another for the playback. These files can be played with players supporting gsm codecs for example </span><a href="http://www.apple.com/quicktime/download/"><span style='font-style:normal'>quicktime</span></a><span style='font-style:normal'> (which works also as a browser plugin) or a winamp plugin is downloadable from </span><a href="http://www.mlkj.net/gsm/"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: ogg/vorbis (optional, on request; module might not be included by default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369990"></a><a name="_Toc506244095"></a><a name="_Toc427878411"></a><a name="_Toc414335089"></a><a name="_Toc373962521"></a><a name="_Toc373958256"></a><a name="_Toc373366424"></a><a name="_Toc319361736"><span style='font-size:10.0pt;font-style:normal'>voicerecordingbuff</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The maximum recorded file length.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1: dynamic, no limit</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: max around 1 minute</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: max around 2 minute</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>…</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is -1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369991"></a><a name="_Toc506244096"></a><a name="_Toc427878412"></a><a name="_Toc414335090"></a><a name="_Toc373962522"></a><a name="_Toc373958257"></a><a name="_Toc373366425"><span style='font-size:10.0pt; font-style:normal'>syncvoicerec</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>How to synchronize the recording/playback side:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1: Auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: No (don’t synchronize)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: Yes (fill with noise the other channel)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: Yes (wait for both side)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default: 2</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node59" id="node59"></a><span style='font-size:10.0pt;font-style:normal'>uploadretry</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify whether the file upload should be retried on failure if the voicerecording parameter is set to 2 or 3.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: once</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: until success</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default: 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369992"></a><a name="_Toc506244097"></a><a name="_Toc427878413"></a><a name="_Toc414335091"><span style='font-size:10.0pt'>ftp_addr</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>FTP location for general storage (for example for settings, contactlists)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Format: </span><a href="ftp://USER:PASS@HOST:PORT/PATH/TO/THEFILE"><span style='font-style:normal'>ftp://USER:PASS@HOST:PORT/PATH/TO/THEFILE</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: </span><a href="ftp://user01:pass1234@ftp.foo.com/FILENAME"><span style='font-style:normal'>ftp://user01:pass1234@ftp.foo.com/FILENAME</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The FILENAME part of the string will be replaced with the actual file name.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369993"></a><a name="_Toc506244098"></a><a name="_Toc427878414"></a><a name="_Toc414335092"><span style='font-size:10.0pt'>http_addr</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>HTTP location for general storage (for example for settings, contactlists)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Format: </span><a href="http://www.yourdomain.com/webphonestorage/"><span style='font-style:normal'>http://www.yourdomain.com/storage/</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>(this is just an example URL format. This URL will not work. You need to change this to your own web address)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_webrtcserveraddress"></a>webrtcserveraddress</h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>WebSocket server URL for WebRTC video if any. Example: wss://rtc.myserver.com/sip</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369994"></a><a name="_Toc506244099"></a><a name="_Toc427878415"></a><a name="_Toc414335093"></a><a name="_Toc373962523"></a><a name="_Toc373958258"></a><a name="_Toc373366426"></a><a name="_Toc319361737"></a><a name="_Toc255049830"><span style='font-size:10.0pt'>autocfgsave</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Configurations and statistics are stored in a local file to be reused in next sessions.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This is not critical and the Java VoIP client will work just fine if this file is lost or deleted by the user.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Sometime is useful to not allow configuration/settings storage on the user device.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The autocfgsave option can be set to the following values:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>-2: disable all file write forced</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>-1: disable file write</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>0: disable config storage</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>1: save only</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>2: load only</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>3: save and load </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 3.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369995"></a><a name="_Toc506244100"></a><a name="_Toc427878416"></a><a name="_Toc414335094"><span style='font-size:10.0pt'>resetsettings</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to true to clear all previously stored or cached settings.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369996"></a><a name="_Toc506244101"></a><a name="_Toc427878417"></a><a name="_Toc414335095"></a><a name="_Toc373962524"></a><a name="_Toc373958259"></a><a name="_Toc373366427"></a><a name="_Toc319361738"></a><a name="_Toc255049831"></a><a name="_signalingport"></a><span style='font-size: 10.0pt'>signalingport</span><span style='font-size:10.0pt'> </span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify local SIP signaling port to use.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 0 (a stable port which is selected randomly at the first usage)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: this is not the port of your server where the messages should be sent. This is the local port for sip user agent.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369997"></a><a name="_Toc506244102"></a><a name="_Toc427878418"></a><a name="_Toc414335096"></a><a name="_Toc373962525"></a><a name="_Toc373958260"></a><a name="_Toc373366428"></a><a name="_Toc319361739"></a><a name="_Toc255049832"><span style='font-size:10.0pt'>rtpport</span></a><span style='font-size:10.0pt'> </span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify local RTP port base.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 0 (which means signalingport + 2)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: If not specified, then the Android SIP SDK will choose signalingport + 2 which is then remembered at the first successful call and reused next time (stable rtp port). If there are multiple simultaneous calls then it will choose the next <span lang="HU">even number.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506369998"></a><a name="_Toc506244103"><span style='font-size:10.0pt'>incrtpport</span></a><span style='font-size:10.0pt'> </span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Increment RTP port for each call by this value.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Might be needed only with some misbehaving routers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 0.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: You will still have a different RTP port for each simultaneous calls even if this is set to 0.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 1.0pt 2.0pt;margin-left:.1in;margin-right: 0in'> <p class="MsoNormalCxSpMiddle" style='margin-top:10.0pt;margin-right:0in; margin-bottom:5.0pt;margin-left:0in;line-height:normal;border:none;padding: 0in'><a name="_Toc42017102"><b><span style='font-family:"Cambria",serif; color:#943634'>bindip</span></b></a><b><span style='font-family:"Cambria",serif; color:#943634'> </span></b></p> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(String)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify local network interface IP address for the sockets to bind to. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This parameter might be used only on devices with multiple local IP addresses to force the specified IP. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This parameter should be used only with local private IP (an IP address which is present on the device).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is empty (by default it doesn’t bind to any IP and it is up to the OS routing table from which IP the packets are sent)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: This parameter should be used only in very specific circumstances when the device has multiple IP address and you wish to use only one of them.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 1.0pt 2.0pt;margin-left:.1in;margin-right: 0in'> <h3 style='margin-left:0in;border:none;padding:0in'><a name="_Toc506369999"></a><a name="_Toc506244104"></a><a name="_Toc427878419"></a><a name="_Toc414335097"></a><a name="_Toc373962526"></a><a name="_Toc373958261"></a><a name="_Toc373366429"></a><a name="_Toc319361740"><span style='font-size:10.0pt'>localip</span></a><span style='font-size:10.0pt'> </span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(String)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify local IP address to be used for the SIP signaling.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This parameter might be used only on devices with multiple ethernet interface to force the specified IP or if AJVoIP is behind NAT to specify its public IP. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This parameter should be used only with static IP (if the device IP doesn’t change dynamically from DHCP) or if you can better detect the best IP to be used in your app instead of letting AJVoIP to auto detect it.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is empty (auto-detect best interface to be used or detect the external IP)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>AJVoIP by default will auto detect the “best” IP to be used and this parameter should be used only in very specific circumstances.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>It is also possible to set the address sent in SDP explicitly with the <span style='color:#984806'>localsdpip </span>and <span style='color:#984806'>localsdpport </span>parameters.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 1.0pt 2.0pt;margin-left:.1in;margin-right: 0in'> <p class="MsoNormalCxSpMiddle" style='margin-top:10.0pt;margin-right:0in; margin-bottom:5.0pt;margin-left:0in;line-height:normal;border:none;padding: 0in'><a name="_Toc42017104"><b><span style='font-family:"Cambria",serif; color:#943634'>favlocalip</span></b></a></p> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(String)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify local subnet preference.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For example if the device where AJVoIP is running might have two separate IP (such as 192.168.1.5 and 10.0.0.5) then you might set the favlocalip to 192 to always prefer the 192.x.x.x subnet.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This parameter might be used only on devices running on a known environment (local LAN) in case if you wish to suggest the subnet to be used. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is empty (auto-detect best subnet to be used)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: AJVoIP by default will auto detect the “best” IP to be used and this parameter should be used only in very specific circumstances.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370002"></a><a name="_Toc506244107"></a><a name="_Toc427878422"></a><a name="_Toc414335100"></a><a name="_Toc373962529"></a><a name="_Toc373958264"></a><a name="_Toc373366432"></a><a name="_Toc319361744"><span style='font-size:10.0pt'>increasepriority</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This will increase the priority for the whole thread-group which might help on slow CPU’s or when other applications are generating high CPU load.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: the priority of the threads handling media are increased regardless of this setting.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is false. <br> <br> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370003"></a><a name="_Toc506244108"></a><a name="_Toc427878424"></a><a name="_Toc414335101"></a><a name="_Toc373962530"></a><a name="_Toc373958265"></a><a name="_Toc373366433"></a><a name="_Toc319361743"></a><a name="_Toc255049835"></a><a name="_loglevel"></a><span style='font-size:10.0pt'>loglevel</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Tracing level. Values from 0 to 9. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You should set the default loglevel to 1 for production and 5 for test or development.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Loglevel 0 is not recommended as the Android SIP SDK will not even display important even notifications for the user in this case. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Loglevel 5 means a full log including SIP signaling. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Loglevel higher than 5 should be avoided (this can slow down the application).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The logs are sent to the following outputs:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>status display (only level 1 –these are the most important events that should be displayed also for the enduser)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>file if the canlogtofile parameter is set to 1 or 2</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>logcat if the logtoconsole parameter is set to true</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>system log if the systemout parameter is set to true (System.Out)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>accessible for the GetLogs() API</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>sent with notifications if the events parameter is 3</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>More details </span><a href="start.htm#_How_to_send"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoListParagraph" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc427878425"></a><a name="_Toc414335102"></a><a name="_Toc373962531"></a><a name="_Toc373958266"></a><a name="_Toc373366434"></a><a name="_Toc319361745"><span style='font-size:10.0pt'>logtoconsole</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Whether to send tracing to the java console (System.out.print or often referred as STDOUT).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>0: no (disable log to console)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>1: auto (depending on loglevel)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>2: always (always log to stdout)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370005"><span style='font-size: 10.0pt'>systemout</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Whether to send logs to standard output.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370006"><span style='font-size: 10.0pt'>logcat</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Whether to send logs to standard Logcat.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is true.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370007"></a><a name="_Toc506244110"></a><a name="_canlogtofile"></a><span style='font-size:10.0pt'>canlogtofile</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify if AJVoIP should write the logs to file.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>0: never</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>1: if the loglevel is higher then 2 and not headless</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>2: always</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>With loglevel set to 2 or more, the logs are written also to a local file by default. </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>To disable the log files, set the canlogtofile parameter to “0” (or set the “loglevel” to 1 and keep the canlogtofile default at 1).</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The logs are usually stored at \mwphonedata\webphonelog.dat or you can specify the path with the <span style='color:#984806'>logpath </span>parameter. The exact path can be queried with the <span style='color:#984806'>GetLogPath </span>API.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The log file is recreated with every startup and the old log file is renamed to previous_webphonelog.dat (so you will have max 2 log files: the current and the previous).</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370008"></a><a name="_Toc506244111"></a><a name="_Toc427878426"></a><a name="_Toc414335103"></a><a name="_Toc373962532"></a><a name="_Toc373958267"></a><a name="_Toc373366435"></a><a name="_Toc319361746">capabilityrequest</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If set to true then will send a capability request (OPTIONS) message to the SIP server on startup. The serveraddress parameter must be set correctly for this to work. This method is useful to release the security restrictions when using the Android SIP library with the API and also to open the NAT devices.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370009"></a><a name="_Toc506244112"></a><a name="_Toc427878427"></a><a name="_Toc414335104"></a><a name="_Toc373962533"></a><a name="_Toc373958268"></a><a name="_Toc373366436"></a><a name="_Toc319361747">natkeepalive</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If set to true then will send a short message (\r\n) to the SIP server on startup. The serveraddress parameter must be set correctly for this to work. This method is useful to release the security restrictions and also to open the NAT devices.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Deprecated since v.3.8.2</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370010"></a><a name="_Toc506244113"></a><a name="_Toc427878428"></a><a name="_Toc414335105">keepaliveival</a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>NAT keep-alive interval in milliseconds which is usually sent from register endpoints.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 28000. (28 seconds)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370011"></a><a name="_Toc506244114"></a><a name="_Toc427878429"></a><a name="_Toc414335106"></a><a name="_Toc373962534"></a><a name="_Toc373958269"></a><a name="_Toc373366437"></a><a name="_Toc319361748"></a><a name="_Toc255049836"><span style='font-size:10.0pt'>recaudiobuffers</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Number of buffers used for audio recording.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 7.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370012"></a><a name="_Toc506244115"></a><a name="_Toc427878430"></a><a name="_Toc414335107"></a><a name="_Toc373962535"></a><a name="_Toc373958270"></a><a name="_Toc373366438"></a><a name="_Toc319361749"></a><a name="_Toc255049837"><span style='font-size:10.0pt'>recaudiomode</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Audio recording mode. 0 means default; 1 means event based; 2 means device poll.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 0.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370000"></a><a name="_Toc506244105"></a><a name="_Toc427878420"></a><a name="_Toc414335098"></a><a name="_Toc373962527"></a><a name="_Toc373958262"></a><a name="_Toc373366430"></a><a name="_Toc319361741"></a><a name="_Toc255049834"><span style='font-size:10.0pt'>jittersize</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Although the jitter size is calculated dynamically, you can modify its behavior with this setting.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no jitter,1=extra small,2=small,3=normal,4=big,5=extra big,6=max</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 3</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node60" id="node60"></a><span style='font-size:10.0pt'>allowspeedup</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify whether to enable audio playback speedup on high queue size.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(Instead of dropping packets, it might attempt to speed up the playback rate for a short time until queue size drops below threshold)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values: -1: Auto Guess (default), 0: No, 1: Yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node61" id="node61"></a><span style='font-size:10.0pt'>allowfirstdrop</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify whether to enable drop of RTP packets on media start.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Sometime the other end might start sending RTP before the media is opened at AJVoIP side resulting in accumulation of packets.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Dropping the first few packets will make the playback of the rest more smooth, but might result in some loss of audible media (usually up to 100 milliseconds)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values: -1: Auto Guess (default), 0: No, 1: Yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370001"></a><a name="_Toc506244106"></a><a name="_Toc427878421"></a><a name="_Toc414335099"></a><a name="_Toc373962528"></a><a name="_Toc373958263"></a><a name="_Toc373366431"></a><a name="_Toc319361742"><span style='font-size:10.0pt'>maxjitterpackets</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can limit the jitter buffer size with this setting.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>With the jittersize left as default (3) the maximum buffered packet count is limited to 8, so you might set this parameter to a lower value.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>One packet means a received udp packet which might contain one or more audio frame.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For example when using G.729 the typical media stream are with 2 frames/packet. Each frame is 10 msec length.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>A jitter limitation of 5 would mean maximum 100 msec to be cached. (while the default setting would allow 8 packet which means 160 msec)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 99 (no limitation)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370013"></a><a name="_Toc506244116"></a><a name="_Toc427878431"></a><a name="_Toc414335108"></a><a name="_Toc373962536"></a><a name="_Toc373958271"></a><a name="_Toc373366439"></a><a name="_Toc319361750"></a><a name="_Toc255049838"><span style='font-size:10.0pt'>useencryption</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)<br> Set to true for encrypted communication (both media and signaling)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This has nothing to do with standard SIP encryption and it works only with mizu server tunneling module.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node62" id="node62"></a><span style='font-size:10.0pt'>callreceiver</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>How to handle incoming calls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-1: auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: disable all incoming calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: enable incoming calls (while app is running; no background listener)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: enable also background calls (push or service implemented)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is -1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_enablefcm"></a><s><span style='font-size: 10.0pt'>enablepush</span></s></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This parameter is deprecated and to be used only for the softphones. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Use the pushnotifications parameter or the </span><a href="start.htm#_boolean_SetPushNotification(int_pus"><span style='font-style: normal'>PushNotification</span></a><span style='font-style:normal'> API to enable/disable push notifications.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><s><span style='font-style:normal'>Specify whether to enable push notifications by default.</span></s></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><s><span style='font-style:normal'>Possible values:</span></s></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><s><span style='font-style:normal'>-1: auto</span></s></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><s><span style='font-style:normal'>0: disabled</span></s></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><s><span style='font-style:normal'>1: enabled auto</span></s></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><s><span style='font-style:normal'>2: enabled direct to SIP server</span></s></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><s><span style='font-style:normal'>3: enabled via gateway Default: -1</span></s></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><s><span style='font-style:normal'><span style='text-decoration:none'> </span></span></s></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><s><span style='font-style:normal'>If set to 1, then will try push with your server (as described in RFC 8599 so your server must answer to REGISTER with Feature-Caps: *;+sip.pns="fcm") and if fails then it will try via push gateway.</span></s></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For more details see the </span><a href="start.htm#_VoIP_Push_notifications_1"><span style='font-style:normal'>push notifications</span></a><span style='font-style:normal'> FAQ.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_pushnotifications"></a><span style='font-size:10.0pt'>pushnotifications</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Enable push notifications via as Google Firebase FCM.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1=auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=enabled auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=enabled direct (with your SIP server if it has push support)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=enabled via gateway</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is -1 which means auto enable when required and possible. If FCM is available(if I have json file configured) and background service is not 1 AND there was incoming calls in the last 120 days or installed less then 120 days ago; otherwise it means no. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>We provides push service (free tier) for all our customers enabled by default (via gateway if your server doesn't support push notifications).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>To configure push notifications, you might use the <a href="start.htm#_boolean_SetPushNotification(int_pus">PushNotification</a> API instead of these parameters.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For more details see the <a href="start.htm#_VoIP_Push_notifications_1">push notifications</a> FAQ.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_fcmgateway"></a><span style='font-size: 10.0pt'>fcmgateway</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify FCM gateway to be used if a push gateway have to be used (instead of directly with SIP server).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is: fcm.webvoipphone.com:35060</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>To configure push notifications, you might use the <a href="start.htm#_boolean_SetPushNotification(int_pus">PushNotification</a> API instead of these parameters.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For more details see the <a href="start.htm#_VoIP_Push_notifications_1">push notifications</a> FAQ.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_packagename"></a><span style='font-size: 10.0pt'>packagename</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Project ID. This is your application package name, used for export and upload to google market to be used also for push notifications.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is: empty or loaded from your app context or com.mizuvoip.mizudroid.app with mizu gateways.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>To configure push notifications, you might use the <a href="start.htm#_boolean_SetPushNotification(int_pus">PushNotification</a> API instead of these parameters.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For more details see the <a href="start.htm#_VoIP_Push_notifications_1">push notifications</a> FAQ.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_fcmclientid"></a><span style='font-size: 10.0pt'>fcmclientid</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Your app token (token ID or Project ID returned by registering to the notification service) which can be received from your OS push/apns/fcm API. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is empty string.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>To configure push notifications, you might use the <a href="start.htm#_boolean_SetPushNotification(int_pus">PushNotification</a> API instead of these parameters.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For more details see the <a href="start.htm#_VoIP_Push_notifications_1">push notifications</a> FAQ.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_pushtype"></a><span style='font-size: 10.0pt'>pushtype</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify what protocol to use for push notifications</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1: auto (1 with mizu servers, 2 with others or not sure)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: mizu proprietary X-MPUSH</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: standard </span><a href="https://tools.ietf.org/html/rfc8599"><span style='font-style:normal'>RFC 8599</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: force RFC8599 even with our servers or secondary</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: both</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is -1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>In case if you are using a Mizu server, the AJVoIP can use the mizu proprietary protocol for push binding: <span style='color:#984806'>X-MPSUH: a:packagename:clientid.</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Otherwise (with any third-party SIP servers) you should use the Push Notification for SIP standard as described in </span><a href="https://tools.ietf.org/html/rfc8599"><span style='font-style:normal'>RFC 8599</span></a><span style='font-style:normal'> which will send pn-* contact tags (Media Feature Tags) like <span style='color:#984806'>pn-provider=fcm;pn-param=PACKAGENAME;pn-prid=TOKEN </span>and will expect Feature-Caps: *;+sip.pns="fcm" in the answer).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For the details about SIP push notifications see the “SIP signaling” chapter in the <a href="https://www.mizu-voip.com/Portals/0/Files/VOIP_Push_notifications.pdf">VoIP Push Notifications</a> guide.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For more details see the <a href="start.htm#_VoIP_Push_notifications_1">push notifications</a> FAQ.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_runservice"></a><span style='font-size: 10.0pt'>runservice</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to 1 or 2 if your app is running as a service (or you are running the sipstack from a service) to enable some related optimizations.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This might be necessary if your apps needs to be always available for incoming calls but for some reason you don’t implement </span><a href="start.htm#_VoIP_Push_notifications_1"><span style='font-style: normal'>push notifications</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1: auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: no </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: background service</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: foreground service<br> <br> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default: -1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: background services are heavily limited since API level 26 but AJVoIP implements all possible workarounds to bypass this limitation. Foreground services are more reliable since API level 26. Use a foreground if the always visible notification is acceptable for your user-case.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>More details can be found </span><a href="start.htm#_Run_as_a"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_scheduledwakeup"></a><span style='font-size:10.0pt'>scheduledwakeup</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Enable scheduled wakeup if running as a background service to help with background service </span><a href="https://developer.android.com/about/versions/oreo/background#services"><span style='font-style:normal'>limitations</span></a><span style='font-style:normal'> and doze/standby </span><a href="https://developer.android.com/training/monitoring-device-state/doze-standby"><span style='font-style:normal'>limitations</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: Never</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: Yes if running as service</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: Always force </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default: 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>More details can be found </span><a href="start.htm#_Run_as_a"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_serviceclassname"></a><span style='font-size:10.0pt'>serviceclassname</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(String)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Used for scheduled wakeup.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set this to the name of your android service class that will run in the background to be able to receive incoming calls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value: empty</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>SetParameter(“serviceclassname”, “com.mycompany.appname.mainclass.myservice”);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_askforwhitelist"></a><span style='font-size:10.0pt'>askforwhitelist</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Might ask the user to white-list your app if running as a background service to help with background service </span><a href="https://developer.android.com/about/versions/oreo/background#services"><span style='font-style:normal'>limitations</span></a><span style='font-style:normal'> and doze/standby </span><a href="https://developer.android.com/training/monitoring-device-state/doze-standby"><span style='font-style:normal'>limitations</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: No</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: Yes if running as service</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: Always force</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default: 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>More details can be found </span><a href="start.htm#_Run_as_a"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370014"></a><a name="_Toc506244117"></a><a name="_Toc427878432"></a><a name="_Toc414335109"></a><a name="_Toc373962537"></a><a name="_Toc373958272"></a><a name="_Toc373366440"></a><a name="_Toc319361751"></a><a name="_Toc255049839"><span style='font-size:10.0pt'>maxlines</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: single line</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: unlimited</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is: 2</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370015"></a><a name="_Toc506244118"><span style='font-size:10.0pt'>fastexit</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set cleanup speed and wait times.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: slow but will more care about un-registration and cleanup</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: fast</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: very fast with no unregister</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is: 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 1.0pt 2.0pt;margin-left:.1in;margin-right: 0in'> <h3 style='margin-left:0in;border:none;padding:0in'><a name="_events"></a><span style='font-size:10.0pt'>events</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Defines the level of notifications:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no notifications,1=status and cdr,2=important events,3= all logs including SIP signaling messages (depending also on loglevel). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node63" id="node63"></a><span style='font-size:10.0pt'>stats</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)<br> Set to a value in seconds if you wish to receive extended periodic statistics for each line (STATUS notifications).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 0 (no periodic statistics)<br> <br> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <p class="MsoNormalCxSpMiddle" style='margin-top:10.0pt;margin-right:0in; margin-bottom:5.0pt;margin-left:0in;line-height:normal;border:none;padding: 0in'><b><span style='font-family:"Cambria",serif;color:#943634'>notificationssingleton</span></b></p> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify if to reuse the SIPNotification objects.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1: auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: separate SIPNotification object for all function calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: one SIPNotification object to be reused</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is -1 (defaults to 1)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>If set to 1, you will not be able to reuse the SIPNotification (e) object later in your code as it will be always overwritten with the latest.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <p class="MsoNormalCxSpMiddle" style='margin-top:10.0pt;margin-right:0in; margin-bottom:5.0pt;margin-left:0in;line-height:normal;border:none;padding: 0in'><b><span style='font-family:"Cambria",serif;color:#943634'>notificationeventthread</span></b></p> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Notification event threading.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1: auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: from the main thread only (thread safe but slower with around 20 milliseconds delay)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: from the caller thread (faster but not thread safe. the user must synchronize; don’t access your GUI directly from the notification events)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default: -1 (defaults to 0)<br> <br> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <p class="MsoNormalCxSpMiddle" style='margin-top:10.0pt;margin-right:0in; margin-bottom:5.0pt;margin-left:0in;line-height:normal;border:none;padding: 0in'><a name="_notificationevents"></a><b><span style='font-family:"Cambria",serif; color:#943634'>notificationevents</span></b></p> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(int)<br> Notification events vs string send vs string polling.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>To get the event </span><a href="start.htm#_Notifications"><span style='font-style:normal'>notification</span></a><u><span style='color:blue;font-style:normal'>s</span></u><span style='font-style:normal'> from the voip SDK to your application, you can use one of the following methods:</span></p> <ul style='margin-top:0in' type="disc"> <li class="MsoNormalCxSpMiddle" style='color:black;margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='font-style:normal'>Notification events using the SetNotificationListener to subscribe (to receive SIPNotification objects)</span></li> <li class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'>GetNotificationStrings (to blocking receive </span><span style='font-style:normal'>notification strings</span><span style='font-style:normal'> in a separate thread)</span></li> <li class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><a href="start.htm#_String_GetNotifications()"><span style='font-style:normal'>PollNotificationStrings</span></a><span style='font-style:normal'> (polling for </span><span style='font-style:normal'>notification strings</span><span style='font-style:normal'>)</span></li> </ul> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify which method to use with this parameter. Possible values: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1: auto/on demand</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: don’t use polling</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: use polling</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: use polling</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: use polling only</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: use SIPNotification event objects only</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is -1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If set to -1 (default), then</span></p> <ul style='margin-top:0in' type="circle"> <li class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'>will turn to 0 on first notification events</span></li> <li class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'>will turn to 3 on first PollNotificationStrings</span></li> <li class="MsoNormalCxSpMiddle" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'>will turn to 4 on first SetNotificationListener function call</span></li> </ul> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:#548DD4'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>We recommend to use the newly implemented SIPNotification events (<span style='color:black'>SetNotificationListener). The other methods are deprecated, but will remain supported as-is for backward compatibility. </span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'><br> <br> </span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc506370021"></a><a name="_FAQ"></a>FAQ</h1> </div> <p class="MsoNormal"><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370022"></a><a name="_Toc506244125"></a><a name="_Toc427878442"></a><a name="_Toc414335149"></a><a name="_Toc373962572"></a><a name="_Toc373958306"></a><a name="_Toc373366479"></a><a name="_Toc319361793"><span style='font-style:normal'>How to get my own Android VoIP SDK?</span></a></h3> </div> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in'><span style='font-style:normal'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Have a look at the description and pricing from the </span><a href="https://www.mizu-voip.com/Software/SIPSDK/AndroidSIPSDK.aspx"><span style='font-style:normal'>SIP library home page</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-style:normal'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Download and try the demo from </span><a href="https://www.mizu-voip.com/Portals/0/Files/AJVoIP.zip"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>. You might start with the </span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/Default.aspx?topic=Android+SIP+SDK+Quick+Start"><span style='font-style:normal'>quick intro</span></a><span style='font-style:normal'> and then read trough this </span><a href="https://www.mizu-voip.com/Portals/0/Files/AndroidSIPSDK.pdf"><span style='font-style:normal'>documentation</span></a><span style='font-style:normal'>.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-style:normal'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Contact Mizutech at </span><a href="mailto:info@mizu-voip.com"><span style='font-style:normal'>info@mizu-voip.com</span></a><span style='font-size:11.0pt;line-height:120%'> </span><span style='font-style:normal'>with the following details</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.0in'><span style='font-style:normal'>-your VoIP server(s) address (ip or domain name). This will be hardcoded in your release; otherwise anybody could just download it from your and use as it owns</span><span style='font-size:9.0pt;line-height: 120%;font-style:normal'>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:1.0in'><span style='font-style:normal'>-your company details for the invoice (if you are representing a company)</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-style:normal'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Mizutech support will send your own AJVoIP build within one workday on your payment. </span></p> <p class="MsoListParagraphCxSpLast"><span style='font-style:normal'>The payment can be made from the </span><a href="https://www.mizu-voip.com/Software/SIPSDK/AndroidSIPSDK.aspx"><span style='font-style:normal'>home page</span></a><span style='font-style:normal'> pricing grid with paypal or credit card or by </span><a href="http://www.mizu-voip.com/Company/Payments.aspx"><span style='font-style: normal'>wire transfer</span></a><span style='font-style:normal'>.</span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370023"></a><a name="_Toc506244126"></a><a name="_Toc427878443"></a><a name="_Toc414335150"></a><a name="_Toc373962573"></a><a name="_Toc373958307"></a><a name="_Toc373366480"></a><a name="_Toc319361794"><span style='font-style:normal'>What about support?</span></a></h3> </div> <p class="MsoNormal"><span style='font-style:normal'>All licenses include also a support plan in the cost. <br> The support is done mostly by email. For “gold license” we offer 24/7 phone emergency support.<br> Maintenance upgrades are also free as included with your license plan.<br> Email to </span><a href="mailto:info@mizu-voip.com"><span style='font-style: normal'>info@mizu-voip.com</span></a><span style='font-size:11.0pt;line-height: 120%'> </span><span style='font-style:normal'>with any issue you might have.<br> Guaranteed supports hours depend on the purchased license plan and are included in the price.<br> Once your initial 1-4 years support period expires, it can be increased by 2 years for around $600 (This is optional. There is no need for any support plan to operate your AJVoIP as the library is shipped with life-time license).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'>Note:</p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span>We can’t guarantee that all the listed features will work correctly in your environment (your SIP servers / integrated with your software). Please test the demo/trial version before purchase to make sure that all the functionality critical to your use-case works correctly.</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span>Our support answer time is usually up to one work-day for issues related to core functionality (such as connect/register and voice calls). We are trying to resolve all such issues as soon as possible. Issues affecting non-core features (such as call hold or presence) might be handled only in the upcoming new releases.</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span>Direct support is provided for the common features (voice calls, chat, dtmf and others) and not for extra features (such as presence or video). Direct support is not provided for the issues described in the <a href="start.htm#_Known_limitations"><span style='color:black'>known limitations</span></a> section. If you have some special must-to-have requirement, we recommend to test with the <a href="https://www.mizu-voip.com/Portals/0/Files/webphone.zip">demo</a> version before purchasing your license. However we appreciate all bug reports and we are constantly working on our software shipping new features, improvements and bug fixes with each new release.</p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span>Mizutech doesn’t provide direct server side support. Although AJVoIP is known to work well with all common SIP servers (including Asterisk, FreeSWITCH and many others), your servers have to be managed by you and we are not responsible for proper configuration of your servers. However, in case if there is any incompatibility issue then we might be able to help you with the resolution if you send us the related logs.</p> <p class="MsoNormal"><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370024"></a><a name="_Toc506244127"></a><a name="_Toc427878444"></a><a name="_Toc414335151"></a><a name="_Toc373962574"></a><a name="_Toc373958308"></a><a name="_Toc373366481"></a><a name="_Toc319361795"><span style='font-style:normal'>What I will receive once I have made the payment for Android VoIP SDK?</span></a></h3> </div> <p class="MsoNormal"><span style='font-style:normal'>You will receive the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>The AJVoIP library itself. This is one single file usually named as “AJVoIP.jar” or “AJVoIP.aar” </span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Latest documentations</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Usage examples</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Invoice (on request or if you haven’t received it before or during payment)</span></p> <p class="MsoListParagraphCxSpLast" style='text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Support on your request according to the license plan</span></p> <p class="MsoNormal" style='text-indent:.25in'><a href="start.htm#_Package_content"><span style='font-style:normal'>More details</span></a><span style='font-style:normal'>.</span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370025"></a><a name="_Toc506244128"></a><a name="_Toc427878445"></a><a name="_Toc414335152"></a><a name="_Toc373962575"></a><a name="_Toc373958309"></a><a name="_Toc373366482"></a><a name="_Toc319361796"></a><a name="_Toc255049879"><span style='font-style:normal'>Can Mizutech do custom development if required?</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>Yes, please contact us at </span><a href="mailto:info@mizu-voip.com"><span style='font-style:normal'>info@mizu-voip.com</span></a><span style='font-style:normal'>. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>Note: Please contact us only with AJVoIP related or VoIP specific projects. We are highly specialized for VoIP development thus we will not accept general app development projects which can be done by any developer or team (We don’t handle tasks such as building user interface or design elements).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370026"></a><a name="_Toc506244129"></a><a name="_Toc427878446"></a><a name="_Toc414335154"></a><a name="_Toc373962577"></a><a name="_Toc373958311"></a><a name="_Toc373366484"></a><a name="_Toc319361798"></a><a name="_Toc255049875"><span style='font-style:normal'>Is it working with any VoIP servers?</span></a></h3> </div> <p class="MsoNormal"><span style='font-style:normal'>Yes. The VoIP SKD uses the SIP protocol standard to communicate with VoIP servers and sofswitches. Since most of the VoIP servers are based on the SIP protocol today, AJVoIP should work without any issue. AJVoIP have been tested with numerous other SIP stack (software/hardware) and we invest extra effort to achieve maximum compatibility even with misbehaving SIP implementations.<br> If you have any incompatibility problem, please contact </span><a href="mailto:info@mizu-voip.com"><span style='font-style:normal'>info@mizu-voip.com</span></a><span style='font-style:normal'> with a problem description and a detailed log (loglevel set to 5). For more tests please send us your VoIP server address with 3 test accounts.</span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node64" id="node64"></a><span style='font-style:normal'>How is the call quality?</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>Short answer: “better than Skype”</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>Long answer:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>The library is capable for perfect voice quality if that is possible in your environment (server/peer codec support, network link quality, etc). Otherwise it aims to produce the best possible call quality achievable depending on the circumstances.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>AJVoIP includes wide-band </span><a href="http://opus-codec.org/comparison/"><span style='font-style:normal'>OPUS</span></a><span style='font-style:normal'> and Speex codec which are capable to offer a perfect call quality (MOS score of 6).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>Of course, these have to be supported also by the peer to be used. PSTN networks usually has support only for narrowband codec (such as G.729, GSM, iLBC or G.711), so the call quality will be lower here (but still better than traditional phones if the user connection fulfills the minimal bandwidth and quality required for VoIP).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>The media stack implements best practices for network and audio device handling to minimize the total delay.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>A wide range of audio enhancement algorithms are also implemented such as AEC, denoise, PLC and AGC.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>AJVoIP is also capable to auto-fine-tune itself to the circumstances by default (based on device capabilities, CPU speed, network bandwidth/quality, peer/server capabilities), but you can also force any settings with the parameters (such as codec, framesize, aec, etc). </span></p> <p class="MsoNormal"><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370027"></a><a name="_Toc506244130"></a><a name="_Toc427878448"></a><a name="_Toc414335159"></a><a name="_Toc373962582"></a><a name="_Toc373958316"></a><a name="_Toc373366489"></a><a name="_Toc319361803"><span style='font-style:normal'>Is AJVoIP using any Mizutech service or will contact Mizutech servers?</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>The Android SIP SDK will connect to your voip server directly. No any intermediary app server is involved. <br> AJVoIP will not “call to home” and will not send any sensitive information to Mizutech servers.<br> AJVoIP might contact Mizutech servers for the following reasons:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>demo versions might contact Mizutech licensing servers time to time. This is completely removed in final builds (after your order)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>AJVoIP will use a random stun server by default hosted by Mizutech. This “fast stun” protocol is usually not required for normal functionality so you might just disable it (set the “use_fast_stun” parameter to 0) or set the “stunserver” parameter to your stun server. (However these can improve the connectivity if your VoIP server is not NAT friendly so better to leave it as is. Mizu services (non) availability can’t alter the usability of your product)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Push Notifications: if you don’t implement your own push notification service then AJVoIP might use the Mizu push notification gateway which we offer for all our customers (free tier). This can be disabled or replaced with your own implementation.</span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370028"></a><a name="_Toc506244131"></a><a name="_Toc427878449"></a><a name="_Toc414335162"></a><a name="_Toc373962585"></a><a name="_Toc373958319"></a><a name="_Toc373366492"></a><a name="_Toc319361806"></a><a name="_Toc255049874"><span style='font-style:normal'>Is there any way to get the source code?</span></a></h3> </div> <p class="MsoNormal"><span style='font-style:normal'>The Android VoIP SDK is a close-source application. The source code is available only for internal usage at an additional higher cost.</span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_How_to_register?"></a><span style='font-style:normal'>How to register?</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>SIP registration means connecting to your SIP server and authenticating. From this procedure your SIP server will learn your application address and can route incoming calls to your application (or other sessions, such as chat, presence, voicemail, etc).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>The SIP stack auto-start behavior can be altered with the </span><a href="start.htm#_startsipstack"><span style='font-style:normal'>startsipstack</span></a><span style='font-style:normal'> setting or you can use the </span><a href="start.htm#_boolean_Start()"><span style='font-style:normal'>Start</span></a><span style='font-style:normal'> function to launch the instance explicitly.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>When started, the SIP stack by default (unless you set the </span><a href="start.htm#_register"><span style='font-style:normal'>register</span></a><span style='font-style:normal'> parameter to 0) will automatically register to your SIP server if you configured the </span><a href="start.htm#_Basic_Parameters"><span style='font-style:normal'>SIP account details</span></a><span style='font-style: normal'> (serveraddress, username, password and any other parameters that might be required such as the proxyaddress and sipusername).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>Otherwise you might disable auto-start (</span><a href="start.htm#_startsipstack"><span style='font-style:normal'>startsipstack</span></a><span style='font-style:normal'>) and/or the auto register (</span><a href="start.htm#_register"><span style='font-style:normal'>register</span></a><span style='font-style:normal'>), </span><a href="start.htm#_boolean_SetParameter(String_param,"><span style='font-style:normal'>pass</span></a><span style='font-style:normal'> the above parameters dynamically from your code and use the </span><a href="start.htm#_boolean_Start()"><span style='font-style:normal'>Start</span></a><span style='font-style:normal'> and/or the </span><a href="start.htm#_boolean_Register()"><span style='font-style:normal'>Register</span></a><span style='font-style:normal'> function to initiate the start/connect/register procedure.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>Registration success of failure can be obtained from the </span><a href="start.htm#_REGISTER,line,state,text,mainaccoun"><span style='font-style:normal'>REGISTER notifications</span></a><span style='font-style:normal'> (especially useful if you are using </span><a href="start.htm#_Multiple_account_registration_1"><span style='font-style:normal'>multiple accounts</span></a><span style='font-style:normal'> as this notifications are sent separately per account.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>The registration success or failure can be also obtained from the STATUS notifications as described </span><span style='font-style:normal'>here</span><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The registered state can be requested with the <span style='color:#984806'>IsRegistered </span>or <span style='color:#984806'>IsRegisteredEx </span>API.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The failure reason can be also obtained (instead of the above STATUS notifications) by using the <span style='color:#984806'>GetRegFailReason </span>API.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Once registered, AJVoIP will automatically maintain the registration state by resending the REGISTER request before it expires. It will also auto reconnect if there are any errors such as network connection problems, service availability, etc. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Check </span><a href="start.htm#_Can’t_connect_to"><span style='font-style:normal'>this FAQ point</span></a><span style='font-style:normal'> if you are having problems with connect/register.</span></p> <p class="MsoNormal"><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370030"></a><a name="_Toc506244133"></a><a name="_Toc427878452"></a><a name="_Multiple_account_registration_1"></a><span style='font-style:normal'>Multiple account registration</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The VoIP SDK is capable to register multiple accounts at the same time. This can be useful to be able to make and receive calls from multiple accounts or multiple servers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can configure multiple accounts using the </span><a href="start.htm#_extraregisteraccounts"><span style='font-style: normal'>extraregisteraccounts</span></a><span style='color:#984806;font-style: normal'> </span><span style='color:black;font-style:normal'>parameter or the </span><a href="start.htm#_boolean_RegisterEx(String_accounts)"><span style='font-style:normal'>RegisterEx</span></a><span style='color:#984806;font-style:normal'> </span><span style='color:black; font-style:normal'>function passing a string with the accounts fields. Fields are to be separated by comma and multiple accounts separated by semicolon.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>The following fields can be passed: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'> </span><span style='color:#984806;font-style:normal'>serveraddress, username, password,</span><span style='font-size:11.0pt;color:#984806'> </span><span style='color:#984806; font-style:normal'>registerinterval, proxyaddress, realm, authusername</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>Most of these fields are optional. The mandatory parameters are the username, password (and the serveraddress if that it is different from your main SIP server). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The SIP accounts can be configured by parameters in the following way:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>serveraddress, username, password,</span><span style='font-size:11.0pt;color:#984806'> </span><span style='color:#984806; font-style:normal'>registerinterval: primary account</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>serveraddress2, username2, password2,</span><span style='font-size:11.0pt;color:#984806'> </span><span style='color:#984806; font-style:normal'>registerinterval2: second account</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>serveraddress3, username3, password3,</span><span style='font-size:11.0pt;color:#984806'> </span><span style='color:#984806; font-style:normal'>registerinterval3: third account</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>…</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>serveraddressN, usernameN, password,</span><span style='font-size:11.0pt;color:#984806'> </span><span style='color:#984806; font-style:normal'>registerintervalN: N account</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Or via the <span style='color:#984806'>RegisterEx(String accounts) </span>API call where the accounts are passed as string in the following format:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> <span style='color: #984806'>server,usr,pwd,…;server2,usr2,pwd2, …;</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> (accounts separated by ; and parameters separated by , )</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> Example: <span style='color:#984806'>mysipclient.RegisterEx("myserver2.com,user2,pwd2;myserver2.com,user3,pwd3,120,,,sipusername3");</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Or via the “<span style='color:#984806'>extraregisteraccounts</span>” parameter which have to be set like this:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> <span style='color: #984806'>server,usr,pwd,…;server2,usr2,pwd2…;</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='color:black;font-style:normal'>Example: </span><span style='color:#984806;font-style:normal'>mysipclient.SetParameter("extraregisteraccounts","myserver2.com,user2,pwd2;myserver2.com,user3,pwd3,120,,,sipusername3");</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Notes:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-Up to 99 secondary accounts can be used this way</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-The ival/registerinterval parameter is optional (default is 3600 which means one hour)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-All other parameters are applied globally for all account (there is no per account profile). The “proxyaddress”, if set, will be applied for primary account only</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-You can use the REGISTER notifications to find out the register state of the separate accounts</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-STATUS about registrations are not reported from secondary accounts (but you will receive call state STATUS notification while in call as normally)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-If you need easier control for the separate accounts then you can also just launch AJVoIP multiple times (multiple instances) with different parameters <br> (Multiple instances per account requires a bit more system resources –some more RAM for each instance- but it might be more convenient for you)</span></p> <p class="MsoNormal"><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370029"></a><a name="_Toc506244132"></a><a name="_Toc427878451"></a><a name="_Toc414335166"></a><a name="_Toc373962589"></a><a name="_Toc373958323"><span style='font-style:normal'>How can I make a call?</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.35in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Make sure that the “serveraddress” parameter is set correctly (otherwise you will be able to make calls only to direct SIP URI).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.35in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Optionally: Register to the server. This can be done automatically if the “username” and “password” parameters are preset. Alternatively you can register from API (Register) or just let the user to fill in the username/password fields and click on the “Connect” button. If AJVoIP is registered, then it can already accept incoming calls (it will do it automatically, or you can handle incoming calls from your application, or you can entirely disable incoming calls)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.35in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Now you can make outgoing calls in the following ways:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.85in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Automatically with AJVoIP start. For this you will have to preset the username, password, autocall and callto parameter. Then AJVoIP will immediately launch the outgoing call when starts (usually with your page load)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.85in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Just let the users to enter a called number and hit the “Call” button </span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.85in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>or just call the </span><a href="start.htm#_boolean_Call(int_line,"><b><span style='font-style:normal'>Call</span></b></a><span style='font-style:normal'> function (from user button click or from your business logic)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Optionally on call you might set the following flags (for example if you have a separate call page activity, then you might set these from onCreate):</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#632423;font-style:normal'>getWindow().addFlags(WindowManager.LayoutParams.FLAG_DISMISS_KEYGUARD);</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#632423;font-style:normal'>getWindow().addFlags(WindowManager.LayoutParams.FLAG_SHOW_WHEN_LOCKED);</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#632423;font-style:normal'>getWindow().addFlags(WindowManager.LayoutParams.FLAG_TURN_SCREEN_ON);</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#632423;font-style:normal'>getWindow().addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON);</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#632423;font-style:normal'>if(Build.VERSION.SDK_INT >= 24) getWindow().setSustainedPerformanceMode(true);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Check </span><a href="start.htm#_Failed_outgoing_calls"><span style='font-style:normal'>this FAQ point</span></a><span style='font-style:normal'> if you are having problems initiating calls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_How_to_handle"></a><span style='font-style:normal'>How to handle incoming calls?</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>To be able to receive incoming calls, make sure that you are </span><a href="start.htm#_How_to_register?"><span style='font-style:normal'>registered</span></a><span style='font-style:normal'> to your SIP server first. Then you can easily test for example by using any third party </span><a href="https://www.mizu-voip.com/Software/Softphones.aspx"><span style='font-style:normal'>softphone</span></a><span style='font-style:normal'> and make calls to your android SIP username (or extension id or full URI, as required by your server).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>In your project all you have to do is to watch for incoming </span><a href="start.htm#_STATUS,line,statustext,peername,loc"><span style='font-style:normal'>ringing STATUS</span></a><span style='font-style: normal'> notifications and from there you can show any user interface (activity) as you wish.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If you follow the </span><a href="start.htm#_Sample_project"><span style='font-style:normal'>example code</span></a><span style='font-style:normal'>, you receive the notifications in the public void ProcessNotifications(String msg) function.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can find the possible strings that can be received at the “</span><a href="start.htm#_Notifications"><span style='font-style:normal'>Notifications</span></a><span style='font-style:normal'>” chapter in the documentation.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>To catch incoming calls, you have to look (string parse) for </span><a href="start.htm#_STATUS,line,statustext,peername,loc"><span style='font-style:normal'>STATUS</span></a><span style='font-style:normal'> messages with “<span style='color:#984806'>Ringing</span>” text (second parameter is the state text) and the <span style='color:#984806'>endpointtype </span>(forth parameter) set to 2 (means incoming).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For example the following status means that there is an incoming call ringing from 2222 on the first line:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>STATUS,1,Ringing,2222,1111,2,Katie,[callid]</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>Example code:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>class MyNotificationListener extends SIPNotificationListener</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>{</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> public void onStatus( SIPNotification.Status e)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> if(e.getStatus() == SIPNotification.Status.STATUS_CALL_RINGING && e.getEndpointType() == SIPNotification.Status.DIRECTION_IN)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> Log.v("\tIncoming call on line "+Integer.toString(e.getLine())+" from "+ e.getPeer());</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> </span><span style='color:gray;font-style:normal'>//mysipclient.Accept(e.getLine()); //auto accepting the incoming call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> } </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>}</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Details about the incoming call can be obtained the </span><a href="start.htm#_STATUS,line,statustext,peername,loc"><span style='font-style:normal'>STATUS</span></a><span style='font-style:normal'> notification itself and/or using any of the following functions:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>GetLineDetails(-1) </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>GetSIPMessage(-1, 0, 1)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>GetLastRecInvite()</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>GetCallerID(-1) </span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>GetIncomingDisplay(-1)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Incoming calls can be also automatically answered as described </span><a href="start.htm#_Auto-answer"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>. Otherwise just use the </span><a href="start.htm#_boolean_Accept(int_line)"><span style='font-style:normal'>Accept</span></a><span style='font-style:normal'> to connect the call (or the </span><a href="start.htm#_boolean_Reject(int_line)"><span style='font-style:normal'>Reject</span></a><span style='font-style:normal'> to disconnect).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>AJVoIP is capable for automatic line management so if you don’t wish to handle lines </span><a href="start.htm#_Multiple_lines"><span style='font-style:normal'>explicitly</span></a><span style='font-style:normal'> in some specific way, then you can ignore all notifications, except those where the line (first parameter) is <span style='color:#984806'>-1 </span>(the global state). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If you wish to auto accept all incoming calls, you can set the </span><a href="start.htm#_autoaccept"><span style='font-style: normal'>autoaccept</span></a><span style='font-style:normal'> parameter to true. Otherwise use the </span><a href="start.htm#_boolean_Accept(int_line)"><b><span style='font-style:normal'>Accept</span></b></a><span style='font-style:normal'> API to connect the call (or the </span><a href="start.htm#_boolean_Reject(int_line)"><span style='font-style:normal'>Reject</span></a><span style='font-style:normal'> API to disconnect). Check the </span><a href="start.htm#_Advanced_Parameters"><span style='font-style:normal'>parameters</span></a><span style='font-style:normal'> to find out more call divert settings, such as auto-answer or forward if needed.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Check </span><a href="start.htm#_AJVoIP_doesn’t_receive"><span style='font-style:normal'>this FAQ point</span></a><span style='font-style:normal'> if you are having problems receiving incoming calls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a name="_Multiple_account_registration"></a><span style='font-style: normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node65" id="node65"></a><span style='font-style:normal'>Project dependency issues</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Check the followings in case if you are unable to build your project because dependency issues.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For example you might receive an error something like this:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Unable to resolve dependency for ':app@debug/compileClasspath': Failed to transform file 'AJVoIP.aar' to match attributes {artifactType=android-exploded-aar} using transform ExtractAarTransform</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This has less to do with our aar and it is a gradle bug.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible solutions:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-style:normal'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'><br> Clean project</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'>Rebuild project</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraph" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-style:normal'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'><br> </span><a href="https://github.com/golang/go/issues/23307"><span style='font-style:normal'>https://github.com/golang/go/issues/23307</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-style:normal'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'><br> </span><a href="https://stackoverflow.com/questions/45138391/failed-to-transform-file-45907c80e09917e1b776adf038505958-to-match-attributes"><span style='font-style:normal'>https://stackoverflow.com/questions/45138391/failed-to-transform-file-45907c80e09917e1b776adf038505958-to-match-attributes</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-style:normal'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'><br> Make sure your machine is connected to the internet.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='font-style:normal'>Go to File -> Settings & expand Build, Execution, Deployment -> Gradle -> UNCHECK Offline work -> OK</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'>Go to File -> click on Invalidate Caches / Restart -> Invalidate & Restart</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraph" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-style:normal'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'><br> Upgrade android studio and tools to latest version</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraph" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-style:normal'>6.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'><br> Just create a new project and add our aar to it and the code from MainActivity.java.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370032"></a><a name="_Toc506244135"></a><a name="_Toc427878455"></a><a name="_Toc414335169"></a><a name="_Toc373962592"></a><a name="_Toc373958326"></a><a name="_Toc373366499"></a><a name="_Toc319361812"></a><a name="_Failed_outgoing_calls"></a><span style='font-style:normal'>Failed outgoing calls</span></h3> </div> <p class="MsoNormal"><span style='font-style:normal'><br> First of all you should check the logs (logcat) to see any ERROR and the SIP signaling.<br> For outgoing call you should see an INVITE sent to server (or peer) and a 2xx response (usually 200 OK) on call connect or other response (4xx, 5xx, 6xxx) on call failure. Some server requires previous successful registration (REGISTER) to allow calls.</span></p> <p class="MsoNormal"><span style='font-style:normal'>Some servers has problems with codec negotiation (requiring re-invite which is not support by some devices). In these situations you might enable only one codec which is supported by your server by setting the codec parameter (for example codec: PCMU).</span></p> <p class="MsoNormal"><span style='font-style:normal'>AJVoIP by default doesn’t allow cross-domain calls. For example if you are registered as </span><a href="mailto:a@A.com"><span style='font-style:normal'>a@A.com</span></a><span style='font-style:normal'> (to A domain) then you will not be able to make direct calls to </span><a href="mailto:b@B.com"><span style='font-style:normal'>b@B.com</span></a><span style='font-style:normal'> (to B domain). Contact mizutech support if you need this use-case to remove the limitation.</span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665625"></a><a name="_Toc489789178"></a><a name="_Toc468095614"></a><a name="_Toc463878965"></a><a name="_Toc463876936"></a><a name="_Toc463876786"></a><a name="_Toc463876580"></a><a name="_Toc455070087"></a><a name="_Toc449776718"></a><a name="_Can’t_connect_to"></a><span style='font-style:normal'>Can’t connect to SIP server</span></h3> </div> <p class="MsoNoSpacing"><span style='font-style:normal'>If the SDK cannot connect or cannot register to your SIP server, you should verify the followings:</span></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>You have set your SIP server address:port correctly</span></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Make sure that you are using a SIP <span style='color:#984806'>username</span>/<span style='color:#984806'>password</span> valid on your SIP server</span></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Make sure that the <span style='color:#984806'>autostart</span> parameter is true and the <span style='color:#984806'>register</span> parameter is 1 or 2. Otherwise use the <span style='color:#984806'>Start()</span> and/or <span style='color:#984806'>Register()</span> functions explicitly.</span></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Make a test from a regular SIP client such as </span><a href="https://www.mizu-voip.com/Software/Softphones/Windowssoftphone.aspx"><span style='font-style:normal'>mizu softphone</span></a><span style='font-style: normal'> or </span><a href="http://www.counterpath.com/x-lite-download/"><span style='font-style:normal'>x-lite</span></a><span style='font-style:normal'> from the same device (if these also doesn’t work, then there is some fundamental problem on your server not related to our library or your device firewall or network connection is too restrictive)</span></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Check if some firewall, NAT or router blocks your device or process or the SIP signaling</span></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Check the </span><a href="start.htm#_How_to_send"><span style='font-style:normal'>logs</span></a></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>If there are no any answer for the REGISTER requests, turn on your server logs and look for the followings:</span></p> <p class="MsoNoSpacing" style='margin-left:.75in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>The REGISTER reaches your server?</span></p> <p class="MsoNoSpacing" style='margin-left:.75in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Is there any response triggered (or some error)?</span></p> <p class="MsoNoSpacing" style='margin-left:.75in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>If answer is triggered, is it sent to the correct address? (it should be sent to the exact same address from where the server received the REGISTER request)</span></p> <p class="MsoNoSpacing" style='margin-left:.75in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>The answer packet reach the client PC? You can use </span><a href="https://www.wireshark.org/"><span style='font-style:normal'>Wireshark</span></a><span style='font-style:normal'> to see the packets at network level.</span></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="mailto:webphone@mizu-voip.com?subject=webphone%20cannot%20register"><span style='font-style:normal'>Send us</span></a><span style='font-style:normal'> a detailed client side log if still doesn’t work with loglevel set to 5 (from the browser console or from softphone skin help menu)</span></p> <p class="MsoNormal"><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370033"></a><a name="_Toc506244136"></a><a name="_Toc427878456"></a><a name="_Toc414335170"></a><a name="_Toc373962593"></a><a name="_Toc373958327"></a><a name="_Toc373366500"></a><a name="_Toc319361813"><span style='font-style:normal'>Calls are disconnecting</span></a></h3> </div> <p class="MsoNormal"><span style='font-style:normal'>If the calls are disconnecting after a few second, then try to set the “invrecordroute” parameter to “true” and the “setfinalcodec” to 0.<br> If the calls are disconnecting at around 100 second, then most probably you are using the demo version which has a 100 second call limit.</span></p> <p class="MsoNormal"><span style='font-style:normal'>See the CDR and the log about the details.</span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node66" id="node66"></a><span style='font-style:normal'>Blank screen or freezing on calls</span></h3> </div> <p class="MsoNormal"><span style='font-style:normal'>Ask for RECORD_AUDIO permission from your app before to make calls.</span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370035"></a><a name="_Toc506244138"></a><a name="_Toc427878458"></a><a name="_Toc414335172"></a><a name="_Toc373962595"></a><a name="_Toc373958329"></a><a name="_Known_limitations"></a><span style='font-style:normal'>Known limitations</span></h3> </div> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>No technical support for Bluetooth related functionality (we provide it “as is” since incompatibility issues might occur due to the high device fragmentation)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>The video module is provided “as-is” with no specific support. Find more details </span><a href="start.htm#_RTC_video"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>AEC is a best effort algorithm and it might not work (or it might work only partially) in some circumstances. There is no any quick fix for underperforming AEC</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>The full STUN specification is not implemented due to size and performance considerations (a fast and light STUN version is used when needed which always outperforms the standard STUN implementations with no drawbacks)<br> <br> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>Please test with the </span><a href="https://www.mizu-voip.com/Portals/0/Files/AJVoIP.zip"><span style='font-style:normal'>demo</span></a><span style='font-style:normal'> version first before to purchase a license, to make sure that it fulfills your requirements and it works correctly in your environment. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc427878462"></a><a name="_Toc414335177"></a><a name="_Toc373962597"></a><a name="_Toc373958331"></a><a name="_Toc373366503"></a><a name="_Toc319361816"></a><a name="_Media_statistics"></a><span style='font-style:normal'>Media statistics</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>Media statistics means RTP/RTCP level details, which can be used to analyze call quality or to display a call quality indicator.</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Basic details: are received with the </span><a href="start.htm#_STATUS,line,statustext,peername,loc"><span style='font-style:normal'>STATUS</span></a><span style='font-style:normal'> notifications such as total rtpsent, rtprec,rtploss, rtplosspercet and server statistics if reported. These and more is also received with the </span><a href="start.htm#_LOG,RTP,txt"><span style='font-style:normal'>RTP</span></a><span style='font-style:normal'> LOG notification.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Quality reports: can be sent as </span><a href="start.htm#_RTPSTAT,quality,sent,rec,issues,los"><span style='font-style:normal'>RTPSTAT</span></a><span style='font-style:normal'> notifications if enabled by the </span><a href="start.htm#_rtpstat"><span style='font-style:normal'>rtpstat</span></a><span style='font-style:normal'> parameter.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-left:.25in'><span style='font-style:normal'>Alternatively it can be requested with the </span><a href="start.htm#_String_RTPStat()"><span style='font-style:normal'>RTPStat</span></a><span style='font-style:normal'> function call.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Logs: You can also see more details in the logs such as total rtp statistics reports for calls longer then 7 seconds if the loglevel is at least 3 as <span style='color:#548DD4'>EVENT, rtp stat: sent X rec X loss X X%</span> or the </span><a href="start.htm#_LOG,RTP,txt"><span style='font-style:normal'>RTP</span></a><span style='font-style:normal'> notification. If you set the “loglevel” parameter to at least “5” than the important rtp and media related events are also stored in the logs. You might search for “call details” at the log which also includes media related reports after each call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Voice_activity_detection_1"></a><span style='font-size:12.0pt;font-style:normal'>Voice activity detection</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>AJVoIP has built-in VAD (voice activity detection) algorithm included.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The talking/silence state of both the local user and the remote peer can be reported.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>To enable VAD reports, set the </span><a href="start.htm#_vad"><span style='line-height:120%;font-style:normal'>vad</span></a><span style='line-height:120%;font-style:normal'> parameter to 4.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Once this is set, you can receive the VAD state either by calling the </span><a href="start.htm#_String_VAD()"><span style='line-height:120%;font-style:normal'>VAD function</span></a><span style='line-height:120%;font-style:normal'> or by the </span><a href="start.htm#_VAD,parameters"><span style='line-height:120%;font-style:normal'>VAD notifications</span></a><span style='line-height:120%;font-style:normal'> if the vadstat parameter is set to 3 or 4.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>For the notifications interval you might also adjust the vadstat_ival parameter after your needs (default is 3000 in milliseconds, which means a VAD report in every 3 seconds). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>If the vadstat is set to 4 then it will report the state also when changed from silence to speaking or inverse.</span></p> <p class="MsoNoSpacing"><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc506370038"></a><a name="_Toc506244141"></a><a name="_Toc427878463"></a><a name="_Toc414335178"></a><a name="_Toc373962598"></a><a name="_Toc373958332"></a><a name="_Toc373366504"></a><a name="_Toc319361817"></a><a name="_Toc255049871"><span style='font-style:normal'>NAT settings</span></a></h3> </div> <p class="MsoNormal"><span style='font-size:9.0pt;line-height:120%'>In the SIP protocol the client endpoints have to send their (correct) address in the SIP signaling, however in many situations the client is not able to detect it’s correct public IP (or even the correct private local IP). This is a common problem in the SIP protocol which occurs with clients behind NAT devices (behind routers). The clients have to set its IP address in the following SIP headers: contact, via, SDP connect (used for RTP media). A well written VoIP server should be able to easily handle this situation, but a lot of widely used VoIP server fails in correct NAT detection. RTP routing or offload should be also determined based in this factor (servers should be always route the media between 2 nat-ed endpoint and when at least one endpoint is on public IP than the server should offload the media routing). This is just a short description. The actual implementation might be more complicated.<br> <br> </span></p> <p class="MsoNormal"><span style='font-style:normal'>You may have to change Java VoIP toolkit configuration according to your SIP server if you have any problems with devices behind NAT (router, firewall).<br> If your server has NAT support then set the use_fast_stun and use_rport parameters to 0 and you should not have any problem with the signaling and media for AJVoIP behind NAT. If your server doesn’t have NAT support then you should set these settings to 2. In this case AJVoIP will always try to discover its external network address. </span></p> <p class="MsoNormal"><span style='font-style:normal'>Example configurations:<br> If your server can work only with public IP sent in the signaling:<br> -use_rport 2 or 3<br> -use_fast_stun: 1 or 2 or 4 (recommended is 2)<br> <br> If your server can work fine with private IP’s in signaling (but not when a wrong public IP is sent in signaling):<br> -use_rport 9<br> -use_ fast_stun: 0<br> -optionally you can also set the “udpconnect” parameter to 1<br> <br> Asterisk is well known about its bad default NAT handling. Instead of detecting the client capabilities automatically it relies on pre-configurations. You should set the "nat" option to "yes" for all peers.<br> More details:<br> </span><a href="http://www.voip-info.org/wiki/view/NAT+and+VOIP"><span style='font-style:normal'>http://www.voip-info.org/wiki/view/NAT+and+VOIP</span></a><span style='font-style:normal'><br> </span><a href="http://www.voip-info.org/wiki/view/Asterisk+sip+nat"><span style='font-style:normal'>http://www.voip-info.org/wiki/view/Asterisk+sip+nat</span></a><span style='font-style:normal'><br> </span><a href="http://www.asteriskguru.com/tutorials/sip_nat_oneway_or_no_
