5.0 Changelog: Twilio Video Android

• Programmable Video Android SDK 5.14.0 [bintray] , [docs]

Enhancements

• isRecording() API now accurately reflects the current recording state of the Room . In the previous versions of the SDK, isRecording() could return false positives. The onRecordingStarted(...) and onRecordingStopped(...) callbacks will now be invoked when recording for at least a single track in the Room has started and stopped respectively.

Maintenance

• Removed tvi.webrtc.NetworkMonitor and tvi.webrtc.NetworkMonitorAutoDetect from the libwebrtc.jar provided by the SDK.

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

• Programmable Video Android SDK 5.13.0 [bintray] , [docs]

Maintenance

• Added VideoCapturer#setSurfaceTextureHelper . This method enables SDK provided video capturers to capture to a surface texture using a public API rather than an internal method. While this method is public, capturing to a surface texture is currently only supported with Camera2Capturer , and ScreenCapturer . Capturing to a surface texture will be enabled in a future release.

Bug Fixes

• Fixed a race condition that could cause a crash or unnecessary web socket signaling reconnection.
• Fixed a bug where private IP address was not masked properly while publishing insights event.

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

• Programmable Video Android SDK 5.12.0 [bintray] , [docs]

AudioDevice API

Use the AudioDevice API to create innovative and advanced in-app audio capabilities. For example, enable pre-recorded messages to be played in-room, or, apply noise reduction algorithms before playing out the received audio.

An AudioDevice is a logical device that is used to capture and render (play out) audio. The captured audio is sent to the remote party, and the received audio is rendered locally. The current DefaultAudioDevice 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.

Enhancements

• Introduced the Video.audioDevice class member. You can now set your own AudioDevice before connecting to a Room .
• Added DefaultAudioDevice to render and capture audio. By default, the Video SDK uses DefaultAudioDevice to capture and render audio.
• Added the ability to provide custom audio capturing and rendering via the AudioDevice interface. AudioFormat describes the audio that is being captured and rendered.

Maintenance

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

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

• Programmable Video Android SDK 5.11.1 [bintray] , [docs]

Bug Fixes

• Fixed an SCTP related WebRTC security vulnerability detailed here .

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

• Programmable Video Android SDK 5.11.0 [bintray] , [docs]

Bug Fixes

• Set the default values of AudioOptions properties to match the default WebRTC values.

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

• Programmable Video Android SDK 5.10.2 [bintray] , [docs]

Bug Fixes

• Fixed a bug on devices with more than two cameras where after CameraCapturer.switchCamera(...) completes, CameraCapturer.getCameraSource() would return an incorrect value. #548

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

• Programmable Video Android SDK 5.10.1 [bintray] , [docs]

Bug Fixes

• Fixed a memory corruption crash that occurs when recovering from a media server failure in Group Rooms.

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

• Programmable Video Android SDK 5.10.0 [bintray] , [docs]

API Changes

• If your application attempts to capture with a source that is not available, then CameraCapturer will raise an error callback via CameraCapturer.Listener .

Bug Fixes

• Removed isSourceAvailable() precondition check within the CameraCapturer constructor that causes crashes on some devices as reported in quickstart issue #545 .

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

• Programmable Video Android SDK 5.9.0 [bintray] , [docs]

Enhancements

• Reduced connection times by acquiring IceServers during the initial handshake with Twilio's signaling server rather than sending a request to a different endpoint
• IceServers are now localized to your Participant's region rather than using Global Low Latency routing
• The SDK no longer depends on ecs.us1.twilio.com:443

API Changes

• The following IceOptions properties are deprecated and setting them will have no effect.
  • IceOptions.abortOnIceServersTimeout
  • IceOptions.iceServersTimeout

Bug Fixes

• Fixed a bug where IceServers might not be fetched on a dual-stack device where the IPv6 network interface is not reachable. [CSDK-3295]
• Fixed a bug where passing in IceTransportPolicy.RELAY to the IceOptions.Builder().iceTransportPolicy() method was not being used. [GSDK-2148]

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

• Programmable Video Android SDK 5.8.1 [bintray] , [docs]

Bug Fixes

• Fixed the issue where unpublishing and then republishing a LocalVideoTrack using VP8 simulcast does not complete.

Maintenance

• Upgraded to Android Gradle Plugin 4.0.0 and Gradle 6.1.1
• Upgraded the SDK to use AndroidX. Please follow the Migrating to AndroidX instructions to consume Video Android 5.8.1 in your app.

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

• Programmable Video Android SDK 5.8.0 [bintray] , [docs]

You can now configure how your available downlink bandwidth will be distributed among your subscribed RemoteVideoTracks by using a new optional ConnectOptions parameter bandwidthProfile. For more details and best practices, visit the Network Bandwidth Profile API guide. Here is a brief example:

As part of the Bandwidth Profile API, you can now specify the mode to control remote video track switch off behavior. The new TrackSwitchOffMode enum can be specified in the VideoBandwidthProfileOptions class and can be set to one of the following:

• TrackSwitchOffMode.PREDICTED - In this mode, RemoteVideoTrack s are pro-actively switched off when network congestion is predicted by the bandwidth estimation mechanism. This mode is used by default if not specified.
• TrackSwitchOffMode.DETECTED - In this mode, RemoteVideoTrack s are switched off only when network congestion is detected.
• TrackSwitchOffMode.DISABLED - In this mode, RemoteVideoTrack s will not be switched off. Instead tracks will be adjusted to lower quality.

Track switch off events are provided via two additional callbacks to RemoteParticipant.Listener.

While publishing a local track, you can now optionally specify its publish priority.

Also, the publisher's TrackPriority for the corresponding local Track can be updated after a track has been published.

When a TrackPriority is updated after the track has been published, remote participants will be alerted to the change via the onAudioTrackPublishPriorityChanged(), onVideoTrackPublishPriorityChanged() and onDataTrackPublishPriorityChanged() Listener methods.

Additionally, you can set a subscriber side priority for a RemoteVideoTrack.

This signals to the media server the relative importance of the track with respect to other tracks that may be shared to the Room. The media server takes this into account while allocating a subscribing RemoteParticipant's bandwidth to the corresponding remote track. If you do not specify a priority, then it defaults to TrackPriority.STANDARD.

• Added TrackPriority for track priorities of Room .
• Added a new class LocalTrackPublicationOptions to specify track publication options when publishing tracks via LocalParticipant .
• Added additional LocalParticipant.publishTrack methods that allow developers to specify LocalTrackPublicationOptions .
• Added a new TrackPriority property to LocalAudioTrackPublication , LocalVideoTrackPublication , and LocalDataTrackPublication .
• Added a new read-only property publishPriority of type TrackPriority to RemoteAudioTrackPublication , RemoteVideoTrackPublication , and RemoteDataTrackPublication . These read-only properties fetch the priorities at which the remote Audio, Video, and Data Tracks were published.
• Added the RemoteParticipant.Listener.onAudioTrackPublishPriorityChanged() , RemoteParticipant.Listener.onVideTrackPublishPriorityChanged() and RemoteParticipant.Listener.onDataTrackPublishPriorityChanged() methods.
• Changed the annotation of LocalParticipant.getLocalAudioTracks , LocalParticipant.getLocalVideoTracks , and LocalParticipant.getLocalVideoTracks from @Nullable to @NonNull . These methods were incorrectly annotated in a previous release.

Bug Fixes

• Fixed a crash when the SDK was processing a local SDP that had incorrect number of SSRCs when applying VP8 simulcast.

Known issues

• Unpublishing and then republishing a LocalVideoTrack using VP8 simulcast does not complete. As a workaround, disable the Track instead.
• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

• Programmable Video Android SDK 5.7.0 [bintray] , [docs]

Enhancements

• Previously, the Video Android SDK would fail connection attempts if the signaling server was busy with too many requests. Now, it will try again after a server specified backoff period either until it is successfully connected or the server asks it to stop trying. In this case, the onConnectFailure method is called with SIGNALING_SERVER_BUSY_EXCEPTION .

API Changes

• Added error code definitions:
  • SIGNALING_SERVER_BUSY_EXCEPTION
  • ROOM_ACCOUNT_LIMIT_EXCEEDED_EXCEPTION
  • PARTICIPANT_ACCOUNT_LIMIT_EXCEEDED_EXCEPTION
  • PARTICIPANT_INVALID_SUBSCRIBE_RULE_EXCEPTION
  • TRACK_DATA_TRACK_MESSAGE_TOO_LARGE_EXCEPTION
  • TRACK_DATA_TRACK_SEND_BUFFER_FULL_EXCEPTION
  • MEDIA_DATA_TRACK_FAILED_EXCEPTION
  • MEDIA_DTLS_TRANSPORT_FAILED_EXCEPTION
  • MEDIA_ICE_RESTART_NOT_ALLOWED_EXCEPTION

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

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

Enhancements

• A subset of Android devices provide an OpenSLES implementation. Although more efficient, the use of OpenSLES occasionally causes echo. As a result, the Video SDK now disables OpenSLES by default unless explicitly enabled. To enable OpenSLES, execute the following before invoking Video.connect(...) : tvi.webrtc.voiceengine.WebRtcAudioManager.setBlacklistDeviceForOpenSLESUsage(false) .

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

• Programmable Video Android SDK 5.5.1 [bintray] , [docs]

Bug Fixes

• Fixed an occasional native crash when disconnecting from a Room.
• Fixed a bug when establishing a signaling WebSocket that might cause only one address family (IPv4 or IPv6) to be tried.
• Publish stats reports every 10 seconds and active ICE candidate pair messages every 20 seconds. Previously both were reported every 4 seconds.

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

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

Enhancements

• Added updateCaptureRequest to Camera2Capturer . This API allows developers to update the CaptureRequest of an ongoing Camera2Capturer session. Reference the following snippet as an example of how to turn the flash on for the Camera2Capturer .

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

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

Enhancements

• Reduced the SDK size. The table below highlights the updated app size impact.

Bug Fixes

• Fixed an issue integrating the SDK with applications that contain an attribute of scaleType , mirror , or overlaySurface . These attributes defined for VideoView and VideoTextureView have been prefixed with tvi to prevent attribute name clashes. Reference the following snippets to update your application layout files.

Configure video views before 5.4.0

Configure video views in 5.4.0+

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

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

Features

• Implemented a boolean Connect Option enableIceGatheringOnAnyAddressPorts that allows gathering of ICE candidates from "any address" ports. The default value is false. Setting it to true will allow applications to work in a wider set of VPN environments.

Bug Fixes

• Fixed a crash when attempting to unpublish a local track that was not previously published. #447

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

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

Features

• Implemented Network Quality for Remote Participants in Group Rooms:
  • To enable the Network Quality functionality, set the ConnectOptions.Builder.enableNetworkQuality property to true when connecting to a Group Room. By default this enables network quality level changes to be reported for the Local Participant. To also receive network quality level changes for the Remote Participants, a configured NetworkQualityConfiguration object needs to be supplied to the ConnectOptions.Builder.networkQualityConfiguration property.
  • The networkQualityLevel property has been moved from the LocalParticipant class to the Participant interface.
  • To determine the current network quality level for both Local and Remote Participants, query the networkQualityLevel property. Note, this will return NETWORK_QUALITY_LEVEL_UNKNOWN if:
    • The ConnectOptions.networkQualityEnabled property was set to false OR
    • Using a Peer-to-Peer room OR
    • The network quality level has not yet been computed
  • Implementing the onNetworkQualityLevelChanged method on your LocalParticipant.Listener will allow you to receive callbacks when the network quality level changes for the Local Participant.
  • Implementing the onNetworkQualityLevelChanged method on your RemoteParticipant.Listener will allow you to receive callbacks when the network quality level changes for the Remote Participant.

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

• Programmable Video Android SDK 5.1.2 [bintray] , [docs]

Maintenance

• Updated to Android Gradle Plugin 3.6.0.

Bug Fixes

• Fixed a bug where users of VideoView can not compile the SDK when building with Android Gradle Plugin 3.6.0. #479

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

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

Enhancements

• Reduced bandwidth usage for Insights reporting by up to 75%.
• Data track per-message size limit has been increased to 64 KB.

Bug Fixes

• Fixed a crash which could occur when destroying a Room while the TCP handshake for the signaling connection is in progress.
• Fixed intermittent crash when sending data on a data track while in the process of closing the track due to remote participant disconnect.

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

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

Improvements

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

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

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

Bug Fixes

• Fixed a deadlock that could occur when destroying a Room without waiting for Room.Listener.onDisconnected(...) to arrive.
• Fixed a crash which could occur when disconnecting from a Room with dominant speaker enabled.

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

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

5.0 is now generally available. Thank you for all the feedback from our beta adopters. This release includes Global low latency (GLL) signaling with IPv4 and IPv6 support.

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

• Implemented the Network Quality functionality for Group Rooms:
• The Network Quality feature is disabled by default, to enable it set the ConnectOptions.Builder.enableNetworkQuality property to true when connecting to a Group Room.
  • To determine the current network quality level for your Local Participant, call LocalParticipant.getNetworkQualityLevel(). Note, this will return NETWORK_QUALITY_LEVEL_UNKNOWN if:
    • The ConnectOptions.networkQualityEnabled property was set to false
    • Using a Peer-to-Peer room
    • The network quality level has not yet been computed
  • Network Quality Level for Remote Participants will be available in a future release
  • Implementing the onNetworkQualityLevelChanged method on your LocalParticipant.Listener will allow you to receive callbacks when the network quality level changes

API Changes

• When a Participant connects to a Room , the WebSocket handshake is required to complete in 15 seconds or less, otherwise TwilioException.SIGNALING_CONNECTION_ERROR_EXCEPTION is raised.
• Added LocalParticipant.signalingRegion . You can use this property to determine where your Participant connected to a Room, especially when using the default value of "gll" for ConnectOptions.Builder.region .
• Added Room.mediaRegion . You can use this property to determine where media is being processed in a Group Room.
• EncodingParameters now expresses maximum bitrates in Kilobits per second (Kbps) instead of bits per second (bps).

Enhancements

• Increased the reliability of LocalDataTrack by monitoring its send buffer. Sending too many messages, or sending single messages larger than 16 KB no longer causes the underlying channel(s) to close. These requests are ignored instead.

Bug Fixes

• LocalDataTrack should no longer end up in an inconsistent state after attempting to send a message larger than 16 KB.

Known issues

• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report

The Dominant Speaker Detection API sends events to your application every time the dominant speaker changes. You can use those events to improve the end user's experience by, for example, highlighting which participant is currently talking.

The Dominant Speaker Detection API is only available for Group Rooms. To enable dominant speaker detection, set the ConnectOptions.dominantSpeakerEnabled property to true. Use Room.getDominantSpeaker() to determine the current dominant speaker. Implement Room.Listener.onDominantSpeakerChanged() method to receive callbacks when the dominant speaker changes.

For more information, refer to the API docs and to the dominant speaker tutorial

API Changes

• Introduced TwilioException.SIGNALING_DNS_RESOLUTION_ERROR_EXCEPTION, which is now raised instead of TwilioException.SIGNALING_CONNECTION_ERROR_EXCEPTION in the following scenarios:
  • The device has misconfigured DNS Server(s) on its active network interface.
  • The region provided in ConnectOptions was invalid.
  • The device lost its Internet connection before the query could complete.

Enhancements

• Reduced connection times by removing a round trip when:
  • Reconnecting after a signaling connection failure
  • Connecting with ConnectOptions.iceOptions , and overridden Servers
  • Connecting with default ICE servers (us1 only)

Bug Fixes

• Fixed crash that occurred when rapidly connecting and disconnecting from a room.
• Fixed updating CameraCapturer.State when error occurs.
• Setting ConnectOptions.region to an empty or null value results in the default region being used.
• Fixed a bug where native memory was leaked after disconnecting from a Room .
• Fixed a bug where network monitoring would continue on closed connections in a Peer-to-Peer Room.

Known issues

• In rare cases, the SDK might timeout during a TCP handshake and should be more aggressive at establishing a connection.
• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant . Size Report

Improvements

• The Participant's signaling connection now conforms to Twilio's TLS & Cipher Suite Policy . Support for TLS versions older than 1.2 has been removed.
• Adjusted the buffer sizes used for signaling messages to reduce network fragmentation.
• Setting video::LogModule::kSignaling enables logging of low-level connection events.

Bug Fixes

• WebSocket errors are handled immediately, rather than waiting for a timeout to occur.
• Handle rare exceptions when constructing a WebSocket.

Known issues

• Future 5.0.0-beta releases will reduce the number of round-trips required to connect to a Room.
• In rare cases, the SDK might timeout during a TCP handshake and should be more aggressive at establishing a connection.
• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Improvements

• The SDK uses a new WebSocket based signaling transport, and communicates with globally available signaling Servers over IPv4 and IPv6 networks.
• Added a ConnectOptions.region property. By default, the Client will connect to the nearest signaling Server determined by latency based routing. Setting a value other than "gll" bypasses routing and guarantees that signaling traffic will be terminated in the region that you prefer.
• Participants are considered to be reconnecting within 15 seconds, and are disconnected from a Room after 45 seconds of lost connectivity. #80
• Added and updated public API nullability annotations.

Bug Fixes

• Participants can send messages that are larger than 16 KB.
• The "roomimpl.worker" thread is no longer needed.

Known issues

• Setting LogModule.SIGNALING does not produce any logging.
• Future 5.0.0-beta releases will reduce the number of round-trips required to connect to a Room.
• In rare cases, the SDK might timeout during a TCP handshake and should be more aggressive at establishing a connection.
• Unpublishing and republishing a LocalAudioTrack or LocalVideoTrack might not be seen by Participants. As a result, tracks published after a Room.State.RECONNECTED event might not be subscribed to by a RemoteParticipant .

Size Report