Release Notes for CounterPath Softphone SDK Version 1.5

Transcription

1 CunterPath Crpratin Suite 300, One Bentall Centre 505 Burrard Street, Bx 95 Vancuver, BC V7X 1M3 Canada Telephne: Release Ntes fr CunterPath Sftphne SDK Versin 1.5 June 23, 2016 R7

2 Release Ntes CunterPath Sftphne SDK 1.5 The CunterPath Sftphne SDK 1.5 Release Ntes prvide infrmatin fr all 1.5.x releases: SDK (June 23, 2016) - ios nly SDK (April 26, 2016) SDK (Feb 04, 2016) SDK (Nv 18, 2015) SDK (Sept 10, 2015) SDK 1.5 (Aug 10, 2015) SDK Platfrms The release ntes prvide infrmatin fr all f the fllwing platfrms: Java fr Andrid Objective-C fr ios and OS X.NET fr Windws Java fr Windws Mac If the issue is platfrm specific, the platfrm is identified fr the items listed in the fllwing sectins. Page CunterPath Crpratin

3 Release Ntes CunterPath Sftphne SDK SDK (June 23, 2016) This release includes updates t the ios SDK nly. N changes made in ther platfrms. 1.1 ios Specific Changes Aut Discvery f IP Versin This release adds supprt fr autmatically discvering an IP versin t use. The SDK nw prvides the ability t specify new enum value f IpVersin_Aut fr SipAccuntSettings ipversin setting, which will cause the SDK t attempt aut detectin f which IP versin (IPv4 r IPv6) shuld be used. As part f IP versin aut detectin, the SDK will cnsider netwrk interfaces available, DNS respnses, and cnnectin attempt results. In rder t cmply with June 1, 2016 App Stre submissin requirements by Apple, ios applicatins using this SDK shuld set ipversin t IpVersin_Aut. An example f this can be seen in the ios Advanced Audi Call sample, which is included with the ios SDK package. Als nte that an IPv6-capable SIP server is required fr SIP cnnectivity with this SDK if an ios device cnnects t an IPv6-nly WiFi r WWAN netwrk. An ios device cnnected t an IPv6-nly netwrk may be part f Apple App Stre submissin testing, s ensure any test accunts yu give t Apple fr App Stre submissin testing have supprt fr an IPv4 and IPv6 SIP server. Further, devices running ios 9 may in the near future begin cnnecting t IPv6-nly LTE netwrks, which will require an IPv6-capable SIP server. NAT64 is nt supprted by the SDK at this time. As a result, cnnecting t an IPv4 SIP server frm an IPv6 netwrk with NAT64 is nt supprted. Open SSL Updated t use OpenSSL 1.0.1t. Vide Imprvements There have been imprvements in vide quality and perfrmance. 1.2 Reslved Issues Fixed a defect where playing a sund clip des nt wrk when the default device is selected. Varius stability imprvements and bug fixes. 1.3 Knwn Issues Refer t sectin 5.3 fr details. Page CunterPath Crpratin

4 Release Ntes CunterPath Sftphne SDK SDK (April 26, 2016) 2.1 Changes The fllwing changes apply t all platfrms. Added supprt fr TLS 1.2 fr SIP. The SDK nw supprts the ability t establish TLS 1.2 cnnectins fr SIP. Applicatins can: set the requested TLS level by adjusting the sslversin member f the SipAccuntSettings struct. als nte which TLS versin was negtiated by examining the SipTLSCnnectinInf struct returned in SipAccuntStatusChangedEvent. Fr examples, please refer t the Advanced audi call sample applicatin n ios, OS X, Andrid r.net Windws SDK. Updated t use OpenSSL 1.0.1s. The minimum requirements have been updated. Refer t the respective Develper Guides fr details. 2.2 Desktp Specific Changes The fllwing changes apply t Desktp platfrms (Windws and Mac). Added the ability t have the SDK use the default system device. The SDK nw ffers the ability t use the default audi device cnfigured in the hst perating system. Fr usage, please see the in-line cmments fr kaudidefaultsystemdeviceid and kaudidefaultsystemcmmdeviceid. Fr examples, please refer t the Advanced audi call sample applicatin bundled with the OS X r.net Windws SDK. Intrduced a new flag named defaultsystemdevice, which identifies whether a device is the system default. Intrduced a new flag named inadvisable n the AudiDeviceInf struct, which identifies audi devices that are nt recmmended t be used (fr example, a virtual audi device), especially as a device autmatically chsen by the applicatin. 2.3 Windws Specific Changes Added the ability t have the SDK use the default cmmunicatin device. The SDK nw ffers the ability t use the default audi device cnfigured in the hst perating system. Fr usage, please see the in-line cmments fr kaudidefaultsystemdeviceid and kaudidefaultsystemcmmdeviceid. Fr examples, please refer t the Advanced audi call sample applicatin bundled with the OS X r.net Windws SDK. Intrduced a new flag named defaultsystemcmmdevice, which identifies whether a device is the default cmmunicatin device. Page CunterPath Crpratin

5 Release Ntes CunterPath Sftphne SDK Andrid Specific Changes Added supprt fr the Andrid M permissin mdel. The SDK expses a new handler class called PermissinsHandler. Apps can implement this handler and receive ntificatins frm the SDK when permissin is required frm the user t access a particular resurce (fr example, the micrphne). Added SRTP supprt in the Andrid Advanced audi call sample app, t demnstrate hw t establish encrypted calls. 2.5 Reslved Issues Varius stability imprvements and bug fixes. 2.6 Knwn Issues Refer t sectin 5.3 fr details. Page CunterPath Crpratin

6 Release Ntes CunterPath Sftphne SDK SDK (Feb 04, 2016) 3.1 Reslved Issues Fixed the audi quality issue n Nexus 6P devices. Fixed an issue n Andrid where the SDK wuld release the active Bluetth audi device if the VIP call ended but a native call was still active. Fixed a DNS-related crash issue. Varius stability imprvements. 3.2 Changes Imprved ech cancellatin n Windws platfrms. Imprved reliability when sending a file using SDK s XMPP file transfer API. Imprved bitrate estimatin fr VP8 vide calls. Remved IPv4 specific functins frm all cde cmpiled n ios, in preparatin fr Apple s plicy change planned fr 2016 mandating supprt fr IPv6. Remved supprt fr 32-bit versin f OS X SDK. Added the ability t inspect the value f custm headers in incming INVITE messages. Added a Cnversatin Call Quality indicatr: Gd Fair Pr Unknwn See page 15 f the CunterPath Sftphne SDK Reference Guide fr details. Added a sectin in the CunterPath Sftphne SDK Andrid Develper Guide, recmmending the use f fallback dmain name servers. (See Fallback Dmain Name Servers n page 19, revisin 6 f the guide.) 3.3 Knwn Issues Refer t sectin 5.3 fr details. Page CunterPath Crpratin

7 Release Ntes CunterPath Sftphne SDK SDK (Nv 18, 2015) 4.1 Reslved Issues Fixed an issue where calling the destry methd n SipAccunt in the Andrid SDK might cause a crash. Fixed crashes with the playsund(..) methd n Andrid. Fixed fr n audi during calls if accunt registered with useregistar setting ff. Fixed AudiStatistics.averageJitterMs always having a value f 0. When VAD is enabled, and there is n vice, the SDK will nw frce send a few RTP packets at the start f a call, instead f sending RTP keep-alives. Reduced memry usage during VP8 vide calls (ntably fr mbile SDKs). Imprvements in H.264 interperability. Varius stability imprvements. 4.2 Changes Added supprt fr certificate pinning. See the Certificate Pinning sectin. Additin f GSM cdec. Full IPv6 supprt. Supprt fr applicatins targeting Andrid API level 23 (Marshmallw). Updated all Andrid samples t target API level 23. Added cnversatin end reasn f CnversatinEndReasn_CallAnsweredElsewhere. Perfrmance enhancements fr accunt initializatin. Added the ability t specify custm RTP paylad types. Updated t OpenSSL 1.0.1p. Page CunterPath Crpratin

8 Release Ntes CunterPath Sftphne SDK Certificate Pinning CunterPath has expsed the necessary interfaces t allw applicatins t implement certificate pinning fr SIP ver TLS r XMPP. Pinning is a prcess that assciates a hst with their expected X509 certificate r public key. In the accunt settings class fr either SIP r XMPP, tw new entries have been added: acceptedcertpublickeys and requiredcertpublickeys. The in-line cmments in the API describe hw these entries are used by the SDK. The tw mdes are using: acceptedcertpublickeys s any certificate presented t yu is accepted as lng as the public key that is set in the settings f the SDK matches. The SDK will accept it, even if it is unsigned, fr example. acceptedcertpublickeys prvides flexibility in dealing with certificate issues. requiredcertpublickeys which prvide the benefit f extra security. 4.4 Knwn Issues Refer t sectin 5.3 fr details. Page CunterPath Crpratin

9 Release Ntes CunterPath Sftphne SDK SDK (Sept 10, 2015) 5.1 Reslved Issues Imprvements in H.264 vide quality fr all platfrms. Fixed an issue fr all platfrms that culd result in utging packet lss fr RTP, the real-time transprt prtcl. Fixed issues fr Andrid Bluetth. Fixed crashes n Andrid devices with Intel chipsets: Dell Venue 8 and Samsung Galaxy Tab 3, Fixed an issue n Windws and Mac where audi culd be lst fr an active call if a headset was unplugged and then plugged back in. Varius stability imprvements fr all platfrms. 5.2 Changes Supprt fr H.264 packetizatin mde 1 fr all platfrms. NACK supprt (RFC 4585) fr vide fr all platfrms. 5.3 Knwn Issues ios Fr ios, the 64-bit simulatr is nt supprted yet (x86_64 architecture is nt supprted yet). Andrid The CunterPath SDK prvides basic Andrid Bluetth supprt nly, and is nt expected t wrk with all Andrid devices. CunterPath has tested Bluetth against Jawbne ERA and Jabra EasyG. Fr this reasn, custmers are advised t test Bluetth capabilities fr every Andrid device/bluetth device pairing. Andrid s Bluetth system underges frequent changes that may create new issues when upgrading a device. Devices als ship their wn Bluetth hardware driver (and smetimes Bluetth stacks) that can cause issues. Althugh Bluetth supprt is generic and shuld wrk with any Andrid phne and Bluetth headset cmbinatin, CunterPath has nly tested a small set f pssible device pairings. Basic features are supprted, such as incming/utging calls and switching t/frm Bluetth headset t speaker/earpieces. Advanced features, such as switching between multiple Bluetth devices, aren t supprted in the SDK, and must be dne in the app r using the system settings UI. T enable Bluetth, the permissin "andrid.permissin.bluetooth" must be added t the app s manifest. In additin, devices running Andrid 4.0 r 4.1 require the permissin "andrid.permissin.broadcast_sticky". Attempting t use a Bluetth device n the Samsung Galaxy S2 may cause the audi driver t freeze. A device rebt may be required befre the audi hardware can be used again. Please reprt any issues yu encunter. Page CunterPath Crpratin

10 Release Ntes CunterPath Sftphne SDK SDK 1.5 (Aug 10, 2015) 6.1 Reslved Issues Imprvements have been made in ech cancellatin fr Andrid SIP calls. Fixed VP8 vide cdec crashes n varius Andrid devices. Fixed an issue where, when registering against sme Avaya IP ffice systems r Cisc CUCM systems with rprt enabled in the SDK, calls culd nt be received by the SDK. Varius stability imprvements 6.2 Changes Licensing callback n lnger ccur n the accunt interface. Instead, SDK applicatins must listen t events n PhneErrrHandler. Fr the C++ editin SDK, and.net editin SDK, the applicatin must call prcess(..) n the Phne interface. New XMPP functinality has been expsed in the SDK. Please refer t the SDK Reference Guide fr example diagrams. Additinally, there are sample clients n all platfrms that demnstrate these new features. + XMPP file transfer + XMPP multi user chat + XMPP Vcard Additin f supprt fr Vice Quality Mnitring metrics Additin f HTML API dcuments fr the C# SDK Supprt fr HD reslutin VP8 vide n mbile platfrms Adaptive bitrate supprt fr the OPUS audi cdec Additin f VP9 vide cdec supprt n desktp platfrms Minimum versin supprted fr Andrid SDK is nw Andrid 4.1 (Jelly Bean, API level 16) Andrid Bluetth supprt in the SDK is experimental. Please see the 0sectin fr mre infrmatin. 6.3 Windws Specific Changes The SDK nw requires the Visual C redistributable package t be installed fr runtime. The Visual C redistributable package is n lnger required. 6.4 Andrid Specific Changes The SDK n lnger ffers a chice between using AudiTrack/JNI and OpenSL fr the active audi layer. As such, setting MediaStackSettings t use OpenSL r AndridJni is deprecated and has n effect. Page CunterPath Crpratin

11 Release Ntes CunterPath Sftphne SDK 1.5 Adjusting media stack settings t set the audi surce r use lw latency mde has been deprecated; use SipAudiAndrid's setaudisurce(..) and setlwlatencyaudiplayutbydevice(..) respectively. setechcancellatinmde(..) n SipAudi des nt need t be called; by default, the SDK will attempt t use the device's built in hardware AEC if available; therwise it will fall back t a sftware AEC implementatin. A new methd n SipAudiAndrid has been added, sethardwareechcancellatinbydevice(..), which allws frce disabling f hardware based AEC, and use f sftware based AEC instead. This methd can be used t disable hardware AEC n devices where testing has shwn that sftware AEC perfrms better Andrid Bluetth supprt in the SDK is experimental. Andrid's Bluetth system underges frequent changes which may create new issues when upgrading a device. Devices als ship their wn Bluetth hardware driver (and smetimes Bluetth stacks) which can cause issues. Althugh Bluetth supprt is generic and shuld wrk with any Andrid phne and Bluetth headset cmbinatin, we have nly tested a small set f pssible devices. Basic features such as incming/utging calls and switching t/frm Bluetth headset t speaker/earpiece are supprt while advanced features such as switching between multiple Bluetth devices isn't supprted in the SDK and must be dne in app r using the system settings UI. Please reprt any issues yu encunter. T enable Bluetth, the permissin "andrid.permissin.bluetooth" must be added t the app's manifest. In additin, devices running Andrid 4.0 r 4.1 require the permissin "andrid.permissin.broadcast_sticky". Attempting t use a Bluetth device n the Samsung Galaxy S2 may cause the audi driver t freeze. A device rebt may be required befre the audi hardware can be used again. 6.5 Knwn Issues Fr ios, the 64-bit simulatr is nt supprted yet (x86_64 architecture is nt yet supprted). Page CunterPath Crpratin