Skip to content

Commit

Permalink
ISDK-2690: Update migration guide for iOS 13.1, and 13.2. (#61)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ceaglest
ceaglest authored Nov 5, 2019
1 parent 86014aa commit 2529afe
Showing 1 changed file with 18 additions and 24 deletions.
42 changes: 18 additions & 24 deletions iOS-13-Migration-Guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The guide explains how to prepare your Twilio Video apps for compatibility with

## Supported SDKs

We recommend that you use the latest patch releases of our SDKs. At this time, we have verified our [2.10.1](https://www.twilio.com/docs/video/changelog-twilio-video-ios-version-2x#2101-august-16-2019), and [3.0.0-beta4](https://www.twilio.com/docs/video/changelog-twilio-video-ios-version-3x#300-beta4-september-6-2019) SDKs for compatibility with iOS 13.0 and 13.1-beta2.
We recommend that you use the latest patch releases of our SDKs. At this time, we have verified our [2.10.2](https://www.twilio.com/docs/video/changelog-twilio-video-ios-version-2x#2102-october-29-2019), and [3.0.1](https://www.twilio.com/docs/video/changelog-twilio-video-ios-version-3x#301-november-5-2019) SDKs for compatibility with iOS 13.2 and iPadOS 13.2.

## Known Issues

Expand All @@ -26,45 +26,45 @@ When `TVICameraSource` starts capturing it begins a background task to ensure th
>
> 2019-09-03 13:44:21.979 VideoCallKitQuickStart[983:48546] Can't end BackgroundTask: no background task exists with identifier 3 (0x3), or it may have already been ended. Break in UIApplicationEndBackgroundTaskError() to debug.
**Status:** This issue is reproducible on iOS 13.0. We have given feedback to Apple, and hope that this issue can be resolved during the iOS 13 release cycle.
**Status:** This issue is reproducible on iOS 13.2. We have given feedback to Apple, and hope that this issue can be resolved during the iOS 13 release cycle.

3. **TVICameraSource, TVICameraCapturer - Distorted video after being interrupted by an AVCaptureSession**

See issue [#53](https://github.com/twilio/twilio-video-ios/issues/53).

**Status:** This bug is reproducible on iOS 13.0. We are actively investigating a fix for our 2.x and 3.0 SDKs.
**Resolution:** Update Twilio Video to [3.0.1](https://www.twilio.com/docs/video/changelog-twilio-video-ios-version-3x#301-november-5-2019), or [2.10.2](https://www.twilio.com/docs/video/changelog-twilio-video-ios-version-2x#2102-october-29-2019).

4. **TVIVideoView - OpenGL ES crashes on iOS Simulator**

The SDK will crash when rendering decoded H.264 video, or any other frames in the `TVIPixelFormatYUV420BiPlanarVideoRange` or `TVIPixelFormatYUV420BiPlanarFullRange` formats when using Xcode 11.0 and an iOS 13.0 simulator.

**Resolution:** Update Twilio Video to [3.0.0-beta4](https://www.twilio.com/docs/video/changelog-twilio-video-ios-version-3x#300-beta4-september-6-2019), or 2.10.2 (coming soon). Use an older simulator model for testing if your deployment target is earlier than 13.0.
**Resolution:** Update Twilio Video to [3.0.1](https://www.twilio.com/docs/video/changelog-twilio-video-ios-version-3x#301-november-5-2019), or [2.10.2](https://www.twilio.com/docs/video/changelog-twilio-video-ios-version-2x#2102-october-29-2019) to fix the crash.

5. **TVIVideoView - Metal on the iOS Simulator**

At the moment, Twilio Video does not support Metal on the iOS 13.0 or iPadOS 13.0 simulators.
At the moment, Twilio Video does not support Metal on the iOS 13 or iPadOS 13 simulators.

**Status:** We will provide an update once iOS 13.0 and macOS 10.15 are released.
**Status:** Now that macOS Catalina is released we will investigate Metal support further.

6. **UIScene & UIApplication Lifecycle**

iOS 13 introduces new [UIScene](https://developer.apple.com/documentation/uikit/uiscene) APIs to manage multiple instances of your app's UI, and handle UI lifecycle events. Twilio Video has several classes that register for UIApplication notifications and continue to do so on iOS 13:
iOS 13 introduces new [UIScene](https://developer.apple.com/documentation/uikit/uiscene) APIs to manage multiple instances of your app's UI, and handle UI lifecycle events. Twilio Video 2.x has several classes that register for UIApplication notifications and continue to do so on iOS 13:

- TVIVideoView: To render with the GPU only while the application is active.
- TVICameraSource: To apply orientation tags to video frames.
- TVICameraCapturer: To apply orientation tags to video frames (2.x).
- TVIRoom: For connection management (2.x).

**Status:** More evaluation of single and multi-window scenes is needed.
**Status:** If you are using the UIScene APIs, then you should update Twilio Video to [3.0.1+](https://www.twilio.com/docs/video/changelog-twilio-video-ios-version-3x#301-november-5-2019) for the best compatibility.

We have conducted initial tests on iOS 13.0 with single window scenes using internal and public apps. The UIApplication notifications needed by Video classes are still fired in this environment:
If you do not use UIScene, then the UIApplication notifications needed by Video classes are still fired as of iOS 13.2:

* UIApplicationDidBecomeActiveNotification
* UIApplicationWillChangeStatusBarOrientationNotification
* UIApplicationWillEnterForegroundNotification
* UIApplicationWillResignActiveNotification

The following .plist manifest was used for testing:
The following .plist manifest was used for evaluation of a single scene application:

```
<key>UIApplicationSceneManifest</key>
Expand Down Expand Up @@ -92,39 +92,33 @@ The following .plist manifest was used for testing:

**Status:** We are still evaluating SwiftUI on iOS 13. Integrators should note that `TVIVideoView` does not specify an `intrinsicContentSize`.

8. **iPadOS**

iPadOS 13.0 will be released on September 30th and offers a brand new multi-tasking user interface.

**Status:** We are still evaluating compatibility with iPadOS 13 and will provide an update soon.

### Sample Code

1. **CallKit**

Starting a `TVIDefaultAudioDevice` [might fail](https://forums.developer.apple.com/thread/120038) when the Participant’s device reports an incoming call to CallKit while backgrounded in iOS 12.4 or 13.0.
Starting a `TVIDefaultAudioDevice` [might fail](https://forums.developer.apple.com/thread/120038) when the Participant’s device reports an incoming call to CallKit while backgrounded in iOS 12.4 or 13.1.

**Status:** This issue should be resolved in iOS 13.1. We will retest with the latest beta release to confirm.
**Status:** This issue should be resolved in iOS 13.2. We will retest with the latest release to confirm.

2. **ReplayKit**

The [ReplayKit Framework](https://developer.apple.com/documentation/replaykit) received some significant enhancements in iOS 13, resolving problems with delayed application audio and the reliability of `RPScreenRecorder`. However, there is also a [serious bug](https://stackoverflow.com/questions/57163212/get-nsinvalidargumentexception-when-trying-to-present-rpsystembroadcastpickervie) in iOS 13.0 (fixed in 13.1-beta2) that can cause a crash when using [RPSystemBroadcastPickerView](https://developer.apple.com/documentation/replaykit/rpsystembroadcastpickerview).
The [ReplayKit Framework](https://developer.apple.com/documentation/replaykit) received some significant enhancements in iOS 13, resolving problems with delayed application audio and the reliability of `RPScreenRecorder`. However, there is also a [serious bug](https://stackoverflow.com/questions/57163212/get-nsinvalidargumentexception-when-trying-to-present-rpsystembroadcastpickervie) in iOS 13.0 (fixed in 13.1) that can cause a crash when using [RPSystemBroadcastPickerView](https://developer.apple.com/documentation/replaykit/rpsystembroadcastpickerview).

<img src="images/replaykit-broadcast-picker-ios-13.0.png"/>

If you use a broadcast extension (`com.apple.broadcast-services-upload`) on iOS 13.0 there is also a memory leak that will result in a crash when the microphone is enabled. This crash is resolved in iOS 13.1-beta2.
If you use a broadcast extension (`com.apple.broadcast-services-upload`) on iOS 13.0 there is also a memory leak that will result in a crash when the microphone is enabled. This crash is resolved in iOS 13.1 as well.

<img src="images/replaykit-broadcast-mic-ios13-audio-resource-limit.png"/>

If you use `ExampleReplayKitAudioCapturer` to capture application audio samples, then you may experience distortion on iOS 13.0 due to changes in the audio format used by ReplayKit.

**Resolution:** Refer to the updated example app ([master](https://github.com/twilio/video-quickstart-ios/tree/master/ReplayKitExample), [3.0.0-beta](https://github.com/twilio/video-quickstart-ios/tree/3.0.0-beta/ReplayKitExample)) for iOS 13 support. Consider disabling `RPBroadcastSystemPickerView` on iOS 13.0 using a runtime check until iOS 13.1 is available.
**Resolution:** Refer to the updated example app ([master](https://github.com/twilio/video-quickstart-ios/tree/master/ReplayKitExample), [2.x](https://github.com/twilio/video-quickstart-ios/tree/2.x/ReplayKitExample)) for iOS 13 support. Consider disabling `RPBroadcastSystemPickerView` on iOS 13.0 using a runtime check and encouraging customers to upgrade to a newer OS.

3. **Swift Naming Conflicts (3.0.0-beta)**
3. **Swift Naming Conflicts**

When compiling the [3.0.0-beta examples](https://github.com/twilio/video-quickstart-ios/tree/3.0.0-beta/), the Objective-C class `TVIAudioCodec` conflicts with the `AudioCodec` type definition from AudioToolbox.framework when compiled with Xcode 11.
When compiling the [3.0 examples](https://github.com/twilio/video-quickstart-ios), the Objective-C class `TVIAudioCodec` conflicts with the `AudioCodec` type definition from AudioToolbox.framework when compiled with Xcode 11.

**Resolution:** The [examples](https://github.com/twilio/video-quickstart-ios/tree/3.0.0-beta/) were updated to eliminate the conflict. If you are experiencing conflicts with the Swift translation of Twilio Video classes, then refer to the classes using their fully qualified name:
**Resolution:** The [examples](https://github.com/twilio/video-quickstart-ios) were updated to eliminate the conflict. If you are experiencing conflicts with the Swift translation of Twilio Video classes, then refer to the classes using their fully qualified name:

```.swift
// Both frameworks define the Swift name AudioCodec
Expand Down

0 comments on commit 2529afe

Please sign in to comment.