Voice Android SDK Changelog

The Twilio Programmable Voice SDKs allow you to add voice-over-IP (VoIP) calling into your native Android applications. See Android Getting Started Guide to begin using the SDK.

Sep 3rd 2024

• Programmable Voice Android SDK 6.6.3 [Maven Central] , [docs] MD5 Checksum : 37633de89f65845cdb3d73f9d63919c2

• Added support for Android 15 with 16k memory page sizes.

Aug 26th 2024

• Programmable Voice Android SDK 6.6.2 [Maven Central] , [docs] MD5 Checksum : 87649dd38123fc4310659cd6518c201a

• The Call Message Events (Beta), originally released in 6.3.3, has been promoted to GA. This release includes the following breaking changes from the beta.
  • Changed error code 31209 to 31212 . This error code is emitted when a call message payload exceeds the authorized limit.
  • Call Message types (CallMessage.messageType) are treated as strings instead of enumerated values.
    • The SDK no longer validates CallMessage.messageType and acts as a pass through for unknown message types in both directions (messages received by the SDK and those sent by the SDK).
    • To send a user defined message, the sendMessage() API should be invoked with a CallMessage object where the messageType is set to one of the supported message types from https://www.twilio.com/docs/voice/sdks/call-message-events
    • Added new error code 31210 for invalid call message type when sendMessage() API is invoked with a CallMessage object where the messageType is not set to user-defined-message .
  • Call.CallMessageListener methods have been updated to include the CallSid, which is a unique identifier for the Call or the CallInvite. The updated APIs are:

• Fixed issue preventing execution on Android API 21-23 devices starting with version 6.3.0.

Size Report

June 3rd, 2024

• Programmable Voice Android SDK 6.6.1 [Maven Central] , [docs] MD5 Checksum : 8d5ef63fe22002d17209fbdd79b2c238

• Added new error code 31211 when sendMessage() API is invoked with a CallMessage object using the CallInvite object when the CallInvite is not reached the Ringing state yet. onMessageFailure() callback will be invoked in this case with the above mentioned error code.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.

Size Report

May 21st, 2024

• Programmable Voice Android SDK 6.6.0 [Maven Central] , [docs] MD5 Checksum : d4363792448280d85ff84c802186610a

• Call Message types (CallMessage.messageType) are treated as strings instead of enumerated values.
  • The SDK no longer validates CallMessage.messageType and acts as a pass through for unknown message types in both directions (messages received by the SDK and those sent by the SDK).
  • To send a user defined message, the sendMessage() API should be invoked with a CallMessage object where the messageType is set to one of the supported message types from https://www.twilio.com/docs/voice/sdks/call-message-events
  • Added new error code 31210 for invalid call message type when sendMessage() API is invoked with a CallMessage object where the messageType is not set to user-defined-message .
• Added new Call Exception, InvalidPhoneNumberException that happens when a call is attempted with an invalid phone number id error 13224 .

• New constant-audio-output-level call quality warning added. This warning is triggered when the audio received is of a constant volume and can be used to determine when someone is speaking. Please note, if the remote party mutes the audio track or places the call on hold , this warning will still be raised.
• Metrics and events reported to Twilio Insights is now encoded via gzip to reduce transmission bandwidth.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.

Size Report

April 15th, 2024

• Programmable Voice Android SDK 6.5.1 [Maven Central] , [docs] MD5 Checksum : 99f789ccbd3c44b88417c0f38605cd72

• Increased sampling resolution of Voice Insights call quality metrics events.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.

Mar 12th, 2024

• Programmable Voice Android SDK 6.5.0 [Maven Central] , [docs] MD5 Checksum : 62c4f7e52e5af586ab6da62cbe7d9d0e

• A new AudioOptions API has been added, enabling audio processing operations on the local audio track/source.
  • Audio processing operations include Echo Cancellation, Automatic Gain Control, Noise Suppression, High Pass Filtering, setting jitter buffer max size in packets, and setting jitter buffer min delay in milliseconds (msec).
  • By default, all audio processing operations are enabled (set to true), the jitter buffer's maximum size is 200 packets, and the jitter buffer's minimum delay is 0 msec.
  • The default values can be modified and custom AudioOptions can be set as part of ConnectOptions when making outbound calls and/or as part of AcceptOptions when receiving incoming calls.
• Example of customized AudioOptions when making an outbound call - In this example, Automatic Gain Control and High Pass Filtering are disabled, jitter buffer max size is set to 100 packets and jitter buffer min delay is set to 5 msec.

• Example of customized AudioOptions when receiving an incoming call - In this example, Echo Cancellation and Noise Suppression are disabled, and jitter buffer max size is set to 50 packets.

• The SDK publishes Voice Insights events when user-defined messages are sent, received, or when sending fails.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.

Size Report

The following table outlines the APK size impact for different Application Binary Interfaces (ABIs):

Feb 12th, 2024

• Programmable Voice Android SDK 6.4.1 [Maven Central] , [docs] MD5 Checksum : 0cd47c848842696ad6bcedab1db9615a

• Call.CallMessageListener methods have been updated to include the CallSid, which is a unique identifier for the Call or the CallInvite. The updated APIs are:

• LogParameters class includes a Throwable field named tr . This allows us to log stack traces from Exceptions and other Throwable objects.
• LogParameters objects can now be constructed using LogParameters.Builder() that utilizes a builder pattern avoiding multi argument cumbersome direct constructors.
• The existing constructors for LogParameters have been deprecated in favor of construction using LogParamters.Builder() and will be removed in the next major release.

• Removed dead/unused c/c++ jni method, Java_com_twilio_voice_JniUtils_nativeJavaUtf16StringToStdString. This is somewhat related to github issue 572 .
• Added new Call Exception, InvalidCallerIdException that happens when a call is attempted with an invalid caller id error 13214 .
• Report the usage of Default Logger or Custom Logger to Twilio Insights. It only reports the type of Logger but not the actual log messages.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.

Size Report

Nov 30th, 2023

• Programmable Voice Android SDK 6.4.0 [Maven Central] , [docs] MD5 Checksum : ccb825d69416838d521692e99ff8e091

• Upgraded to use WebRTC-112.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.

Size Report

Nov 9th, 2023

• Programmable Voice Android SDK 6.3.3 [Maven Central] , [docs] MD5 Checksum : e6dd7df94fe8c83e3ed6765444742709

• The SDK now supports sending and receiving in-call user-defined messages. Use the Call::sendMessage(...) method to send messages. Endpoints subscribed to the events of the call will be receiving the messages. The CallMessageInterface::onReceiveMessage(...) callback will be raised to the application when a message is received by the client. Please visit this page for more details about this feature. Additionally, please see the following for more information on how to send and receive messages on the server. This feature is currently in Beta. Example below.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.

Size Report

Oct 2nd, 2023

• Programmable Voice Android SDK 6.3.2 [Maven Central] , [docs] MD5 Checksum : 40966f1d9fbece4a960b493a3a520725

• Adds a thread member to LogParameters class. The thread member contains the name (or id) of the thread where the log message was generated.

• Fixed a crash when the incoming call listener goes out of scope after timeout.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.

Size Report

Sept 5th, 2023

• Programmable Voice Android SDK 6.3.0 [Maven Central] , [docs] MD5 Checksum : a2e5f997dbf3c6b0e6b1a169e2cbf79d

• Provides a LoggerInterface interface. This interface contains a log method that is invoked with a LogParameters object every time a log message becomes available. The LogParameters object contains all the information relevant to the log message being delivered.
• The Android SDK internally implements the LoggerInterface to provide default logging capabilities to stdout using android.util.Log.
• Provides a Voice.SetLogger(LoggerInterface) method that allows setting a custom logger that conforms to LoggerInterface to which log messages will be delivered.
• Provides a Voice.GetLogger() method that returns the logger that was previously set with setLogger . If no custom logger was set, this method returns the default logger currently used by the SDK.
• Users can send their messages to be logged by the SDK using Voice.GetLogger().log(LogParameters) . This logs the message using the SDK's default logger.
• Users can also implement custom loggers that conform to LoggerInterface to customize the logging mechanism, for eg., logging to a file, sending the logs to a server, etc.
• The existing Logger class is deprecated and will be removed in the next major version release.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.

Size Report

June 23rd, 2023

• Programmable Voice Android SDK 6.2.1 [Maven Central] , [docs] MD5 Checksum : 8875d823f55cad837f972a700696be8b

Fixed a bug where the incoming call invite could only ring up to 3 minutes instead of the maximum 10 minutes call timeout.

June 12th, 2023

• Programmable Voice Android SDK 6.2.0 [Maven Central] , [docs] MD5 Checksum : 5fd4d8b18a8cbfacc56c16a699080e8a

• Upgraded to use WebRTC-105.
• AudioOption, typing_detection is now deprecated, no longer supported by WebRTC.
• Fixed a crash when using an external audio device due to JAVA stack frame not being constructed.
• Fixed a crash due to file handle exhaustion.
• Fixed memory leaks regarding WebRTC shutdown & lingering Media Factory references.

July 11th, 2022

• Programmable Voice Android SDK 6.1.2 [Maven Central] , [docs] MD5 Checksum : 1e9ce7d72f561c46711bbcdfa1df2873

• New edge umatilla is now supported. Set the Voice.setEdge(...) property before connecting or accepting the call.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .

May 26th, 2022

• Programmable Voice Android SDK 6.1.1 [Maven Central] , [docs] MD5 Checksum : 355865e5f9e1f82be63af8225c4f0bfc

• Fixed a crash when the home region specifier ( twr ) in the access token is null .

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .

May 9th, 2022

• Programmable Voice Android SDK 6.1.0 [Maven Central] , [docs] MD5 Checksum : 164b77f552b7a2a9c8c40ace9b30077f

• The Voice Android SDK now supports Twilio Regional by providing the home region specifier in the access token header when calling the Voice.register() method, the Voice.unregister() method, or the Voice.connect() method.

Existing customers can now migrate their Voice use-cases to data centers in Ireland or Australia to establish data residency within the region. In addition, new customers may now select Ireland or Australia as their region of choice for Voice related use cases. There is no additional cost to use the new data centers in Ireland or Australia. To learn more about Regional Voice, check out our blog post or head over to our developer docs to get started.

Below is an example of specifying home region in the access token using the Twilio Node.js helper library:

The decoded header of your access token should look like this:

• The SDK compileSDKVersion and targetSDKVersion were updated to 31.
• Updated getStats(...) API doc.

• Fixed IceCandidatePairStats javadoc. Added responsesSent attribute to IceCandidatePairStats .

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .

February 8th, 2022

• Programmable Voice Android SDK 6.0.7 [Maven Central] , [docs] MD5 Checksum : ddb5b1530276c8a5ceb2fc773a5e6dc7

• Upgraded SDK to build with Java 11.
• Updated the SDK to Android Gradle Plugin 7.0.4.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .

November 19, 2021

• Programmable Voice Android SDK 6.0.2 [Maven Central] , [docs] MD5 Checksum : 9d3914d5b7cb05b9ded42611db408cd9

• Updated the SDK to Android Gradle Plugin 4.2.2.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .

November 5, 2021

• Programmable Voice Android SDK 6.0.1 [Maven Central] , [docs] MD5 Checksum : 8be66d2ff2da31b89a5d904525a7b0a5

• Upgraded the SDK to use AndroidX.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .

November 2, 2021

• Programmable Voice Android SDK 6.0.0 [Maven Central] , [docs] MD5 Checksum : c6150be451e4ad4948f2b5d2a7212ff0

• The minimum Android SDK version has been increased from 16 to 21.

• The voice SDK now validates full remote domain names while setting up the TLS connection.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .

May 24, 2021

• Programmable Voice Android SDK 5.8.0 [Maven Central] , [docs] MD5 Checksum : dff5963249ff07f1378cd322fd50b50b

• This release is based on Chromium WebRTC 88.
• The SDK uses Unified Plan SDP semantics instead of Plan-B.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

March 29, 2021

• Programmable Voice Android SDK 5.7.2 [Maven Central] , [docs] MD5 Checksum : cac4a963814637b23e2d1ffadda30036

• Voice Android artifacts are now published to MavenCentral instead of Bintray.

  • Ensure to include mavenCentral() listed in your project's buildscript repositories section:

    
    

    _10

    buildscript {

    _10

    repositories {

    _10

    mavenCentral()

    _10

    ...

    _10

    }

    _10

    }

    
    
• Voice Android SDK now publishes the checksum in the release notes.

• Fixed a crash when onNetworkChanged was called during the teardown process.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

March 11, 2021

• Programmable Voice Android SDK 5.6.3 [bintray] , [docs]

• Fixed a potential bug in the core module where the Logger could be accessed after being destroyed by another thread.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

January 26, 2021

• Programmable Voice Android SDK 5.6.2 [bintray] , [docs]

• Updated the SDK to Android Gradle Plugin to 4.1.1.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

January 5, 2021

• Programmable Voice Android SDK 5.6.1 [bintray] , [docs]

• Fixed a bug where caller did not receive the onDisconnected callback with error when the callee hung up.
• Fixed a bug where callee did not receive the onCancelledCallInvite callback with error when signaling connection error happened.

• Private IP addresses are masked in Release mode for the SDK logs and the ice-candidate Insights event payload.
• Private IP addresses will not be masked in Debug mode. The selected-ice-candidate-pair event will contain private IP address of the local active ICE candidate for debugging purpose in both Release and Debug modes.
• Stop publishing Voice Insights event with invalid access token.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

September 29th, 2020

• Programmable Voice Android SDK 5.6.0 [bintray] , [docs]

• The SDK compileSDKVersion and targetSDKVersion were updated to 30 from 28. No changes are required to migrate to this version in an existing application.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

September 16, 2020

• Programmable Voice Android SDK 5.5.0 [bintray] , [docs]

• The Voice Android SDK uses Chromium WebRTC 83.
• The Voice Android SDK is built with NDK r20b.
• PeerConnection state is now reported to Insights.
• mos calculation algorithm has been updated to make it monotonically decreasing with increasing jitter and packets-lost-fraction values over a range of rtt values. The final mos should always be in the range [1.0, 4.6].

• A new Insights event selected-ice-candidate-pair is reported with the active local ICE candidate and remote ICE candidate.

• Defined new error code

• A security patch has been applied to prevent host candidate DNS attacks. See [ https://bugs.chromium.org/p/webrtc/issues/detail?id=11597 ] for details.

• Fixed a crash bug when processing empty stats reports or stats reports without remote audio tracks.

The table below highlights the updated App Size Impact.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

September 14, 2020

• Programmable Voice Android SDK 5.4.1 [bintray] , [docs]

• Fixed a crash bug when processing empty stats reports or stats reports without remote audio tracks.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

September 1, 2020

• Programmable Voice Android SDK 5.4.1 [bintray] , [docs]

• Fixed a bug when attempting to execute work on the worker thread from a custom audio device.

• Upgraded to Android Gradle Plugin 4.0.0 and Gradle 6.1.1
• Starting with Voice Android SDK 5.4.1, the SDK is no longer binary compatible with applications that target Java 7. In order to use this and future releases, developers must upgrade their applications to target Java 8. Follow the snippet below for reference:

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

July 9, 2020

• Programmable Voice Android SDK 5.4.0 [bintray] , [docs]

• A CallerInfo object is introduced to represent information about the caller. Currently, this information is limited to SHAKEN/STIR status of incoming PSTN Calls, but may later be expanded to include CNAM, and other endpoint types. isVerified attribute represents whether or not the caller's phone number has been verified by Twilio using SHAKEN/STIR validation. The value of this attribute is true if the caller has been validated at 'A' level, false if the caller has been verified at any lower level or has failed validation. If SHAKEN/STIR information is unavailable for the caller or stir status value is null , the value of this attribute will be null .
• CallInvite class includes getCallerInfo(..) method that returns the CallerInfo of the caller.

For details on how Twilio uses SHAKEN/STIR to make trusted calls and protect against unlawful spoofing, please visit /docs/voice/trusted-calling-using-shakenstir.

• Fixed crash bugs during teardown of a Call .

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

June 23, 2020

• Programmable Voice Android SDK 5.3.1 [bintray] , [docs]

• Fixed a bug in Voice.setRegion(..) API that disallowed to use non default values.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

June 3, 2020

• Programmable Voice Android SDK 5.3.0 [bintray] , [docs]

• A new Call.Listener callback onCallQualityWarningsChanged() is introduced.

The Set that contain the warnings are consisted of enum with values of the newly introduced CallQualityWarning

The trigger conditions for the warnings defined in the enumeration are defined as follows:

• WARN_HIGH_RTT - Round Trip Time (RTT) > 400 ms for 3 out of last 5 samples.
• WARN_HIGH_JITTER - Jitter > 30 ms for 3 out of last 5 samples.
• WARN_HIGH_PACKET_LOSS - Raised when average packet loss > 3% in last 7 samples. Cleared when average packet loss <= 1% in last 7 samples.
• WARN_LOW_MOS - Mean Opinion Score (MOS) < 3.5 for 3 out of last 5 samples.
• WARN_CONSTANT_AUDIO_IN_LEVEL - Raised when the standard deviation of audio input levels for last 10 samples is less than or equals 1% of the maximum possible audio input level (32767) i.e. 327.67 and the call is not in the muted state and the call is not on hold. Cleared when the standard deviation of audio input levels for last 10 samples is greater than 3% of the maximum possible audio input level.
• A new method getCallQualityWarnings() is added to Call to retrieve the present set of call quality related warnings.
• This release also adds the Mean Opinion Score (MOS) measurement mos to RemoteAudioTrackStats . Use Call.getStats() API during a call to retrieve the score. The mos is computed once per second. Since the MOS is calculated from network performance measurements, it can be used to indicate the current network condition to the user to provide better usability. See API Docs for more information.

Example:

• This release includes support for the expansion of Twilio's Global Infrastructure via Edge Locations which allows customers to control their connectivity into and out of Twilio's platform. The Voice Android SDK uses these Edges to connect to Twilio's infrastructure via the new property Voice.edge . This new property supersedes the now deprecated Voice.region . See the new Edge names and how they map to the old region names.

Here is an example:

Below are the new methods signatures introduced in Voice class.

The following APIs have been deprecated in favor of the new methods.

• Added a Boolean property enableIceGatheringOnAnyAddressPorts in CallOptions that allows gathering of ICE candidates from "any address" ports. This allows applications to work in certain VPN environments.

Reference the following code snippet to enable or disable this feature. Note, enableIceGatheringOnAnyAddressPorts is disabled by default.

Configure enableIceGatheringOnAnyAddressPorts with ConnectOptions

Configure enableIceGatheringOnAnyAddressPorts with AcceptOptions

• By default ICE gathering is done on all interfaces except some VPN type interfaces. This makes it impossible to connect to Twilio in networks that require the use of VPN. In this release, the new Boolean property enableIceGatheringOnAnyAddressPorts in CallOptions allows the gathering of ICE candidates from all available interfaces. This should be used in those networks where the default does not work. See AcceptOptions.Builder.enableIceGatheringOnAnyAddressPorts or ConnectOptions.Builder.enableIceGatheringOnAnyAddressPorts for more information.

• Voice.setRegion(..) API disallows to use non default values.
• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

April 27, 2020

• Programmable Voice Android SDK 5.2.0 [bintray] , [docs]

The AudioDevice API is an advanced API that can be used to create innovative and sophisticated in-app audio capabilities. For example, enable pre-recorded messages to be played in-call, or apply noise reduction algorithms before playing out the received audio.

An AudioDevice is a logical device that is used to capture and render audio. The captured audio is sent to the remote party, and the received audio is rendered locally. By default, the SDK uses DefaultAudioDevice which uses the mic for capturing and the local speaker/earpiece/headset for rendering. The AudioDevice API allows for the creation of custom audio capturers and renderers. See this example and API docs to learn more about custom audio devices.

The AudioDevice feature requires additional native APIs that result in a small increase in SDK size. The table below highlights the updated App Size Impact.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

March 20th, 2020

• Programmable Voice Android SDK 5.1.1 [bintray] , [docs]

• Fixed data types in event payload for Voice Insights events.
• Fixed Voice Insights data with valid transport id value.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

February 28, 2020

• Programmable Voice Android SDK 5.1.0 [bintray] , [docs]

• An ongoing call will automatically switch to a more preferred network type if one becomes available. The following are the network types listed in preferred order: ETHERNET, LOOPBACK, WIFI, VPN, and CELLULAR. For example, if a WIFI network becomes available whilst in a call that is using CELLULAR data, the call will automatically switch to using the WIFI network.
• Attempts to re-establish the media connection will be done preemptively if no media flow is detected for 3 seconds.

• Fixed data types in event payload for Voice Insights events.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

December 6, 2019

• Programmable Voice Android SDK 5.0.2 [bintray] , [docs]

• The HttpsURLConnection thread is now tagged using Traffic.setThreadStatsTag . This change prevents warnings and/or crashes when an App is started using strictMode .
• Application name, id, version, build number, and min/major sdk version are now published to Insights. This helps with isolating problems if an issue is encountered.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

November 19, 2019

• Programmable Voice Android SDK 5.0.1 [bintray] , [docs]

• Incoming call handling improvements. Previously, if we encountered network issues before an incoming call was answered or rejected, we disconnected the call. With this release, we will continue to try and establish a connection to Twilio for a maximum of 40 seconds before we disconnect the call.
• We now publish the negotiated codec and its associated parameters to Insights.

• Improved the way we perform DNS resolution. Previously, some DNS requests could indirectly block the main thread. This is no longer the case.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

October 28, 2019

• Programmable Voice Android SDK 5.0.0 [bintray] , [docs]

This release introduces an update to the Programmable Voice call model. To upgrade your application please follow the migration guide.

Prior to 5.0.0, when Voice.register(...) is invoked, the Voice SDK registers for two push notifications: a call and cancel push notification. The call and cancel push notification payloads could then be passed as arguments to Voice.handleMessage(...) and your application would be provided with a callback via MessageListener indicating if the message was a CallInvite or CancelledCallInvite.

Starting with 5.0.0, when Voice.register(...) is invoked, the Voice SDK will register for call push notifications and cancelled call invites will be determined via a signaling connection. Voice.handleMessage(...) no longer processes cancel push notification payloads and will return false if provided with a cancel message. As a result, developers must re-register via Voice.register(...) after upgrading their application to 5.0.0 to stop receiving cancel push notifications.

A valid call push notification, when passed to Voice.handleMessage(...), will still result in a CallInvite being raised to the provided MessageListener. A CancelledCallInvite will be raised to the provided MessageListener if any of the following events occur:

• The call is prematurely disconnected by the caller.
• The callee does not accept or reject the call within 30 seconds.
• The Voice SDK is unable to establish a connection to Twilio.

A CancelledCallInvite will not be raised if a CallInvite is accepted or rejected.

To provide observability for incoming call cancellations the following Insights events have been added:

• MessageListener.onCancelledCallInvite has been updated to the following signature.

  
  

  _10

  void onCancelledCallInvite(@NonNull CancelledCallInvite cancelledCallInvite, @Nullable CallException callException)

  
  

  The provided CallException will indicate if a call was cancelled as the result of an error. If no error occurred, then the CallException is null.

• Both Voice.handleMessage(...) methods require an Android Context as the first argument.
• CallInvite class includes isValid(...) utility method to validate whether the payload is a valid notification sent by Twilio. A valid notification payload will result in a CallInvite being raised via MessageListener.onCallInvite(...) callback when passed to Voice.handleMessage(...) .

• Enabling insights and setting the region are now specified on the Voice class. These options were previously accessible on ConnectOptions and AcceptOptions.

  • Sending stats data to Insights is enabled by default.
  • The default region uses Global Low Latency routing, which establishes a connection with the closest region to the user.

  Below are the new methods signatures introduced in Voice class.

  
  

  _10

  public static boolean isInsightsEnabled();

  _10

  public static void enableInsights(boolean enable);

  _10

  @NonNull public static String getRegion();

  _10

  public static void setRegion(@NonNull String region)

  
  
• Introduced a new error code that gets surfaced when handleMessage(..) API is called with push notification bundle with twilio.voice.cancel as the twi_message_type .

• CLIENT-6757 Updated the Android Gradle Plugin to 3.5.0 and Gradle to 5.4.1.

• CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• CLIENT-5242 Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

August 20th, 2019

• Programmable Voice Android SDK 4.5.0 [bintray] , [docs]

The Differentiated Services Code Point (DSCP) Tagging API allows you to mark the audio packets with Expedited Forwarding (EF) for the purposes of improved packet routing. This behavior is enabled by default. When enabled, supporting networks will prioritize audio packet delivery for improved audio quality.

Reference the following code snippet to control enabling DSCP.

Configure DSCP with ConnectOptions

Configure DSCP with AcceptOptions

• CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• CLIENT-5242 Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

August 2nd, 2019

• Programmable Voice Android SDK 4.4.0 [bintray] , [docs]

You can now retrieve the custom parameters set in your TwiML application from CancelledCallInvite. With this addition, you can for example, display a missed call notification with the caller's display name retrieved from the CancelledCallInvite getCustomParamaters().

For more information, refer to the API docs

cancelledCallInvite.getCustomParameters() returns a map of key-value pair passed in the TwiML.

• CLIENT-5845 Insights events ringing in the connection group guarantees to include CallSid .

• CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• CLIENT-5242 Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

July 29th, 2019

• Programmable Voice Android SDK 4.3.0 [bintray] , [docs]

• CLIENT-6428 The SDK Android Gradle Plugin was updated from 3.3.2 to 3.4.2 and the Gradle version was updated from 4.10.3 to 5.1.1.
• CLIENT-6331 OpenSLES is now disabled by default for both incoming and outgoing calls unless explicitly enabled. To enable OpenSLES, execute the following before invoking Voice.connect(...) or CallInvite.accept(...) : tvo.webrtc.voiceengine.WebRtcAudioManager.setBlacklistDeviceForOpenSLESUsage(false) .

• CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• CLIENT-5242 Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

July 24th, 2019

• Programmable Voice Android SDK 4.2.0 [bintray] , [docs]

• The SDK compileSDKVersion and targetSDKVersion SDK was updated to 28 from 27. No changes are required to migrate to this version in an existing application.

• CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• CLIENT-5242 Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

July 12th, 2019

• Programmable Voice Android SDK 4.1.0 [bintray] , [docs]

By default, Opus codec is set up with a bitrate of around 32kbps (40-50kbps on the wire). With this release, you are able to set a custom max average bitrate transmission to better control how much bandwidth your VoIP application should use. See RFC-7587 7.1 for information about Max Average Bitrate.

The main purpose of this API is to set a lower max average bitrate to minimize bandwidth usage. This is particularly useful in deployments where bandwidth is a premium. Where bandwidth is not of concern, you do not need to use this API.

Max Average Bitrate can be set to as low as 6,000bps and as high as 51,000bps. Values outside this range are ignored and the default Opus operation mode is used. See API Docs for more information.

As would be expected, lowering the max average bitrate impacts audio quality. We don't recommend setting max average bitrate to a value below 8,000bps. On the other hand, setting values over 32,000bps will have negligible audio quality improvements.

For example, to set a new max average bitrate to 16,000bps:

• Programmable Voice Android SDK transmits data for VoIP calls and for Insights . With this release, we have reduced Insights related data consumption by around 25%. This was accomplished by reducing the events reporting interval.
• The SDK now reports ice-candidate events to Insights. These events are raised when OnIceCandidate is called on the PeerConnection .

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

June 28th, 2019

• Programmable Voice Android SDK 4.0.0 [bintray] , [docs]

This release introduces the new Reconnecting State API. This API adds a new state RECONNECTING to Call.State and two new Call.Listener() callbacks, onReconnecting(...) and onReconnected(...).

Call reconnection capability has been available since SDK 3.0. For example, if a call is established over a Wi-Fi network and the Wi-Fi network becomes unavailable, the SDK will automatically switch the call over to the next available network.

This release adds the reconnection related callbacks. onReconnecting(...) indicates when a call is being reconnected due to a network disruption or network switch over and onReconnected(...) is called once the call has been re-connected. You can use this information to provide intuitive feedback to your App user when a reconnection is taking place.

Please refer to our migration guide for more information about migrating from 3.x.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

June 26th, 2019

• Programmable Voice Android SDK 3.3.0 [bintray] , [docs]

• Insights events reconnecting and reconnected in the connection group are now documented in the Javadoc for the Call class.
• CLIENT-6218 Insights events 53001 / Signaling connection disconnected and 53405 / Media connection failed in the connection group that are raised when attempting to reconnect are now raised with Insights level "warning". Previously, they were raised with level "error".
• CLIENT-6257 Added AddressIncompleteException to indicate that the number of the callee is malformed.

• CLIENT-6205 Fixed an issue where a 31408 / Request Timeout would result in a 31005 / Connection error

• CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• CLIENT-5242 Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

June 21st, 2019

• Programmable Voice Android SDK 3..2.0 [bintray] , [docs]

• CLIENT-6282 The SDK can now be compiled alongside the Programmable Video SDK. Please perform the following steps to properly upgrade to 3.2.0
  • Modify the classpath of any java files used from org.webrtc.* to tvo.webrtc.* . Calling APIs to any class in org.webrtc.* will have no effect within the Voice SDK.
  • Perform the following modifications to your proguard file when compiling the Voice SDK for a release build with obfuscation.
    • Change -keep class org.webrtc.** { *; } to -keep class tvo.webrtc.** { *; }
    • Change -dontwarn org.webrtc.** to -dontwarn tvo.webrtc.**

• CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• CLIENT-5242 Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

June 20th, 2019

• Programmable Voice Android SDK 3.1.2 [bintray] , [docs]

• CLIENT-6246 Fixed bug on API 19 and below where the SDK would incorrectly surface a REGISTRATION_ERROR_CODE/31301 exception for calls to Voice.register(...) or Voice.unregister(...) when a EXCEPTION_INVALID_ACCESS_TOKEN/20101 actually occurred.

• CLIENT-5075 The SDK cannot be added alongside the Programmable Video SDK.
• CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• CLIENT-5242 Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

June 12th, 2019

• Programmable Voice Android SDK 3.1.1 [bintray] , [docs]