Release notes for CounterPath Softphone SDK

These release notes apply to all of the following platforms:

Android
iOS
Linux
Mac
Windows - .NET and C++
Windows - Java
Xamarin

SDK 1.15.3 (October 31, 2022)

iOS

Support for building apps against iOS 16 SDK.
Official support for running SDK on iOS 16.
- Fixed an issue with intermittent garbled audio with Bluetooth devices on iOS 16.

Android

Support for building apps against Android 13 SDK.
- Fixed an issue where apps building against Android 13 and not declaring WRITE_EXTERNAL_STORAGE permission in manifest could result in SDK failing to write files for audio call recording and XMPP file transfer.
Official support for running SDK on Android 13.

SDK 1.15.2 (September 9, 2022)

Preliminary support for building apps against iOS 16 beta SDK.
Fixed a crash when setting up TCP sockets for legacy VoIP usage.

SDK 1.15.1 (August 12, 2022)

Added the ability to use non-standard SIP ports when SDK registers via A/AAAA records and the app specifies no port (via new SipAccountSettings items: defaultSipPort, defaultSipsPort).

SDK 1.15.0 (July 15, 2022)

This version includes updates to all platforms except for Xamarin.

Changes

Dropped support for Android 6 and 7.
Dropped support for iOS 13.
Dropped support for AMR-WB on Android and macOS.
Windows: Switched build to use VS2019 toolchain.

Apps are now required to deploy Visual C++ 2019 or newer redistributable.
Windows: Switched .NET SDK to build with .net 4.8.

.net 4.8 must be available at app runtime.

New features and improvements

Preliminary support for Android 13.

Please note this only includes support for apps running on Android 13, not apps built against it. Previous SDK versions do not support Android 13; make sure to upgrade to SDK 1.15 if your app needs to run on Android 13.
Reduced network change handling delay on Android (allows for quicker re-INVITE based call handover on network changes)
Software-based echo canceller improvements
Support playing out speakerphone audio in stereo on M1-based MacBooks (as opposed to left only to avoid speakerphone echo issues)
iOS: Added support for arm64 simulator
macOS: Added preliminary native support for arm64 architecture ("Apple Silicon")

For a more detailed list of changes in this version, see Change log: SDK version 1.15.0.

Known issues

Please report any issues you encounter.

SDK 1.15.0 is not currently available for Xamarin; support will arrive in a later patch release.

For iOS apps produced using the Xamarin framework, an issue exists where pressing the lock button causes the Visual Studio debugger to disconnect, and the phone becomes unresponsive. No workaround is known. See the forums at xamarin.com (here and here) for other examples of this issue.

For Android:
- The CounterPath SDK provides basic Android Bluetooth® support only, and is not expected to work with all Android devices. CounterPath has tested Bluetooth against Jawbone ERA and Jabra EasyGo. For this reason, customers are advised to test Bluetooth capabilities for every Android device/Bluetooth device pairing.
  
  Android’s Bluetooth system undergoes frequent changes that may create new issues when upgrading a device. Devices also ship their own Bluetooth hardware driver (and sometimes Bluetooth stacks) that can cause issues. Although Bluetooth support is generic and should work with any Android phone and Bluetooth headset combination, CounterPath has only tested a small set of possible device pairings. Basic features are supported, such as incoming/outgoing calls and switching to/from Bluetooth headset to speaker/earpieces. Advanced features, such as switching between multiple Bluetooth devices, aren’t supported in the SDK, and must be done in the app or using the system settings UI.
- To enable Bluetooth, the permission android.permission.BLUETOOTH must be added to the app’s manifest. In addition, devices running Android 4.0 or 4.1 require the permission android.permission.BROADCAST_STICKY.
- Attempting to use a Bluetooth device on the Samsung Galaxy S2 may cause the audio driver to freeze. A device reboot may be required before the audio hardware can be used again.

SDK 1.14.4 (March 17, 2022)

Fixed a defect introduced in SDK 1.14.0 where higher than normal battery usage would be consumed on devices running Android 12, especially when an application running the SDK is placed in the background.

SDK 1.14.3 (February 24, 2022)

Fixed an issue where RTP timestamp starting values were not random.

SDK 1.14.2 (February 8, 2022)

Fixed an issue on iOS where incoming calls via push notification may have no audio.

SDK 1.14.1 (January 24, 2022)

SDK 1.14.0 (December 8, 2021)

This version includes updates to all platforms.

Resolved issues

Fixed brief echo introduced after un-muting.
Fixed microphone capture failing on Windows devices with 4 channel microphones.
Fixed an intermittent crash with voice quality monitoring SDKs when packet loss was experienced near call end.
Fixed an issue with devices with computer names containing special characters. Now these devices can communicate with the license server.
Fixed excessive logging when invoking queryDeviceVolume.
Fixed the incorrect Windows DLL file version information.
Fixed an issue with Bluetooth headsets on Android 12 when the app is installed after Bluetooth headsets are paired and connected to the device.
The previous version, SDK 1.13.2, had an issue for Android 12 support, which has been solved. See below for details.
When video calling on Android Pixel 4, the local video feed appeared black and white to the remote party. This issue has been solved and reflected in the Android video sample code.

For a more detailed list of changes in this version, see Change log: SDK version 1.14.0.

Known issues

Please report any issues you encounter.

For iOS apps produced using the Xamarin framework, an issue exists where pressing the lock button causes the Visual Studio debugger to disconnect, and the phone becomes unresponsive. No workaround is known. See the forums at xamarin.com (here and here) for other examples of this issue.

For Android:
- The CounterPath SDK provides basic Android Bluetooth® support only, and is not expected to work with all Android devices. CounterPath has tested Bluetooth against Jawbone ERA and Jabra EasyGo. For this reason, customers are advised to test Bluetooth capabilities for every Android device/Bluetooth device pairing.
  
  Android’s Bluetooth system undergoes frequent changes that may create new issues when upgrading a device. Devices also ship their own Bluetooth hardware driver (and sometimes Bluetooth stacks) that can cause issues. Although Bluetooth support is generic and should work with any Android phone and Bluetooth headset combination, CounterPath has only tested a small set of possible device pairings. Basic features are supported, such as incoming/outgoing calls and switching to/from Bluetooth headset to speaker/earpieces. Advanced features, such as switching between multiple Bluetooth devices, aren’t supported in the SDK, and must be done in the app or using the system settings UI.
- To enable Bluetooth, the permission android.permission.BLUETOOTH must be added to the app’s manifest. In addition, devices running Android 4.0 or 4.1 require the permission android.permission.BROADCAST_STICKY.
- Attempting to use a Bluetooth device on the Samsung Galaxy S2 may cause the audio driver to freeze. A device reboot may be required before the audio hardware can be used again.

SDK 1.13.2 (August 23, 2021)

This version includes updates to: iOS, Android, Mac, and Xamarin.

SDK 1.13.0 (March 3, 2021)

This version includes updates to all platforms.

For runtime environment, Android 5.0 is no longer supported.

New features and improvements

Improved software-based echo canceller.
Support for 480p widescreen upstream video resolution. Applies to all platforms except Linux.
Support for AES GCM cipher suites for SRTP calls; enabled by default
Improved SDK to avoid re-using unresponsive DNS servers repeatedly during setup of SIP account and SIP call
re-INVITE due to network change will now fully release old RTP ports used from previous INVITE.
Adjusted so that the SDK does not send DTX with Opus if far side does not include the usedtx SDP parameter. Helpful for turning Opus DTX off on FreeSwitch for improved audio quality.
Windows: Improved Windows Core audio support, to fall back to legacy Wave audio backend less often. It provides better support for 4 channel microphones.
macOS and iOS: Fixed a potential issue with call quality on locally-mixed conferences.
iOS: Adjusted SDK so that calling setCallKitMode multiple times less likely causes an issue with audio.

For a more detailed list of changes in this version, see Change log: SDK version 1.13.0.

Known issues

SDK 1.12 and 1.13 have a known issue with the Android platform. When video calling on Android Pixel 4, the local video feed appears black and white to the remote party. We are working toward fixing this issue soon.

Please report any issues you encounter.

For iOS apps produced using the Xamarin framework, an issue exists where pressing the lock button causes the Visual Studio debugger to disconnect, and the phone becomes unresponsive. No workaround is known. See the forums at xamarin.com (here and here) for other examples of this issue.

For Android:
- The CounterPath SDK provides basic Android Bluetooth® support only, and is not expected to work with all Android devices. CounterPath has tested Bluetooth against Jawbone ERA and Jabra EasyGo. For this reason, customers are advised to test Bluetooth capabilities for every Android device/Bluetooth device pairing.
  
  Android’s Bluetooth system undergoes frequent changes that may create new issues when upgrading a device. Devices also ship their own Bluetooth hardware driver (and sometimes Bluetooth stacks) that can cause issues. Although Bluetooth support is generic and should work with any Android phone and Bluetooth headset combination, CounterPath has only tested a small set of possible device pairings. Basic features are supported, such as incoming/outgoing calls and switching to/from Bluetooth headset to speaker/earpieces. Advanced features, such as switching between multiple Bluetooth devices, aren’t supported in the SDK, and must be done in the app or using the system settings UI.
- To enable Bluetooth, the permission android.permission.BLUETOOTH must be added to the app’s manifest. In addition, devices running Android 4.0 or 4.1 require the permission android.permission.BROADCAST_STICKY.
- Attempting to use a Bluetooth device on the Samsung Galaxy S2 may cause the audio driver to freeze. A device reboot may be required before the audio hardware can be used again.

SDK 1.12.2 (January 14, 2021)

Added support for SDK bundled as an xcframework. Switch from CPCAPI2.framework to CPCAPI2.xcframework to avoid errors when building your app with Xcode 12.3 and above. (O-5678)

SDK 1.12.1 (December 3, 2020)

Added ability to enable both QoS and Fastlane RTP tagging on iOS via new setVideoUseQosFastlane:useWithDscp: method on CPCAudio, CPCVideo interface. (O-5595)
Fixed an issue where the SDK would get into a non-stop re-INVITE and re-REGISTER loop when connection to the primary SIP server is lost, a call is active, and the secondary SIP server is reachable. (O-5627)

SDK 1.12.0 (October 28, 2020)

This version includes updates to all platforms.

What's new

Windows 64-bit support

The CounterPath Windows SDK supports both x86 and x64 CPU architectures. Note that 64-bit support is experimental at this point. For details, see .NET: 64-bit / x64 architecture.

The 64-bit Windows SDK binaries do not support the AMR-WB codec. Please contact CounterPath if you require the support.
Deprecating Windows Java

The version 1.12 will be the last SDK release for Windows Java. 64-bit is not supported for the Windows Java SDK. Windows Java samples are included in the version 1.12 but it is 32-bit only.
Support for maxplaybackrate Opus SDP parameter

For FreeSwitch interoperability: Since FreeSwitch supports FEC at wideband Opus and below, having FreeSwitch advertise an appropriate maxplaybackrate will allow the SDK to limit its Opus encoding sample rate, and FreeSwitch to use FEC.
Desktop supports recording call participants individually; new flag added to audioRecorderCreate method of RecordingManager module .
Android SDK: Support for accessing files via Storage Access Framework for SDK’s playSound(..) method, XMPP file transfer, and call recording .

Known issues

Please report any issues you encounter.

For iOS apps produced using the Xamarin framework, an issue exists where pressing the lock button causes the Visual Studio debugger to disconnect, and the phone becomes unresponsive. No workaround is known. See the forums at xamarin.com (here and here) for other examples of this issue.

For Android:
- The CounterPath SDK provides basic Android Bluetooth® support only, and is not expected to work with all Android devices. CounterPath has tested Bluetooth against Jawbone ERA and Jabra EasyGo. For this reason, customers are advised to test Bluetooth capabilities for every Android device/Bluetooth device pairing.
  
  Android’s Bluetooth system undergoes frequent changes that may create new issues when upgrading a device. Devices also ship their own Bluetooth hardware driver (and sometimes Bluetooth stacks) that can cause issues. Although Bluetooth support is generic and should work with any Android phone and Bluetooth headset combination, CounterPath has only tested a small set of possible device pairings. Basic features are supported, such as incoming/outgoing calls and switching to/from Bluetooth headset to speaker/earpieces. Advanced features, such as switching between multiple Bluetooth devices, aren’t supported in the SDK, and must be done in the app or using the system settings UI.
- To enable Bluetooth, the permission android.permission.BLUETOOTH must be added to the app’s manifest. In addition, devices running Android 4.0 or 4.1 require the permission android.permission.BROADCAST_STICKY.
- Attempting to use a Bluetooth device on the Samsung Galaxy S2 may cause the audio driver to freeze. A device reboot may be required before the audio hardware can be used again.

SDK 1.11.1 (June 30, 2020)

This security patch is available for all platforms: Windows, MacOS, iOS, Android, Linux and Xamarin.

A third party component of VoIP, libcurl, has released a patch for CVE-2020-8169, partial password leak over DNS on HTTP redirect, that this incorporates. Customers are recommended to request an update to their SDK in the CounterPath Technical Assistance Centre (TAC).

SDK 1.11.0 (April 30, 2020)

This version includes updates to the following platforms:

Android - note that this version requires Android 6.0 (API 23) and above for the runtime environment.
iOS

Known issues

Please report any issues you encounter.

For iOS apps produced using the Xamarin framework, an issue exists where pressing the lock button causes the Visual Studio debugger to disconnect, and the phone becomes unresponsive. No workaround is known. See the forums at xamarin.com (here and here) for other examples of this issue.

For Android:
- The CounterPath SDK provides basic Android Bluetooth® support only, and is not expected to work with all Android devices. CounterPath has tested Bluetooth against Jawbone ERA and Jabra EasyGo. For this reason, customers are advised to test Bluetooth capabilities for every Android device/Bluetooth device pairing.
  
  Android’s Bluetooth system undergoes frequent changes that may create new issues when upgrading a device. Devices also ship their own Bluetooth hardware driver (and sometimes Bluetooth stacks) that can cause issues. Although Bluetooth support is generic and should work with any Android phone and Bluetooth headset combination, CounterPath has only tested a small set of possible device pairings. Basic features are supported, such as incoming/outgoing calls and switching to/from Bluetooth headset to speaker/earpieces. Advanced features, such as switching between multiple Bluetooth devices, aren’t supported in the SDK, and must be done in the app or using the system settings UI.
- To enable Bluetooth, the permission android.permission.BLUETOOTH must be added to the app’s manifest. In addition, devices running Android 4.0 or 4.1 require the permission android.permission.BROADCAST_STICKY.
- Attempting to use a Bluetooth device on the Samsung Galaxy S2 may cause the audio driver to freeze. A device reboot may be required before the audio hardware can be used again.

SDK 1.10.0 (December 10, 2019)

This version includes updates to all platforms.

Known issues

Please report any issues you encounter.

Calls from an iOS device using G729 to another endpoint that supports G729 annexB might result in poor quality audio as heard on the iOS device. This can be mitigated by disabling G729 on the iOS device, via the CPCAudio interface:
```
CPCG729Config* g729Config = [CPCG729Config new];
g729Config.useAnnexB = NO;
[[CPCAudio getInterface:cpcMediaManager] setCodecConfig:g729Config];
```
For iOS apps produced using the Xamarin framework, an issue exists where pressing the lock button causes the Visual Studio debugger to disconnect, and the phone becomes unresponsive. No workaround is known. See the forums at xamarin.com (here and here) for other examples of this issue.

For Android:
- The CounterPath SDK provides basic Android Bluetooth® support only, and is not expected to work with all Android devices. CounterPath has tested Bluetooth against Jawbone ERA and Jabra EasyGo. For this reason, customers are advised to test Bluetooth capabilities for every Android device/Bluetooth device pairing.
  
  Android’s Bluetooth system undergoes frequent changes that may create new issues when upgrading a device. Devices also ship their own Bluetooth hardware driver (and sometimes Bluetooth stacks) that can cause issues. Although Bluetooth support is generic and should work with any Android phone and Bluetooth headset combination, CounterPath has only tested a small set of possible device pairings. Basic features are supported, such as incoming/outgoing calls and switching to/from Bluetooth headset to speaker/earpieces. Advanced features, such as switching between multiple Bluetooth devices, aren’t supported in the SDK, and must be done in the app or using the system settings UI.
- To enable Bluetooth, the permission android.permission.BLUETOOTH must be added to the app’s manifest. In addition, devices running Android 4.0 or 4.1 require the permission android.permission.BROADCAST_STICKY.
- Attempting to use a Bluetooth device on the Samsung Galaxy S2 may cause the audio driver to freeze. A device reboot may be required before the audio hardware can be used again.

SDK 1.9.0 (June 17, 2019)

This version includes updates to all platforms except for Xamarin. If you are interested in Xamarin, contact CounterPath for updates.

Resolved issues

Fixed Xcode static analyzer warnings related to umbrella header not including various header files.
Fix for CallQuality report module sending truncated Call-IDs.
Exclusion of remote metrics in session and interval call quality reports, if the SDK had not received any such reports, rather than sending zero'd out metrics. For interval reports, exclusion of remote metrics if those metrics were already reported in a previous interval report.
Fixed Xcode static analyzer warnings related to umbrella header not including various header files.
Suppress irrelevant GetPlayouDeviceHid() errors seen on non-windows platform.
Limited support for DNS over TLS on Android; disabled by default. SRV record lookups are not supported. This may disrupt existing SIP environments. These environments would need to change to only rely on A/AAAA records if DNS over TLS is enabled in the SDK. Can be enabled via useAndroidResolverForPrivateDns options in SipPhoneAndroidCtorOptions.
Various stability improvements.

For a more detailed list of changes in this version, see Change log: SDK version 1.9.0.

SDK 1.8.0 (December 24, 2018)

This version includes updates to all platforms except for Xamarin.

Resolved issues

Fixed an issue where if session timers are enabled for a call, disconnecting the network cable on one side of the call would eventually not result in both sides of the call ending.
Fixed a crash while calling CPCStrettoUemManager’s close method.
Fixed an issue where MOS of 2.4 would be reported by SDK if a wideband codec call was placed followed by a narrowband codec call, even though call quality was high.
Fixed an issue on Android where AudioTrack instances would leak if playSound/stopPlaySound was called in quick succession.
Fixed an echo issue on Honeywell CT50. The solution is to install the firmware 71.01.17-(0285) provided by Honeywell.
Fixed an echo issue on Samsung S7 with Android 8.0.
The Windows SDK is now more tolerant of late audio being delivered from Windows / audio device.
Various crash fixes.

For a more detailed list of changes in this version, see Change log: SDK version 1.8.0.

SDK 1.7.1 (July 12, 2018)

This version includes updates to the Android SDK. No changes made in other platforms.

SDK 1.7.0 (May 2018)

This version includes updates to all platforms.

What's new

Support for Xamarin for cross-platform development

CounterPath Softphone SDK introduces support for Xamarin for developing apps for iOS and Android. This SDK can reduce development time by allowing Android and iOS softphone apps to share the same codebase. The SDK includes sample projects for VoIP apps written in C#.
Support for 256-bit cryptographic suites for SRTP calling

CounterPath Softphone SDK now supports 256-bit cryptographic suites for Secure Real-time Transport Protocol (SRTP), which provides the security advantage of a large AES key size. By default, 256-bit cryptographic suites are automatically initiated and negotiated during calls.
Cisco QoS Fastlane support

For iOS apps, CounterPath Softphone SDK support the use of Cisco QoS Fastlane, which provides enterprise Wi-Fi optimizations in Cisco environments. Cisco QoS Fastlane support is enabled for audio by using the [CPCAudio setUseQoSFastlane:] method and for video by using the [CPCVideo useQoSFastlane:] method.

For more information about QoS Fastlane and iOS see "iOS Compatibility with Cisco QoS Fastlane & Adaptive 802.11r" (Apple Support).
Support for Android's Camera2 API

CounterPath Softphone SDK supports Android's newer Camera2 API over its deprecated Camera API for video capture.
Calls using the OPUS codec default to a 64k bitrate

The initial bitrate for audio calls using the OPUS codec now defaults to 64k and reduces if necessary. Previously the default was 32k.
Addition of iOS SDK bundled as dynamic framework

The addition of CounterPath Softphone SDK (iOS) bundled as a dynamic framework is an unsupported, experimental feature. If you build an application using this feature, we would like to hear your feedback. Contact CounterPath.

SDK 1.6.0 (August 16, 2017)

This version includes updates to all platforms.

What’s new

1080p high-definition video support

This Softphone SDK includes addition of 1080p high-definition video support on Mac and Windows. Refer to the Video sample application bundled with the SDK package for an example of 1080p video calls.
Swift iOS sample application

To demonstrate how to integrate the Softphone SDK with a Swift application, the iOS Softphone SDK includes a Swift based sample application, which can register a SIP account, and make VoIP calls.
Addition of DirectX 9EX D3DImage rendering on Windows

To allow applications to greatly enhance the UI presentation of video on windows (e.g. being able to put controls right over a video surface), the Windows Softphone SDK now includes support for a DirectX 9EX D3DImage rendering option. Refer to the BasicRegister_Video_DX9_D3DImage sample for an example of integrating this into a .net application.
Other general changes
- Documentation regarding integration with Firebase Cloud Messaging (in the Android Developer Guide) as well as Apple Push Notification Service (in the iOS Developer Guide)
- Addition of interval call quality reports for Voice Quality Monitoring enabled SDKs. Refer to the section on Voice Quality Monitoring of the Softphone reference guide for more information.