Voice iOS SDK Changelog
Welcome to the Programmable Voice iOS SDK
The Twilio Programmable Voice SDKs allow you to add voice-over-IP (VoIP) calling to your native iOS applications.
To make sure your app is ready for iOS 14, visit this page.
iOS 13 Compatibility Notice
Apps using SDK versions 2.0.x, 3.x, and 4.x may fail to register for incoming calls when running on iOS 13. We recommend that you upgrade to SDK 5.0 or above. Refer to this advisory and this GitHub issue for more information. Check out our migration guides when planning your move to our latest SDK.
The Twilio Programmable Voice SDKs use Semantic Versioning. Twilio supports version N-1 for 12 months after the first GA release of version N. We recommend you upgrade to the latest version as soon as possible to avoid any breaking changes. Version 6.x is the latest iOS version.
Support for 4.x ceased on September 19, 2020. Please upgrade to the latest version
Support for 3.x ceased on June 28, 2020. Please upgrade to the latest version
Support for 2.x ceased on January 1, 2020. Please upgrade to the latest version
End-of-Life for 1.x will occur on March 23, 2021. A two-hour maintenance period is planned for 1.x at 9am Pacific Time on January 26, 2021. Please upgrade to the latest version. See this EoL notice for further details.
6.7.0
May 17, 2023
- Programmable Voice iOS SDK 6.7.0 [XCFramework] (checksum: 97f1d2af07f308327f392fb347ce19e7a0711f1b8c8050b55c33afc78f8fbaef).
API Updates
- The SDK now supports sending and receiving user-defined messages via the
TVOCallInvite
before it is answered or rejected. Sending user-defined messages while call is still ringing (before connected) is also supported now.
Example of sending and receiving call messages via the TVOCallInvite
:
// Pass `CallMessageDelegate` in the `handleNotification()` method
TwilioVoiceSDK.handleNotification(payload.dictionaryPayload, delegate: self, delegateQueue: nil, callMessageDelegate: self)
// MARK: - NotificaitonDelegate
func callInviteReceived(callInvite: CallInvite) {
let message = "{ \"foo\": \"bar\", \"marco\": \"polo\" }"
let callMessage = CallMessage(content: message)
// voiceEventSid can be used for tracking the message
let voiceEventSid = callInvite.sendMessage(callMessage)
}
// MARK: - CallMessageDelegate
func callInviteDidSendMessage(callInvite: CallInvite, voiceEventSid: String) {
NSLog("Call message sent. Voice Event SID: \(voiceEventSid)")
}
func callInviteDidFailToSendMessage(callInvite: CallInvite, voiceEventSid: String, error: Error) {
NSLog("Failed to send call message. Voice Event SID: \(voiceEventSid). Error: \(error.localizedDescription)")
}
func callInviteDidReceiveMessage(callInvite: CallInvite, callMessage: CallMessage) {
NSLog("Call message received: \(callMessage.content)")
}
- Bitcode support is disabled since App Store no longer accepts bitcode submission from Xcode 14. (Release notes)
Size Impact for 6.7.0
Architecture | Compressed Size | Uncompressed Size |
---|---|---|
arm64 | 3.9 MB | 11.4 MB |
6.5.2
May 12, 2023
- Programmable Voice iOS SDK 6.5.2 [XCFramework] (checksum: a14e7c33c1f78dbe650264cdf5808e7a306bfaecadc2fbac4e1bc1214263765d).
API updates
TVODefaultAudioDevice
class now has a propertyignoresPreferredAttributeConfigurationErrors
to ignore errors during AVAudioSession setup. This is to mitigate the WebRTC issue reported here
Size Impact for 6.5.2
Architecture | Compressed Size | Uncompressed Size |
---|---|---|
arm64 | 3.2 MB | 7.1 MB |
6.5.0
December 5, 2022
- Programmable Voice iOS SDK 6.5.0 [XCFramework] (checksum: 6a0cd9726e992582cb2cb20b6e6721cbb371de19dc67edaef611d92398d4e269).
API updates
- The SDK now supports sending and receiving in-call user-defined messages. Use the
[TVOCall sendMessage:]
method to send messages. Endpoints subscribed to the events of the call will be receiving the messages. The[TVOCallMessageDelegate call:didReceiveMessage:]
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.
NOTE: This feature should not be used with PII.
- The
TVOCallMessage
class and theTVOCallMessageBuilder
class are introduced to represent the call messages.
Example of sending a call message:
let call = TwilioVoiceSDK.connect(options: connectOptions, delegate: self)
// wait for call to be connected
let message = "{ \"foo\": \"bar\", \"marco\": \"polo\" }"
let callMessage = CallMessage(content: message)
// voiceEventSid can be used for tracking the message
let voiceEventSid = call.sendMessage(callMessage)
extension ViewController: CallMessageDelegate {
func callDidSendMessage(call: Call, voiceEventSid: String) {
NSLog("Call message sent. Voice Event SID: \(voiceEventSid)")
}
func callDidFailToSendMessage(call: Call, voiceEventSid: String, error: Error) {
NSLog("Failed to send call message. Voice Event SID: \(voiceEventSid). Error: \(error.localizedDescription)")
}
}
Example of handling incoming call messages:
extension ViewController: CallMessageDelegate {
func callDidReceiveMessage(call: Call, message callMessage: CallMessage) {
NSLog("Call message received. Message: \(callMessage.content)")
}
}
Size Impact for 6.5.0
Architecture | Compressed Size | Uncompressed Size |
---|---|---|
arm64 | 3.2 MB | 7.1 MB |
6.4.2
July 11, 2022
- Programmable Voice iOS SDK 6.4.2 [XCFramework] (checksum: caebcfde5540e6aefeab61edb5d131c55565eb72b690fc50e8201836f0c21735).
API Updates
- The
writable
property of theTVOIceCandidatePairStats
class has been renamed towriteable
. - New edge
umatilla
is now supported. Set theTwilioVoiceSDK.edge
property before connecting or accepting the call.
Bug Fixes
- Fixed a symbol conflict (
RTCNativeAudioSessionDelegateAdapter
) when using the SDK side by side with another WebRTC library.
Size Impact for 6.4.2
Architecture | Compressed Size | Uncompressed Size |
---|---|---|
arm64 | 3.2 MB | 7.0 MB |
6.4.1
May 26, 2022
- Programmable Voice iOS SDK 6.4.1 [XCFramework] (checksum: 16080af560c584f574d00c04af408e340253f814b583b7920a718d66ed5ea6dd ).
Bug Fixes
- Fixed a crash when the home region specifier (
twr
) in the access token isnull
.
Size Impact for 6.4.1
Architecture | Compressed Size | Uncompressed Size |
---|---|---|
arm64 | 3.2 MB | 7.0 MB |
6.4.0
May 3, 2022
- Programmable Voice iOS SDK 6.4.0 [XCFramework] (checksum: 5bb8ab2aa8f9f2e91d243e64c5e850cdc0c1365f4bfc64a37532b0688d118770).
API updates
- The Voice iOS SDK now supports Twilio Regional by providing the home region specifier in the access token header when calling the
TwilioVoiceSDK.register()
method, theTwilioVoiceSDK.unregister()
method, and theTwilioVoiceSDK.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.
Example of specifying home region in the access token using the Twilio Node.js helper library:
const accessToken = new twilio.jwt.AccessToken(
credentials.accountSid,
credentials.apiKeySid,
credentials.apiKeySecret, {
identity,
ttl,
region: 'au1',
},
);
The decoded header of your access token should looks like this:
{
"alg": "HS256",
"typ": "JWT",
"cty": "twilio-fpa;v=1",
"twr": "au1"
}
Maintenance
- Updated API doc of
[TVOCall getStatsWithBlock:]
.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 6.4.0
Architecture | Compressed Size | Uncompressed Size |
---|---|---|
arm64 | 3.2 MB | 7.0 MB |
6.3.1
February 8, 2022
- Programmable Voice iOS SDK 6.3.1 [XCFramework] (checksum: 08e5839eb77d8746baff8b132059f0babfb9e1ed860903553b7d9c02411442af ).
Enhancements
- The Voice SDK now validates full remote domain names while setting up the TLS connection.
- The Voice SDK now uses the maximum timeout value 10 minutes to answer an incoming call.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 6.3.1
Architecture | Compressed Size | Uncompressed Size |
---|---|---|
arm64 | 3.2 MB | 7.0 MB |
6.3.0
May 17, 2021
Enhancements
- This release is based on Chromium WebRTC 88.
- The simulator
arm64
architecture on Apple Silicon Macs is now available. - The SDK uses Unified Plan SDP semantics instead of Plan-B.
Known Issues
- Carthage is not currently a supported distribution mechanism for Twilio Voice. Carthage does not currently work with
.xcframeworks
as documented here. Once Carthage supports binary.xcframeworks
, Carthage distribution will be re-added. - Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 6.3.0
Architecture | Compressed Size | Uncompressed Size |
---|---|---|
arm64 | 3.2 MB | 7.1 MB |
5.5.2
March 29, 2021
- Programmable Voice iOS SDK 5.5.2 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Bug Fixes
- Fixed a potential crash in the core module where the logger could be accessed after being destroyed by another thread. #419
- Fixed a bug where caller might not receive the
[TVOCallDelegate call:didDisconnectiWithError:]
callback when callee hangs up. - Fixed a bug where callee was not receiving the
[TVONotificationDelegate cancelledCallInviteReceived:error:]
callback when signaling connection error happens.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 5.5.2
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 3.0 MB | 6.7 MB |
arm64 | 3.0 MB | 6.7 MB |
6.2.2
March 11, 2021
Bug Fixes
- Fixed the SDK version number in the
Info.plist
file of the framework. - Fixed a potential crash in the core module where the logger could be accessed after being destroyed by another thread. #419
Known Issues
- The
TwilioVoice.xcframework
does not currently support the simulator on Apple Siliconarm64
Macs. - Carthage is not currently a supported distribution mechanism for Twilio Voice. Carthage does not currently work with
.xcframeworks
as documented here. Once Carthage supports binary.xcframeworks
, Carthage distribution will be re-added. - Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 6.2.2
Architecture | Compressed Size | Uncompressed Size |
---|---|---|
arm64 | 3.1 MB | 7.0 MB |
6.2.1
February 4, 2021
Bug Fixes
- Fixed platform version in podspecs.
Known Issues
- The
TwilioVoice.xcframework
does not currently support the simulator on Apple Siliconarm64
Macs. - Carthage is not currently a supported distribution mechanism for Twilio Voice. Carthage does not currently work with
.xcframeworks
as documented here. Once Carthage supports binary.xcframeworks
, Carthage distribution will be re-added. - Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 6.2.1
Architecture | Compressed Size | Uncompressed Size |
---|---|---|
arm64 | 3.1 MB | 7.0 MB |
6.2.0
February 1, 2021
Enhancements
- The Voice iOS SDK is built with Xcode 12.0.
- Twilio Voice is now delivered as an
.xcframework
. The.xcframework
package includes the.dSYM
and.bcsymbolmap
files to allow developers to symbolicate crash reports. - Twilio Voice is now distributed as a Swift Package.
Known Issues
- The
TwilioVoice.xcframework
does not currently support the simulator on Apple Siliconarm64
Macs. - Carthage is not currently a supported distribution mechanism for Twilio Voice. Carthage does not currently work with
.xcframeworks
as documented here. Once Carthage supports binary.xcframeworks
, Carthage distribution will be re-added. - Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 6.2.0
Architecture | Compressed Size | Uncompressed Size |
---|---|---|
arm64 | 3.1 MB | 7.0 MB |
6.1.0
January 7, 2021
- Programmable Voice iOS SDK 6.1.0 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Enhancements
- 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. Theselected-ice-candidate-pair
event will contain private IP address of the local active ICE candidate for debugging purpose in both Release and Debug modes.
Bug fixes
- Fixed a bug where caller might not receive the
call:didDisconnectWithError:
callback when the callee hangs up. - Fixed a bug where callee was not receiving the
cancelledCallInviteReceived:error:
callback when signaling connection error happens. - The Voice SDK had the same
TwilioVoice
framework name and the class name. This was causing swift compile time errors when an app tries to access a TwilioVoice framework's class using the module name, e.g.TwilioVoice.ConnectOptions
. Fixed this issues by renaming theTwilioVoice
class name toTwilioVoiceSDK
.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size impact for 6.1.0
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 3.1 MB | 6.9 MB |
arm64 | 3.1 MB | 6.9 MB |
6.0.2
November 4, 2020
- Programmable Voice iOS SDK 6.0.2 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Bug fixes
- Fixed Swift compile time error for
AudioDeviceWorkerBlock
.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size impact for 6.0.2
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 3.1 MB | 6.8 MB |
arm64 | 3.1 MB | 6.8 MB |
6.0.1
November 2, 2020
- Programmable Voice iOS SDK 6.0.1 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Bug fixes
- Fixed Swift compile time error for
AudioDeviceContext
.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size impact for 6.0.1
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 3.1 MB | 6.8 MB |
arm64 | 3.1 MB | 6.8 MB |
6.0.0
September 15, 2020
- Programmable Voice iOS SDK 6.0.0 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
API change
-
The Voice SDK has been updated for better Swift interoperability.
- The
TVO
prefix has been removed from all Twilio Voice types - Many of the delegate function declarations have been revamped for better clarity of their intent
- Some of the class method declarations have been revamped for better clarity of their intent
- The
-
This release has improved API for CallKit integration. In order to use CallKit with SDK, you must set
ConnectOptions.uuid
orAcceptOptions.uuid
while making or answering a Call. WhenConnectOptions.uuid
orAcceptOptions.uuid
is set, it is your responsibility to enable and disable the audio device. You should enable the audio device in[CXProviderDelegate provider:didActivateAudioSession:]
, and disable the audio device in[CXProviderDelegate provider:didDeactivateAudioSession:]
.
func provider(_ provider: CXProvider, didActivate audioSession: AVAudioSession) {
audioDevice.isEnabled = true
}
func provider(_ provider: CXProvider, didDeactivate audioSession: AVAudioSession) {
audioDevice.isEnabled = false
}
func providerDidReset(_ provider: CXProvider) {
audioDevice.isEnabled = false
}
If you are not using CallKit in your app, you must not set ConnectOptions.uuid
or AcceptOptions.uuid
while making or answering a call. The Voice SDK will enable the audio device for you when the uuid
is nil
.
- The
uuid
property ofTVOCall
is now optional. - This release changes the underlying behavior of
[TVOCallDelegate callDidConnect:]
such that it is raised when both ICE connection state is connected and DTLS negotiation has completed. Previously[TVOCallDelegate callDidConnect:]
was raised when the DTLS negotiation had completed. - In this release,
[TVOCallDelegate callDidConnect:]
is raised when both the ICE connection state is connected and DTLS negotiation has completed. There is no change in behavior however the SDK can detect DTLS failures and raisekTVOMediaDtlsTransportFailedErrorCode
if they occur. - Defined new error code
Error Codes | ErrorCode | Error Message |
---|---|---|
53407 | TVOMediaDtlsTransportFailedErrorCode | Media connection failed due to DTLS handshake failure |
- PeerConnection state is now reported to Insights
Event Group | Level | Event Name | Description |
---|---|---|---|
pc-connection-state | DEBUG | new | Raised when peer connection state is new |
pc-connection-state | DEBUG | connecting | Raised when peer connection state is connecting |
pc-connection-state | DEBUG | connected | Raised when peer connection state is connected |
pc-connection-state | DEBUG | disconnected | Raised when peer connection state is disconnected |
pc-connection-state | ERROR | failed | Raised when peer connection state is failed |
pc-connection-state | DEBUG | closed | Raised when peer connection state is closed |
-
Removed the deprecated property
TwilioVoice.region
. UseTwilioVoice.edge
to control the connectivity with Twilio. -
The
[TwilioVoice registerWithAccessToken:deviceTokenData:completion:]
and the[TwilioVoice unregisterWithAccessToken:deviceTokenData:completion:]
have been renamed to replace the[TwilioVoice registerWithAccessToken:deviceToken:completion:]
and the[TwilioVoice unregisterWithAccessToken:deviceToken:completion:]
methods and now take theNSData
type device token as parameter.
Enhancements
- This release is based on Chromium WebRTC 83.
- TwilioVoice.framework is now built with Xcode 11.4.1
- A new Insights event
selected-ice-candidate-pair
is reported with the active local ICE candidate and remote ICE candidate.
Event Group | Level | Event Name | Description |
---|---|---|---|
ice-candidate | DEBUG | selected-ice-candidate-pair | Raised when the active local and remote ICE candidates of the peer connection are determined |
mos
calculation algorithm has been updated to make it monotonically decreasing with increasingjitter
andpackets-lost-fraction
values over a range ofrtt
values. The final mos should always be in the range [1.0, 4.6].
Maintenance
- Added a security patch to prevent host candidate DNS attacks. See Issue 11597 for details.
Bug fixes
- Fixed a crash when processing of empty stats reports or stats reports without remote audio tracks.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size impact for 6.0.0
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 3.1 MB | 6.8 MB |
arm64 | 3.1 MB | 6.8 MB |
5.5.1
September 15, 2020
- Programmable Voice iOS SDK 5.5.1 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Bug Fixes
- Fixed the background task handling in
[TVOCall disconnect]
,[TVOCallInvite reject]
,[TwilioVoice registerWithAccessToken:deviceTokenData:completion:]
and[TwilioVoice unregisterWithAccessToken:deviceTokenData:completion:]
. iOS should no longer report a background task risk of termination warning. - Fixed a crash when processing of empty stats reports or stats reports without remote audio tracks.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 5.5.1
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 2.9 MB | 6.7 MB |
arm64 | 2.9 MB | 6.7 MB |
5.5.0
July 9, 2020
- Programmable Voice iOS SDK 5.5.0 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
API Change
-
A
TVOCallerInfo
class is introduced to represent information about the caller. Currently, this information is limited toSHAKEN/STIR
status of incoming PSTN Calls, but may later be expanded to includeCNAM
, and other endpoint types. Theverified
property represents whether or not the caller's phone number has been verified by Twilio usingSHAKEN/STIR
validation. The value of this attribute istrue
if the caller has been validated at'A'
level,false
if the caller has been verified at any lower level or has failed validation. IfSHAKEN/STIR
information is unavailable for the caller or stir status value isnull
, the property will benil
. For details on how Twilio usesSHAKEN/STIR
to make trusted calls and protect against unlawful spoofing, please visit https://www.twilio.com/docs/voice/trusted-calling-using-shakenstir. -
New property
callerInfo
inTVOCallInvite
returns theTVOCallerInfo
object to represent the information about the caller.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 5.5.0
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 2.9 MB | 6.7 MB |
arm64 | 2.9 MB | 6.7 MB |
5.4.1
June 25, 2020
- Programmable Voice iOS SDK 5.4.1 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Bug Fixes
- Fixed a crash that could occur when destroying the
TVOCall
orTVOCallInvite
object.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 5.4.1
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 2.9 MB | 6.7 MB |
arm64 | 2.9 MB | 6.7 MB |
5.4.0
June 3, 2020
- Programmable Voice iOS SDK 5.4.0 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
API Change
- 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 iOS SDK uses these Edges to connect to Twilio’s infrastructure via the new property
TwilioVoice.edge
. This new property supersedes the now deprecatedTwilioVoice.region
. See the new Edge names and how they map to the old region names.
Here is an example
// Connect using global low latency
TwilioVoice.edge = "roaming"
- This release also adds the Mean Opinion Score (MOS) measurement
mos
toTVORemoteAudioTrackStats
. Use[TVOCall getStatsWithBlock:]
during a call to retrieve the score. Themos
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
call.getStatsWith { (reports) in
for report in reports {
let remoteAudioTracksStats = report.remoteAudioTrackStats
let mosLabel = "\(remoteAudioTracksStats.mos)"
}
}
Enhancements
-
Network degradation warnings were previously only logged to Insights. With this release, a new
TVOCallDelegate
methodcall:didReceiveQualityWarnings:previousWarnings:
is also invoked when the SDK detects those degradations. Use these to relay network condition to the user to provide a better user experience. See the delegate method and callQualityWarnings for more information. -
The Mean Opinion Score (MOS) is now available in
TVOStatsReport
. Use[TVOCall getStatsWithBlock:]
during a Call to retrieve the score. 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. -
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
inTVOCallOptionsBuilder
allows the gathering of ICE candidates from all available interfaces. This should be used in those networks where the default does not work. See enableIceGatheringOnAnyAddressPorts for more information.
Deprecations
TwilioVoice.region
is now deprecated. UseTwilioVoice.edge
instead. See the new Edge names for possible values.
Bug Fixes
- Fixed a bug where the SDK was still raising the
[TVOCallDelegate callDidStartRinging:]
callback if[TVOCall disconnect]
was called. - Fixed a crash caused by a signaling race condition when user rejects a
TVOCallInvite
.
Other
armv7
builds are no longer available or supported.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 5.4.0
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 2.9 MB | 7.0 MB |
arm64 | 2.8 MB | 6.9 MB |
5.3.1
April 9, 2020
- Programmable Voice iOS SDK 5.3.1 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Improvements
- Optimized
[TwilioVoice unregisterWithAccessToken:deviceTokenData:completion:]
by reducing the number of network requests. - Added background handling support to
[TwilioVoice registerWithAccessToken:deviceTokenData:completion:]
and[TwilioVoice unregisterWithAccessToken:deviceTokenData:completion:]
. They will now finish execution even when the app is backgrounded.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 5.3.1
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 6.0 MB | 12.7 MB |
arm64 | 2.8 MB | 6.9 MB |
armv7 | 3.0 MB | 5.7 MB |
5.3.0
March 18, 2020
- Programmable Voice iOS SDK 5.3.0 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
API Changes
- New methods to register and unregister for VoIP push notifications have been added that rely on
NSData
rather thanNSString
. The previous register and unregister methods have been deprecated in favor of these new methods.
// TwilioVoice.h
+ (void)registerWithAccessToken:(nonnull NSString *)accessToken
deviceTokenData:(nonnull NSData *)deviceTokenData
completion:(nullable void(^)(NSError * __nullable error))completion
NS_SWIFT_NAME(register(withAccessToken:deviceToken:completion:));
+ (void)unregisterWithAccessToken:(nonnull NSString *)accessToken
deviceTokenData:(nonnull NSData *)deviceTokenData
completion:(nullable void(^)(NSError * __nullable error))completion
NS_SWIFT_NAME(unregister(withAccessToken:deviceToken:completion:));
Swift example
func pushRegistry(_ registry: PKPushRegistry, didUpdate credentials: PKPushCredentials, for type: PKPushType) {
TwilioVoice.register(withAccessToken: accessToken, deviceToken: credentials.token) { (error) in
if let error = error {
NSLog("An error occurred while registering: \(error.localizedDescription)")
} else {
NSLog("Successfully registered for VoIP push notifications.")
}
}
}
Objective-C example
- (void)pushRegistry:(PKPushRegistry *)registry
didUpdatePushCredentials:(PKPushCredentials *)credentials
forType:(NSString *)type {
[TwilioVoice registerWithAccessToken:accessToken
deviceTokenData:credentials.token
completion:^(NSError *error) {
if (error) {
NSLog(@"An error occurred while registering: %@", [error localizedDescription]);
} else {
NSLog(@"Successfully registered for VoIP push notifications.");
}
}];
}
Bug Fixes
- Fixed Voice Insights data with valid
transport_id
value.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 5.3.0
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 6.0 MB | 12.7 MB |
arm64 | 2.8 MB | 6.9 MB |
armv7 | 3.0 MB | 5.7 MB |
5.2.1
March 11, 2020
- Programmable Voice iOS SDK 5.2.1 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Bug Fixes
- Fixed duplicated symbol linker errors in the static library.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 5.2.1
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 6.0 MB | 12.7 MB |
arm64 | 2.8 MB | 6.9 MB |
armv7 | 3.0 MB | 5.7 MB |
5.2.0
February 27, 2020
- Programmable Voice iOS SDK 5.2.0 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Enhancements
- Attempts to re-establish the media connection will be done preemptively if no media flow is detected for 3 seconds.
- 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.
- Proper data types are added to the Insights event payload.
Bug Fixes
- Fixed a crash when a canceled call invite is received but the
from
value isnil
.
Things to Note
- Since media and signaling reconnect are two completely separate processes, it is likely that for a single network change event multiple
[TVOCallDelegate call:isReconnectingWithError:]
and[TVOCallDelegate callDidReconnect:]
callbacks will be received in the order specified i.e a[TVOCallDelegate call:isReconnectingWithError:]
callback will always be followed by a[TVOCallDelegate callDidReconnect:]
callback.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 5.2.0
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 6.0 MB | 12.7 MB |
arm64 | 2.8 MB | 6.9 MB |
armv7 | 3.0 MB | 5.6 MB |
5.1.2
February 24, 2020
- Programmable Voice iOS SDK 5.1.2 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Bug Fixes
- Fixed a crash when a canceled call invite is received and the
from
value isnil
.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 5.1.2
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 6.0 MB | 12.6 MB |
arm64 | 2.8 MB | 6.8 MB |
armv7 | 3.0 MB | 5.6 MB |
5.1.1
December 9, 2019
- Programmable Voice iOS SDK 5.1.1 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Enhancements
- Application name, bundle ID, version, build number, Xcode version and min/major SDK version are now published to Insights. This helps with isolating problems if an issue is encountered.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 5.1.1
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 6.0 MB | 12.6 MB |
arm64 | 2.8 MB | 6.8 MB |
armv7 | 3.0 MB | 5.6 MB |
5.1.0
November 19, 2019
- Programmable Voice iOS SDK 5.1.0 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Enhancements
- 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 added support for OpenSSL 1.1.x in the static library version of our SDK. To use this flavor of the SDK, please refer to the instructions included in the Static Library
- We now publish the negotiated codec and its associated parameters to Insights.
Event Group | Level | Event Name | Description |
---|---|---|---|
settings | INFO | codec | Raised when the codec has been selected |
Other Improvements
- Improved the way we perform DNS resolution. Previously, some DNS requests could indirectly block the main thread. This is no longer the case.
listening-error
event level was incorrectly reported as INFO instead of ERROR toinsights
.
Deprecated
- Removed support for the iOS i386 architecture (32-bit iOS Simulator)
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 5.1.0
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.9 MB | 12.6 MB |
arm64 | 2.8 MB | 6.8 MB |
armv7 | 3.0 MB | 5.6 MB |
5.0.0
September 19, 2019
- Programmable Voice iOS SDK 5.0.0 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
iOS 13 & Xcode 11 Support
This release adds support for the new PushKit push notification policy that iOS 13 and Xcode 11 introduced. To upgrade your application please follow the migration guide.
Insights
To provide observability for incoming call cancellations the following Insights events have been added:
Event Group | Event Name | Level | Description |
---|---|---|---|
connection |
listen |
info |
Reported when an attempt to listen for cancellations is made |
connection |
listening |
info |
Reported when an attempt to listen for cancellations has succeeded |
connection |
cancel |
info |
Reported when a cancellation has been reported |
connection |
listening-error |
error |
Reported when an attempt to listen for a cancellation has failed |
registration |
unsupported-cancel-message-error |
error |
Reported when a "cancel" push notification is processed by the SDK. This version of the SDK does not support "cancel" push notifications |
API Changes
- Starting with 5.0.0, when
[TwilioVoice registerWithAccessToken:deviceToken:completion:]
is called, the Voice SDK will only register for "call" push notifications and cancelled call invites will be determined internally by the SDK.[TwilioVoice handleNotification:delegate:delegateQueue:]
no longer processes "cancel" push notification payloads and will returnfalse
if provided with a cancel notification. - A valid call push notification, when passed to
[TwilioVoice handleNotification:delegate:delegateQueue:]
, will still result in aTVOCallInvite
being raised[TVONotificationDelegate callInviteReceived:]
. ATVOCancelledCallInvite
will be raised asynchronously via[TVONotificationDelegate cancelledCallInviteReceived:error:]
if any of the following events occur: - The call is prematurely disconnected by the caller.
- The callee does not accept or reject the call in approximately 30 seconds.
-
The Voice SDK is unable to establish a connection to Twilio. You must retain the
TVOCallInvite
to be notified of a cancellation via[TVONotificationDelegate cancelledCallInviteReceived:error:]
. ATVOCancelledCallInvite
will not be raised if the invite is accepted or rejected. -
[TwilioVoice handleNotification:delegate:]
is now[TwilioVoice handleNotification:delegate:delegateQueue:]
delegateQueue
: the dispatch queue where the[TVONotificationDelegate cancelledCallInviteReceived:error:]
callback is received. Ifnil
is passed, the dispatch main queue will be used.- When a "call" notification is received, the Voice SDK will fire the
[TVONotificationDelegate callInviteReceived:]
callback synchronously. - When a "cancel" notification is received, the method will return
false
. [TVONotificationDelegate cancelledCallInviteReceived:]
is now[TVONotificationDelegate cancelledCallInviteReceived:error:]
-
The
error
indicates that the call was canceled as a result of an error. Theerror.code
will be set toTVOErrorCallCancelledError
if a caller cancels the call before the called party could answer the call. -
The property
enableInsights
has been renamed toinsights
and moved fromTVOCallOptions.h
toTwilioVoice.h
. -
The property
region
has moved fromTVOCallOptions.h
toTwilioVoice.h
. If you are specifying a region via theTwilioVoice.h
region property you must now do so before[TwilioVoice connectWithAccessToken:delegate:]
or[TwilioVoice handleNotification:delegate:delegateQueue:]
is called. -
Class method
[TVOCallInvite isValid:]
is added toTVOCallInvite
for apps to validate whether the notification payload is a valid call notification sent by Twilio. A valid notification payload will result in aTVOCallInvite
being returned via the[TVONotificationDelegate callInviteReceived:]
callback when passed to[TwilioVoice handleNotification:delegate:delegateQueue:]
.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 5.0.0
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.9 MB | 12.6 MB |
arm64 | 2.8 MB | 6.8 MB |
armv7 | 3.0 MB | 5.6 MB |
4.3.0
August 19, 2019
- Programmable Voice iOS SDK 4.3.0 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Enhancements
Differentiated Services Code Point (DSCP) Tagging API
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. When enabled, supporting networks will prioritize audio packet delivery for improved audio quality.
Use enableDscp
to enable or disable DSCP tagging. Note, enableDscp
is enabled by default.
For example:
// Configure DSCP with `TVOConnectOptions`
let connectOptions = TVOConnectOptions(accessToken: accessToken) { (builder) in
builder.enableDscp = true
}
let call = TwilioVoice.connect(with: connectOptions, delegate: callDelegate)
// Configure DSCP with `TVOAcceptOptions`
let acceptOptions = TVOAcceptOptions(accessToken: accessToken) { (builder) in
builder.enableDscp = true
}
let call = callInvite.accept(with: acceptOptions, delegate: callDelegate)
For more information, refer to the docs.
Known Issues
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 4.3.0
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.9 MB | 12.4 MB |
arm64 | 2.8 MB | 6.7 MB |
armv7 | 3.0 MB | 5.5 MB |
4.2.1
August 8, 2019
- Programmable Voice iOS SDK 4.2.1 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
This release includes changes in how the static library libTwilioVoice.a
is built and packaged. libTwilioVoice.a
now contains all the dependencies of the static libraries. Use -lTwilioVoice
in the Other Linker Flags setting to link the SDK. BoringSSL is not packaged as a separate artifact.
Known Issues
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 4.2.1
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.9 MB | 12.4 MB |
arm64 | 2.7 MB | 6.7 MB |
armv7 | 3.0 MB | 5.5 MB |
4.2.0
August 7, 2019
- Programmable Voice iOS SDK 4.2.0 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Enhancements
Custom Parameters in Canceled Call Notification
You can now retrieve the custom parameters set in your TwiML application from TVOCancelledCallInvite
. With this addition, you can for example, display a missed call notification with the caller’s display name retrieved from the TVOCancelledCallInvite
customParameters
.
For more information, refer to the API docs
Pass custom parameters in TwiML
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Dial callerId="client:alice">
<Client>
<Identity>bob</Identity>
<Parameter name="caller_first_name" value="alice" />
<Parameter name="caller_last_name" value="smith" />
</Client>
</Dial>
</Response>
cancelledCallInvite.customParameters
:
{
"caller_first_name" = "alice";
"caller_last_name" = "smith";
}
Known Issues
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 4.2.0
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.9 MB | 12.4 MB |
arm64 | 2.7 MB | 6.7 MB |
armv7 | 3.0 MB | 5.5 MB |
4.1.0
July 15, 2019
- Programmable Voice iOS SDK 4.1.0 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
New Features
Max Average Bandwidth API
By default, the Opus codec is set up with a transmission rate of around 32 kbps (40-50kbps on the wire). With this release, you are able to set a custom max average bitrate to better control how much bandwidth your VoIP application should use. See RFC-7587 section 7.1 for information about Max Average Bitrate.
The main purpose of this API is to set a lower max average bitrate to minimise bandwidth usage. This is particularly useful in deployments where bandwidth is at 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,000 bps. 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,000 bps. On the other hand, setting values over 32,000 bps will have negligible audio quality improvements.
For example, to set a new max average bitrate to 16,000 bps:
let connectOptions = TVOConnectOptions(accessToken: accessToken) { (builder) in
builder.params = params
builder.preferredAudioCodecs = [TVOOpusCodec(maxAverageBitrate: 16000)]
}
let call = TwilioVoice.connect(with: connectOptions, delegate: callDelegate)
Other Enhancements
- Programmable Voice iOS 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.
- CLIENT-6358 The SDK now reports
ice-candidate
events to Insights. These events are raised whenOnIceCandidate
is called on thePeerConnection
.
Known Issues
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 4.1.0
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.9 MB | 12.4 MB |
arm64 | 2.7 MB | 6.7 MB |
armv7 | 3.0 MB | 5.5 MB |
4.0.0
June 28, 2019
- Programmable Voice iOS SDK 4.0.0 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
New Features
Reconnecting State API
This release introduces the new Reconnecting State API
. This API adds a new state TVOCallStateReconnecting
to TVOCallState
and two new optional TVOCallDelegate
methods, call:isReconnectingWithError:
and callDidReconnect:
.
Call reconnection capability has been available since SDK 3.0. For example, if a call is established over a wifi network and the wifi network becomes unavailable, the SDK will automatically switch the call over to the next available network.
This release adds the reconnection related callbacks. call:isReconnectingWithError:
is invoked to indicate a call is being reconnected due to a network disruption or network switch over and callDidReconnect:
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.
Enhancements
Passing a malformed callee to either [TwilioVoice connectWithAccessToken:] or [TwilioVoice connectWithOptions:delegate:] will now result in TVOErrorAddressIncompleteError
Migration Guide
Migrating from 3.x is very simple. Please refer to our migration guide for more information.
Known Issues
- Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Impact for 4.0.0
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.8 MB | 12.4 MB |
arm64 | 2.7 MB | 6.7 MB |
armv7 | 2.9 MB | 5.5 MB |
3.1.1
June 6, 2019
- Programmable Voice iOS SDK 3.1.1 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Bug Fixes
- CLIENT-6220 Fixed an issue where an
NSInvalidArgumentException
exception is raised while connecting a call. #13
Known Issues
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Report
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.8 MB | 12.4 MB |
arm64 | 2.8 MB | 6.8 MB |
armv7 | 3.0 MB | 5.6 MB |
3.1.0
May 16, 2019
- Programmable Voice iOS SDK 3.1.0 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Enhancements
Improved error codes
We now surface more details about errors encountered during [TwilioVoice registerWithAccessToken:deviceToken:completion:], [TwilioVoice unregisterWithAccessToken:deviceToken:completion:], [TwilioVoice connectWithOptions:delegate:], and [TVOCallInvite acceptWithOptions:delegate:]. Previously, these functions reported these errors with the generic error TVOErrorRegistrationError
or TVOErrorConnectionError
.
With the new error codes, you can make more informed decisions with how to remedy the problem. For example, TVOErrorBadRequestError and TVOErrorTooManyRequestsError indicate potential programming issues, while TVOErrorTokenAuthenticationRejected indicate an issue with your Access Token.
Please note, you may need to change your code if you have added special handling for TVOErrorRegistrationError
or TVOErrorConnectionError
.
For more information see the API docs
The following is a summary of the new codes available for [TwilioVoice registerWithAccessToken:deviceToken:completion:], [TwilioVoice unregisterWithAccessToken:deviceToken:completion:]:
Error Code | Value | Error Message |
---|---|---|
TVOErrorBadRequestError | 31400 | Bad Request |
TVOErrorForbiddenError | 31403 | Forbidden |
TVOErrorNotFoundError | 31404 | Not Found |
TVOErrorRequestTimeoutError | 31408 | Request Timeout |
TVOErrorConflictError | 31409 | Conflict |
TVOErrorUpgradeRequiredError | 31426 | Upgrade Required. This is most likely related to a TLS version not accepted by Twilio's infrastructure |
TVOErrorTooManyRequestsError | 31429 | Too Many Requests |
TVOErrorInternalServerError | 31500 | Internal Server Error |
TVOErrorBadGatewayError | 31502 | Bad Gateway |
TVOErrorServiceUnavailableError | 31503 | Service Unavailable |
TVOErrorGatewayTimeoutError | 31504 | Gateway Timeout |
The following is a summary of the new codes available for [TwilioVoice connectWithOptions:delegate:]
, and [TVOCallInvite acceptWithOptions:delegate:]
:
Error Code | Value | Error Message |
---|---|---|
TVOErrorTransportError | 31009 | Transport Error |
TVOErrorBadRequestError | 31400 | Bad Request |
TVOErrorForbiddenError | 31403 | Forbidden |
TVOErrorNotFoundError | 31404 | Not Found |
TVOErrorRequestTimeoutError | 31408 | Request Timeout |
TVOErrorTemporarilyUnavailableError | 31480 | Temporarily Unavailable |
TVOErrorCallDoesNotExistError | 31481 | Call/Transaction Does Not Exist |
TVOErrorBusyHereError | 31486 | Busy Here |
TVOErrorRequestTerminatedError | 31487 | Request Terminated |
TVOErrorInternalServerError | 31500 | Internal Server |
TVOErrorBadGatewayError | 31502 | Bad Gateway |
TVOErrorServiceUnavailableError | 31503 | Service Unavailable |
TVOErrorGatewayTimeoutError | 31504 | Gateway Timeout |
TVOErrorDNSResolutionError | 31530 | DNS Resolution Error |
TVOErrorBusyEverywhereError | 31600 | Busy Everywhere |
TVOErrorDeclineError | 31603 | Decline |
TVOErrorDoesNotExistAnywhereError | 31604 | Does Not Exist Anywhere |
Known Issues
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Report
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.8 MB | 12.4 MB |
arm64 | 2.8 MB | 6.8 MB |
armv7 | 3.0 MB | 5.6 MB |
3.0.0
April 25, 2019
- Programmable Voice iOS SDK 3.0.0 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
We have promoted 3.0.0-beta13
to 3.0.0
. Reference our migration guide to upgrade your applications to 3.0.
Known Issues
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Report
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.8 MB | 12.3 MB |
arm64 | 2.8 MB | 6.8 MB |
armv7 | 3.0 MB | 5.6 MB |
3.0.0-beta13
April 18, 2019
- Programmable Voice iOS SDK 3.0.0-beta13 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Bug Fixes
- CLIENT-5982 Fixed a bug where call quality warnings might be sent to Insights multiple times before the warning is cleared.
Known Issues
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Report
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.8 MB | 12.3 MB |
arm64 | 2.8 MB | 6.8 MB |
armv7 | 3.0 MB | 5.6 MB |
3.0.0-beta12
April 17, 2019
- Programmable Voice iOS SDK 3.0.0-beta12 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Enhancements
- CLIENT-5973 Removed
TVOErrorConnectionTimeoutError
,TVOErrorSignalingConnectionError
,TVOErrorSignalingConnectionTimeoutError
,TVOErrorSignalingIncomingMessageInvalidError
,TVOErrorSignalingOutgoingMessageInvalidError
,TVOErrorConfigurationAcquireFailedError
andTVOErrorConfigurationAcquireTurnFailedError
fromTVOError.h
.
Bug Fixes
- CLIENT-5935 Fixed a bug where constant audio level warning events are being sent to Insights when the call is muted or onhold.
- CLIENT-5969 Renamed
kDefaultAVAudioSessionConfigurationBlock
tokTVODefaultAVAudioSessionConfigurationBlock
so thatTwilioVoice.framework
andTwilioVideo.framework
may be used in the same application. - CLIENT-5977 Fixed a bug where the SDK was sending double values for
packets_lost_fraction
to Insights instead of integer.
Known Issues
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Report
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.8 MB | 12.3 MB |
arm64 | 2.8 MB | 6.8 MB |
armv7 | 3.0 MB | 5.6 MB |
3.0.0-beta11
April 4, 2019
- Programmable Voice iOS SDK 3.0.0-beta11 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Enhancements
- CLIENT-5379 Added network reachability monitoring for the signaling socket for a reliable network change detection.
Bug Fixes
- CLIENT-5379 Fixed a bug where WiFi to WiFi network hand off was causing one-way audio followed by Call disconnect.
Known Issues
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Report
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.8 MB | 12.4 MB |
arm64 | 2.8 MB | 6.8 MB |
armv7 | 3.0 MB | 5.6 MB |
3.0.0-beta10
April 2, 2019
- Programmable Voice iOS SDK 3.0.0-beta10 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Bug Fixes
- CLIENT-5828, CLIENT-5868 A network change that occurs during a reconnection will now trigger another reconnection attempt ensuring media is restored on the correct network.
- CLIENT-5882 Call metrics insights will always be available after a network handover when the call is in
TVOCallStateConnected
state.
Known Issues
- CLIENT-5576 LTE -> WiFi may cause one way audio.
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Report
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.8 MB | 12.4 MB |
arm64 | 2.8 MB | 6.8 MB |
armv7 | 3.0 MB | 5.6 MB |
3.0.0-beta9
March 27, 2019
- Programmable Voice iOS SDK 3.0.0-beta9 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Enhancements
- CLIENT-5806 CLIENT-5807 Updated the API documentation for
[TVOCallInvite acceptWithDelegate:]
and[TVOCallInvite acceptWithOptions:delegate:]
. - CLIENT-5810 Updated the API documentation for
TVOCall
.
API Changes
- Attempts to connect a Call via
[TwilioVoice connectWithDelegate:]
or[TVOCallInvite acceptWithDelegate:]
that fail prior to reaching theTVOCallStateConnected
state will always result in thecall:didFailToConnectWithError:
callback with an error code. However, if[TVOCall disconnect]
is called while an attempt to connect or accept a call is made, thecall:didDisconnectWithError:
callback will be raised with no error.
Bug Fixes
- CLIENT-5813 Network loss scenarios that resulted in a Call failure now raise the
call:didFailToConnectWithError:
callback. Previously these scenarios erroneously raisedcall:didDisconnectWithError:
. - CLIENT-5754 A Call that fails as a result of not establishing a media connection prior to being connected now raises the
call:didFailToConnectWithError:
callback. Previously this scenario erroneously raisedcall:didDisconnectWithError:
. - CLIENT-5821 The
packets_lost_fraction
value reported to Insights is correctly computed and within the expect range of 0 to 100. - CLIENT-5835 Events were erroneously reported to Insights when the
TVOConnectOptions.enableInsights
property was set to false.
Known Issues
- CLIENT-5576 LTE -> WiFi may cause one way audio.
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - CLIENT-5882 Call metrics insights becomes unavailable after a network handover during a call.
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Report
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.8 MB | 12.4 MB |
arm64 | 2.8 MB | 6.8 MB |
armv7 | 3.0 MB | 5.6 MB |
3.0.0-beta8
March 20, 2019
- Programmable Voice iOS SDK 3.0.0-beta8 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Bug Fixes
- CLIENT-5796 Fixed an issue where the millisecond timestamp in the Insights event payload overflows on 32-bit architecture devices.
- CLIENT-5830 Removed scripts from
TwilioVoice.framework
that could cause code signing issue when uploading apps to iTunes Connect.
Known Issues
- CLIENT-5576 LTE -> WiFi may cause one way audio.
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - CLIENT-5821 The
packets_lost_fraction
value reported to Insights is incorrectly computed and within the expect range of 0 to 100. - CLIENT-5835 Events were erroneously reported to Insights when the
TVOConnectOptions.enableInsights
property was set to false. - CLIENT-5882 Call metrics insights becomes unavailable after a network handover during a call.
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Report
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.8 MB | 12.4 MB |
arm64 | 2.8 MB | 6.8 MB |
armv7 | 3.0 MB | 5.6 MB |
3.0.0-beta7
March 19, 2019
- Programmable Voice iOS SDK 3.0.0-beta7 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
API Changes
- The
from
property of theTVOCallInvite
andTVOCancelledCallInvite
objects is nownullable
in case the value is not available in the call invite notification.
Bug Fixes
- CLIENT-5801 Fixed an issue where an incoming call invite that did not contain a from field was not considered a valid notification.
Known Issues
- CLIENT-5830 Apps using
3.0.0-beta7
may have code signing issue when uploading to iTunes Connect due to some development scripts included inTwilioVoice.framework
. - CLIENT-5576 LTE -> WiFi may cause one way audio.
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - CLIENT-5821 The
packets_lost_fraction
value reported to Insights is incorrectly computed and within the expect range of 0 to 100. - CLIENT-5835 Events were erroneously reported to Insights when the
TVOConnectOptions.enableInsights
property was set to false. - CLIENT-5882 Call metrics insights becomes unavailable after a network handover during a call.
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Report
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.8 MB | 12.4 MB |
arm64 | 2.8 MB | 6.8 MB |
armv7 | 3.0 MB | 5.6 MB |
3.0.0-beta6
March 14, 2019
- Programmable Voice iOS SDK 3.0.0-beta6 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Enhancements
- CLIENT-5258 Reduced SDK size by stripping video software codecs.
- CLIENT-5353 Reduced SDK size by stripping SCTP data channels.
Known Issues
- CLIENT-5830 Apps using
3.0.0-beta6
may have code signing issue when uploading to iTunes Connect due to some development scripts included inTwilioVoice.framework
. - CLIENT-5576 LTE -> WiFi may cause one way audio.
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - CLIENT-5821 The
packets_lost_fraction
value reported to Insights is incorrectly computed and within the expect range of 0 to 100. - CLIENT-5835 Events were erroneously reported to Insights when the
TVOConnectOptions.enableInsights
property was set to false. - CLIENT-5882 Call metrics insights becomes unavailable after a network handover during a call.
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Report
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 5.8 MB | 12.4 MB |
arm64 | 2.8 MB | 6.8 MB |
armv7 | 3.0 MB | 5.6 MB |
3.0.0-beta5
March 4, 2019
- Programmable Voice iOS SDK 3.0.0-beta5 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Enhancements
- CLIENT-5678 The size impact report now includes both armv7 and arm64 architectures.
- The
libboringssl.a
library is now separated and shipped alongside the static librarylibTwilioVoice.a
. Add-lboringssl
in the Other Linker Flags to link the SDK properly.
Bug Fixes
- CLIENT-5664 The static library
libTwilioVoice.a
is now properly linked with dependencies.
Known Issues
- CLIENT-5830 Apps using
3.0.0-beta5
may have code signing issue when uploading to iTunes Connect due to some development scripts included inTwilioVoice.framework
. - CLIENT-5576 LTE -> WiFi may cause one way audio.
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - CLIENT-4805 The SDK size is significantly larger than 2.x. A reduced size will be introduced during the beta period.
- CLIENT-5821 The
packets_lost_fraction
value reported to Insights is incorrectly computed and within the expect range of 0 to 100. - CLIENT-5835 Events were erroneously reported to Insights when the
TVOConnectOptions.enableInsights
property was set to false. - CLIENT-5882 Call metrics insights becomes unavailable after a network handover during a call.
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Report
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 6.4 MB | 13.4 MB |
arm64 | 3.1 MB | 7.4 MB |
armv7 | 3.3 MB | 6.1 MB |
3.0.0-beta4
February 14, 2019
- Programmable Voice iOS SDK 3.0.0-beta4 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
API Changes
TVOCallFeedbackScoreNoScore
is replaced withTVOCallFeedbackScoreNotReported
.
Known Issues
- CLIENT-5576 LTE -> WiFi may cause one way audio.
- CLIENT-5578 WiFi to WiFi handover may disconnect the Call.
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - CLIENT-4805 The SDK size is significantly larger than 2.x. A reduced size will be introduced during the beta period.
- CLIENT-5821 The
packets_lost_fraction
value reported to Insights is incorrectly computed and within the expect range of 0 to 100. - CLIENT-5835 Events were erroneously reported to Insights when the
TVOConnectOptions.enableInsights
property was set to false. - CLIENT-5882 Call metrics insights becomes unavailable after a network handover during a call.
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Report
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 6.4 MB | 13.4 MB |
arm64 | 3.1 MB | 7.3 MB |
armv7 | 3.3 MB | 6.0 MB |
3.0.0-beta3
February 7, 2019
- Programmable Voice iOS SDK 3.0.0-beta3 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Enhancements
- The Voice SDK publishes Call Insights. Publishing is enabled by default. The preference can be updated by configuring
TVOCallOptions.enableInsights
. - CLIENT-5595 Added
TVOErrorTokenAuthenticationRejected (51007)
. This error is raised when attempting to perform registration or unregistration with a token that is invalid. - Added
[TVOCall postFeedback:issue:]
method toTVOCall
that posts the feedback collected for this Call to Twilio. IfTVOCallFeedbackScoreNoScore
andTVOCallFeedbackIssueNotReported
are passed, Twilio will report feedback was not available for this call. - CLIENT-2985 The SDK can connect to Twilio’s Servers in an IPv6 environment.
- CLIENT-4998 Call will continue after network handoff.
Bug Fixes
- CLIENT-5573 Fixed a crash that occurred when a client issued a disconnect while already processing a termination request from the server.
Known Issues
- CLIENT-5576 LTE -> WiFi may cause one way audio.
- CLIENT-5578 WiFi to WiFi handover may disconnect the Call.
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - CLIENT-4805 The SDK size is significantly larger than 2.x. A reduced size will be introduced during the beta period.
- CLIENT-5821 The
packets_lost_fraction
value reported to Insights is incorrectly computed and within the expect range of 0 to 100. - CLIENT-5835 Events were erroneously reported to Insights when the
TVOConnectOptions.enableInsights
property was set to false. - CLIENT-5882 Call metrics insights becomes unavailable after a network handover during a call.
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Report
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 3.1 MB | 7.3 MB |
arm64 | 3.1 MB | 7.3 MB |
3.0.0-beta2
December 13, 2018
- Programmable Voice iOS SDK 3.0.0-beta2 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Enhancements
- Added a
preferredAudioCodecs
property toTVOCallOptions
. Support forOpus
is added to the Voice SDK but yet to be enabled on Twilio infrastructure. It will be notified to the users of the Voice SDK whenOpus
codec is enabled on Twilio infrastructure. - Added new error code
31008
. This error is raised when aTVOCallInvite
is accepted after the Call has ended.
Bug Fixes
- CLIENT-5398 Unmuting a Call on hold causes audio to flow.
Known Issues
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - CLIENT-4805 The SDK size is significantly larger than 2.x. A reduced size will be introduced during the beta period.
- CLIENT-4998 Network handoff, and subsequent connection renegotiation is not supported.
- CLIENT-2985 IPv6 is not supported.
- CLIENT-4547 Insights is not published.
- CLIENT-4537 PCMU is the only supported codec. We plan on adding support for Opus moving forward. #117
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Size Report
Architecture | App Download Size | App Storage Size |
---|---|---|
Universal | 3.1 MB | 7.2 MB |
arm64 | 3.1 MB | 7.2 MB |
3.0.0-beta1
November 26, 2018
- Programmable Voice iOS SDK 3.0.0-beta1 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Enhancements
- Added media and signaling related error codes.
Known Issues
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - CLIENT-5258 The SDK size is significantly larger than 2.x. A reduced size will be introduced during the beta period.
- CLIENT-4998 Network handoff, and subsequent connection renegotiation is not supported.
- CLIENT-2985 IPv6 is not supported.
- CLIENT-4547 Insights is not published.
- CLIENT-4537 PCMU is the only supported codec. We plan on adding support for Opus moving forward. #117
- CLIENT-5398 Unmuting a call on hold causes audio to flow.
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
3.0.0-preview5
October 24, 2018
- Programmable Voice iOS SDK 3.0.0-preview5 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Bug Fixes
- CLIENT-5186 Fixed a crash when network is lost during an active Call.
- CLIENT-5132 The
call:didDisconnectWithError:
delegate method of the caller should be called withnil
error instead ofcall:didFailToConnectWithError:
when theTVOCallInvite
is rejected withanswerOnBridge
enabled. - CLIENT-4837 Fixed a crash caused by SIGPIPE when a signaling socket is closed due to an error.
Known Issues
- CLIENT-5059 Calls made to a client or PSTN number that have a long duration before answering may not get connected.
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - CLIENT-5258 The SDK size is significantly larger than 2.x. A reduced size will be introduced during the beta period.
- CLIENT-4998 Network handoff, and subsequent connection renegotiation is not supported.
- CLIENT-2985 IPv6 is not supported.
- CLIENT-4547 Insights is not published.
- CLIENT-4672 CLIENT-4673 Error codes 20157 and 20151 report different message and explanation text than Voice 2.0 SDKs.
- CLIENT-4537 PCMU is the only supported codec. We plan on adding support for Opus moving forward. #117
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
3.0.0-preview4
October 2, 2018
- Programmable Voice iOS SDK 3.0.0-preview4 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Enhancements
- Added
customParameters
property toTVOCallInvite
.
Pass custom parameters in TwiML
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Dial callerId="client:alice">
<Client>
<Identity>bob</Identity>
<Parameter name="caller_first_name" value="alice" />
<Parameter name="caller_last_name" value="smith" />
</Client>
</Dial>
</Response>
callInvite.customParameters
:
{
"caller_first_name" = "alice";
"caller_last_name" = "smith";
}
Bug Fixes
- CLIENT-5202 Fixed a potential crash caused by a memory corruption when a custom
TVOAudioDevice
is created. - CLIENT-5160 The Voice SDK is built using the audio variant of WebRTC 67. Developers are no longer are required to add
NSCameraUsageDescription
key in app's Info.plist to consume the Voice SDK in an app and upload it to the App Store. #164 - CLIENT-5204 Call audio was not able to recover from
AVAudioSession
interruptions.TVOAVAudioSessionConfigurationBlock
now configuresAVAudioSession.preferredIOBufferDuration
to 20 milliseconds by default, to match changes in WebRTC.
Known Issues
- CLIENT-5059 Calls made to a PSTN number may not get connected when
answerOnBridge
is set to true. - CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio's Network Traversal Service. - CLIENT-5258 The SDK size is significantly larger than 2.x. A reduced size will be introduced during the beta period.
- CLIENT-4998 Network handoff, and subsequent connection renegotiation is not supported.
- CLIENT-2985 IPv6 is not supported.
- CLIENT-4547 Insights is not published.
- CLIENT-4672 CLIENT-4673 Error codes 20157 and 20151 report different message and explanation text than Voice 2.0 SDKs.
- CLIENT-4537 PCMU is the only supported codec. We plan on adding support for Opus moving forward. #117
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
3.0.0-preview3
September 12, 2018
- Programmable Voice iOS SDK 3.0.0-preview3 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs].
Bug Fixes
- CLIENT-5101 The
inject_credentials.sh
which was accidentally included in theTwilioVoice.framework
bundle has been removed.
Enhancements
- This release is based on Chromium WebRTC 67.
- Provide a stateless mechanism for processing push notifications related to call invites and call invite cancellations. The
[TwilioVoice handleNotification:]
no longer raises errors via thenotificationError:
method when processing invalid notifications, instead aBOOL
value is returned when it is called. The boolean value isYES
when the provided notification payload results in aTVOCallInvite
orTVOCancelledCallInvite
object. If[TwilioVoice handleNotification:]
returnsNO
it means the data provided was not a Twilio Voice push notification. TheTVOCallInvite
has anaccept()
and areject()
method. While theTVOCancelledCallInvite
simply provides theto
,from
, andcallSid
fields also available in theTVOCallInvite
object. ThecallSid
can be used to associate aTVOCallInvite
with aTVOCancelledCallInvite
. notificationError:
is removed from theTVONotificationDelegate
protocol.cancelledCallInviteReceived:
is added for the SDK to notify the application when a Call cancellation notification is received.
Processing push notifications in 2.X
- (void)pushRegistry:(PKPushRegistry *)registry
didReceiveIncomingPushWithPayload:(PKPushPayload *)payload
forType:(NSString *)type {
[TwilioVoice handleNotification:payload.dictionaryPayload delegate:self];
}
#pragma mark - TVONotificationDelegate
- (void)callInviteReceived:(TVOCallInvite *)callInvite {
if (callInvite.state == TVOCallInviteStatePending) {
[self handleCallInviteReceived:callInvite];
} else if (callInvite.state == TVOCallInviteStateCanceled) {
[self handleCallInviteCanceled:callInvite];
}
}
- (void)notificationError:(NSError *)error {
NSLog(@"Failed processing notification payload: %@", error);
}
- (void)handleCallInviteReceived:(TVOCallInvite *)callInvite {
// Call invite received
}
- (void)handleCallInviteCanceled:(TVOCallInvite *)callInvite {
// Call invite canceled
}
Processing push notifications in 3.X
- (void)pushRegistry:(PKPushRegistry *)registry
didReceiveIncomingPushWithPayload:(PKPushPayload *)payload
forType:(NSString *)type {
BOOL result = [TwilioVoice handleNotification:payload.dictionaryPayload delegate:self];
if (!result) {
NSLog(@"The processed data was not a Twilio push notification payload");
}
}
#pragma mark - TVONotificationDelegate
- (void)callInviteReceived:(TVOCallInvite *)callInvite {
// Call invite received
}
- (void)cancelledCallInviteReceived:(TVOCancelledCallInvite *)cancelledCallInvite {
// Call invite cancelled
}
API Changes
- Deprecated the
TVOAudioOptions.levelControl
andTVOAudioOptions.levelControlInitialPeakLevelDBFS
properties as they are no longer supported in Chromium WebRTC 67.
Known Issues
- CLIENT-5121 The apps using
3.0.0-preview3
may need to includeNSCameraUsageDescription
key and purpose string in it'sInfo.plist
in order to submit the app to the App Store. The WebRTC used by the Twilio Voice SDK is using camera APIs. We are working on building the Voice SDK with the audio only variant of WebRTC where this workaround will not be required. #163 - CLIENT-5059 Calls made to a client or PSTN number that have a long duration before answering may not get connected.
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio Network Travarsal Service. - CLIENT-4805 The SDK size is significantly larger than 2.x. A reduced size will be introduced during the beta period.
- CLIENT-4998 Network handoff, and subsequent connection renegotiation is not supported.
- CLIENT-2985 IPv6 is not supported.
- CLIENT-4698 Params that are passed to your TwiML Application while making calls are not URL encoded
- CLIENT-4547 Insights is not published
- CLIENT-4672 CLIENT-4673 Error codes 20157 and 20151 report different message and explanation text than Voice 2.0 SDKs
- CLIENT-4537 PCMU is the only supported codec. We plan on adding support for Opus moving forward. #117
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
3.0.0-preview2
August 28, 2018
- Programmable Voice iOS SDK 3.0.0-preview2 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs]
Enhancements
- Introduced a new callback method
[TVOCallDelegate callDidStartRinging:]
. This callback is emitted once before the[TVOCallDelegate callDidConnect:]
callback when the callee is being alerted of a Call. The duration of theTVOCallStateRinging
is determined by theanswerOnBridge
flag provided in theDial
verb of your TwiML application associated with this client. If theanswerOnBridge
flag isfalse
, which is the default, the[TVOCallDelegate callDidConnect:]
callback will be emitted immediately after[TVOCallDelegate callDidStartRinging:]
. If theanswerOnBridge
flag istrue
this will cause the Call to emit thecallDidConnect
callback only until the call is answered. See answeronbridge for more details on how to use it with theDial
TwiML verb. If the twiML response contains aSay
verb, then the call will emit the[TVOCallDelegate callDidConnect:]
callback immediately after[TVOCallDelegate callDidStartRinging:]
is raised, irrespective of the value ofanswerOnBridge
being set totrue
orfalse
. - Added a new Call state
TVOCallStateRinging
. TwilioVoice.region
is moved toTVOCallOptions.region
.- Added a
getStatsWithBlock:
method toTVOCall
that builds aTVOStatsReport
with metrics for all the audio tracks in a Call.
Known Issues
- CLIENT-5121 The apps using
3.0.0-preview2
may need to includeNSCameraUsageDescription
key and purpose string in it'sInfo.plist
in order to submit the app to the App Store. The WebRTC used by the Twilio Voice SDK is using camera APIs. We are working on building the Voice SDK with the audio only variant of WebRTC where this workaround will not be required. #163 - CLIENT-5059 Calls made to a client or PSTN number that have a long duration before answering may not get connected.
- CLIENT-4943 Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio Network Travarsal Service. - CLIENT-4805 The SDK size is significantly larger than 2.x. A reduced size will be introduced during the beta period.
- CLIENT-4998 Network handoff, and subsequent connection renegotiation is not supported.
- CLIENT-2985 IPv6 is not supported.
- CLIENT-4698 Params that are passed to your TwiML Application while making calls are not URL encoded
- CLIENT-4547 Insights is not published
- CLIENT-4672 CLIENT-4673 Error codes 20157 and 20151 report different message and explanation text than Voice 2.0 SDKs
- CLIENT-4537 PCMU is the only supported codec. We plan on adding support for Opus moving forward. #117
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
3.0.0-preview1
August 10, 2018
- Programmable Voice iOS SDK 3.0.0-preview1 [Carthage], [Cocoapods], [Dynamic Framework], [Static Library], [docs]
This is our first WebRTC based release using Chromium WebRTC 57.
This SDK introduces audio device APIs. The Voice SDK uses TVODefaultAudioDevice
by default. This release intruduces a new protocol, TVOAudioDevice
. This protocol gives you the ability to replace TVODefaultAudioDevice
. By implementing the TVOAudioDevice
protocol, you can write your own audio capturer to feed audio samples to the Voice SDK and an audio renderer to receive the remote audio samples. For example, you could integrate with ReplayKit2
and capture application audio for broadcast or play music using AVAssetReader
.
This SDK introduces TVOConnectOptions
and TVOAcceptOptions
to allow developers to make behaviorial changes associated with a Call.
This SDK allows multiple active Calls to be managed by the application.
Enhancements
- Introduced
TwilioVoice.audioDevice
class property. You should set your audio device onTwilioVoice.audioDevice
before performing any other actions with the SDK such as creating Tracks or connecting to a Call. - Added
TVODefaultAudioDevice
to render and capture audio. By default, the Voice SDK usesTVODefaultAudioDevice
to capture and render audio. - Added the ability to provide your own audio capturing and rendering via the
TVOAudioDevice
protocol. As a part of this change we've also addedTVOAudioFormat
which describes audio that is being captured and rendered. - This release deprecates
CallKitIntegration
category fromTwilioVoice
in favor of a new property calledTVODefaultAudioDevice.enabled
. This property provides developers with a mechanism to enable or disable the activation of the audio device prior to connecting to a Call or to stop or start the audio device while you are already connected to a Call. A Call can now be connected without activating the audio device by settingTVODefaultAudioDevice.enabled
toNO
and can be enabled during the lifecycle of the Call by settingTVODefaultAudioDevice.enabled
toYES
. The default value isYES
. This API change was made to ensure full compatibility with CallKit as well as supporting other use cases where developers may need to disable the audio device during a call.
Examples #1 - Changing the audio route from receiver to the speaker in a live call:
// The Voice SDK uses TVODefaultAudioDevice by default.
// ... connect to a Call. The `TVODefaultAudioDevice` is configured to route audio to the receiver by default.
TVODefaultAudioDevice *audioDevice = (TVODefaultAudioDevice *)TwilioVoice.audioDevice;
audioDevice.block = ^ {
// We will execute `kDefaultAVAudioSessionConfigurationBlock` first.
kDefaultAVAudioSessionConfigurationBlock();
if (![session overrideOutputAudioPort:AVAudioSessionPortOverrideSpeaker error:&error]) {
NSLog(@"AVAudiosession overrideOutputAudioPort %@",error);
}
};
audioDevice.block();
Example #2 - Connecting to a Call using the AVAudioSessionCategoryPlayback
category:
id<TVOAudioDevice> audioDevice = [TVODefaultAudioDevice audioDeviceWithBlock:^ {
// Execute the `kDefaultAVAudioSessionConfigurationBlock` first.
kDefaultAVAudioSessionConfigurationBlock();
// Overwrite the category to `playback`
AVAudioSession *session = [AVAudioSession sharedInstance];
NSError *error = nil;
if (![session setCategory:AVAudioSessionCategoryPlayback
mode:AVAudioSessionModeVoiceChat
options:AVAudioSessionCategoryOptionAllowBluetooth
error:&error]) {
NSLog(@"AVAudioSession setCategory:options:mode:error: %@",error);
}
}];
TwilioVoice.audioDevice = audioDevice;
TVOCall *call = [TwilioVoice connectWithOptions:connectOptions delegate:self];
- Migrated the API to make an outbound Call from
[TwilioVoice call]
to[TwilioVoice connectWithOptions:delegate:]
.
TVOConnectOptions *connectOptions = [TVOConnectOptions optionsWithAccessToken:self.accessToken
block:^(TVOConnectOptionsBuilder *builder) {
builder.params = twiMLParams;
builder.uuid = [NSUUID UUID];
}];
TVOCall *call = [TwilioVoice connectWithOptions:connectOptions delegate:self];
- Migrated the API to accept a
TVOCallInvite
usingTVOAcceptOptions
.
TVOAcceptOptions *options = [TVOAcceptOptions optionsWithCallInvite:self
block:^(TVOAcceptOptionsBuilder *builder) {
builder.uuid = weakSelf.callInvite.uuid;
}];
TVOCall *call = [callInvite acceptWithOptions:options delegate:strongSelf];
- Added standalone log modules:
TVOLogModuleCore
,TVOLogModulePlatform
,TVOLogModuleSignaling
andTVOLogModuleWebRTC
. [TwilioVoice setModule:logLevel:]
is now[TwilioVoice setLogLevel:module:]
.[TwilioVoice logLevelForModule:]
is added for retrieving log level for specific module.[TwilioVoice version]
is now[TwilioVoice getVersion]
to avoid type conflict withNSObject
.- Voice iOS SDK 3.0.0 supports iOS 10.0 and later versions.
Known Issues
- CLIENT-5121 The apps using
3.0.0-preview1
may need to includeNSCameraUsageDescription
key and purpose string in it'sInfo.plist
in order to submit the app to the App Store. The WebRTC used by the Twilio Voice SDK is using camera APIs. We are working on building the Voice SDK with the audio only variant of WebRTC where this workaround will not be required. #163 - CLIENT-5059 Calls made to a client or PSTN number that have a long duration before answering may not get connected.
- [CLIENT-4943] Restrictive networks may fail unless ICE servers are provided via
TVOConnectOptions
orTVOAcceptOptions
. ICE servers can be obtained from Twilio Network Travarsal Service. - [CLIENT-4805] The SDK size is significantly larger than 2.x. A reduced size will be introduced during the beta period.
- [CLIENT-4998] Network handoff, and subsequent connection renegotiation is not supported.
- [CLIENT-2985] IPv6 is not supported.
- [CLIENT-4698] Params that are passed to your TwiML Application while making calls are not URL encoded
- [CLIENT-4547] Insights is not published
- [CLIENT-4672] [CLIENT-4673] Error codes 20157 and 20151 report different message and explanation text than Voice 2.0 SDKs
- Using the Voice iOS SDK side by side with the WebRTC library will result in
RTCNativeAudioSessionDelegateAdapter
symbol conflict during compile time.
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.