[Fix]Picture-in-Picture trigger and lifecycle (#796)

Author: ipavlidakis

CHANGELOG.md

@@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### 🐞 Fixed
 - Fix ringing flow issues. [#792](https://github.com/GetStream/stream-video-swift/pull/792)
+- Fix a few points that were negatively affecting Picture-in-Picture lifecycle. [#796](https://github.com/GetStream/stream-video-swift/pull/796)
 
 # [1.21.1](https://github.com/GetStream/stream-video-swift/releases/tag/1.21.1)
 _April 25, 2025_

DemoApp/Sources/Views/CallView/DemoSnapshotViewModel.swift

@@ -2,6 +2,7 @@
 // Copyright © 2025 Stream.io Inc. All rights reserved.
 //
 
+import Combine
 import Foundation
 import StreamVideo
 import StreamVideoSwiftUI
@@ -11,7 +12,7 @@ import SwiftUI
 final class DemoSnapshotViewModel: ObservableObject {
 
     private let viewModel: CallViewModel
-    private var snapshotEventsTask: Task<Void, Never>?
+    private var cancellable: AnyCancellable?
 
     @Published var toast: Toast?
 
@@ -21,27 +22,31 @@ final class DemoSnapshotViewModel: ObservableObject {
     }
 
     private func subscribeForSnapshotEvents() {
+        cancellable?.cancel()
+        cancellable = nil
+
         guard let call = viewModel.call else {
-            snapshotEventsTask?.cancel()
-            snapshotEventsTask = nil
             return
         }
 
-        snapshotEventsTask = Task {
-            for await event in call.subscribe(for: CustomVideoEvent.self) {
+        cancellable = call
+            .eventPublisher(for: CustomVideoEvent.self)
+            .compactMap {
                 guard
-                    let imageBase64Data = event.custom["snapshot"]?.stringValue,
+                    let imageBase64Data = $0.custom["snapshot"]?.stringValue,
                     let imageData = Data(base64Encoded: imageBase64Data),
                     let image = UIImage(data: imageData)
                 else {
-                    return
+                    return nil
                 }
-
-                toast = .init(
+                return image
+            }
+            .map {
+                Toast(
                     style: .custom(
                         baseStyle: .success,
                         icon: AnyView(
-                            Image(uiImage: image)
+                            Image(uiImage: $0)
                                 .resizable()
                                 .frame(maxWidth: 30, maxHeight: 30)
                                 .aspectRatio(contentMode: .fit)
@@ -51,6 +56,6 @@ final class DemoSnapshotViewModel: ObservableObject {
                     message: "Snapshot captured!"
                 )
             }
-        }
+            .assign(to: \.toast, on: self)
     }
 }

Sources/StreamVideoSwiftUI/CallView/CallControls/Stateless/StatelessAudioOutputIconView.swift

@@ -15,7 +15,7 @@ public struct StatelessAudioOutputIconView: View {
     @Injected(\.images) private var images
 
     /// The associated call for the audio output icon.
-    public var call: Call?
+    public weak var call: Call?
 
     /// The size of the audio output icon.
     public var size: CGFloat

Sources/StreamVideoSwiftUI/CallView/CallControls/Stateless/StatelessMicrophoneIconView.swift

@@ -15,7 +15,7 @@ public struct StatelessMicrophoneIconView: View {
     @Injected(\.images) private var images
 
     /// The associated call for the microphone icon.
-    public var call: Call?
+    public weak var call: Call?
 
     /// The size of the microphone icon.
     public var size: CGFloat

Sources/StreamVideoSwiftUI/CallView/CallControls/Stateless/StatelessSpeakerIconView.swift

@@ -15,7 +15,7 @@ public struct StatelessSpeakerIconView: View {
     @Injected(\.images) private var images
 
     /// The associated call for the speaker icon.
-    public var call: Call?
+    public weak var call: Call?
 
     /// The size of the speaker icon.
     public var size: CGFloat

Sources/StreamVideoSwiftUI/CallView/CallControls/Stateless/StatelessToggleCameraIconView.swift

@@ -15,7 +15,7 @@ public struct StatelessToggleCameraIconView: View {
     @Injected(\.images) private var images
 
     /// The associated call for the toggle camera icon.
-    public var call: Call?
+    public weak var call: Call?
 
     /// The size of the toggle camera icon.
     public var size: CGFloat

Sources/StreamVideoSwiftUI/CallView/CallControls/Stateless/StatelessVideoIconView.swift

@@ -15,7 +15,7 @@ public struct StatelessVideoIconView: View {
     @Injected(\.images) private var images
 
     /// The associated call for the video icon.
-    public var call: Call?
+    public weak var call: Call?
 
     /// The size of the video icon.
     public var size: CGFloat

Sources/StreamVideoSwiftUI/CallViewModel.swift

@@ -616,7 +616,6 @@ open class CallViewModel: ObservableObject {
 
         pictureInPictureAdapter.call = nil
         pictureInPictureAdapter.sourceView = nil
-        isPictureInPictureEnabled = false
 
         call = nil
         callParticipants = [:]

Sources/StreamVideoSwiftUI/Utils/PictureInPicture/PictureInPictureController.swift

@@ -65,6 +65,20 @@ final class PictureInPictureController: @unchecked Sendable {
             .sinkTask { @MainActor [weak self] in self?.didUpdate($0) }
             .store(in: disposableBag)
 
+        proxyDelegate
+            .publisher
+            .compactMap {
+                switch $0 {
+                case let .failedToStart(_, error):
+                    return error
+                default:
+                    return nil
+                }
+            }
+            .log(.error, subsystems: .pictureInPicture) { "Picture-in-Picture failed to start: \($0)." }
+            .sink { _ in }
+            .store(in: disposableBag)
+
         // Add delay to prevent premature cancellation
         applicationStateAdapter
             .statePublisher
@@ -78,8 +92,11 @@ final class PictureInPictureController: @unchecked Sendable {
     /// Updates the Picture-in-Picture controller when the source view changes.
     @MainActor
     private func didUpdate(_ sourceView: UIView?) {
-        guard let sourceView else {
+        guard let sourceView, store.state.call != nil else {
+            /// We ensure to cleanUp every Picture-in-Picture interacting component so that the next
+            /// Call will start with clean state.
             pictureInPictureController?.contentSource = nil
+            contentViewController = nil
             pictureInPictureController = nil
             disposableBag.remove(DisposableKey.isPossible.rawValue)
             disposableBag.remove(DisposableKey.isActive.rawValue)
@@ -96,16 +113,27 @@ final class PictureInPictureController: @unchecked Sendable {
         guard let contentViewController else {
             return
         }
+        let contentSource = AVPictureInPictureController.ContentSource(
+            activeVideoCallSourceView: sourceView,
+            contentViewController: contentViewController
+        )
 
-        pictureInPictureController = .init(
-            contentSource: .init(
-                activeVideoCallSourceView: sourceView,
-                contentViewController: contentViewController
+        if pictureInPictureController == nil {
+            pictureInPictureController = .init(
+                contentSource: contentSource
             )
+            pictureInPictureController?.canStartPictureInPictureAutomaticallyFromInline = store
+                .state
+                .canStartPictureInPictureAutomaticallyFromInline
+            pictureInPictureController?.delegate = proxyDelegate
+        } else {
+            pictureInPictureController?.contentSource = contentSource
+        }
+
+        log.debug(
+            "SourceView updated and contentViewController preferredContentSize:\(contentViewController.preferredContentSize)",
+            subsystems: .pictureInPicture
         )
-        pictureInPictureController?.canStartPictureInPictureAutomaticallyFromInline = store.state
-            .canStartPictureInPictureAutomaticallyFromInline
-        pictureInPictureController?.delegate = proxyDelegate
     }
 
     /// Updates the content view controller when the view factory changes.

Sources/StreamVideoSwiftUI/Utils/PictureInPicture/StreamPictureInPictureAdapter.swift

@@ -74,7 +74,9 @@ public final class StreamPictureInPictureAdapter: @unchecked Sendable {
             store
                 .publisher(for: \.sourceView)
                 .removeDuplicates()
-                .log(.debug, subsystems: .pictureInPicture) { "SourceView updated: \($0?.description ?? "-")." }
+                .log(.debug, subsystems: .pictureInPicture) {
+                    "SourceView updated frame:\($0?.frame ?? .zero) hasWindow:\($0?.window != nil)."
+                }
                 .sink { _ in }
                 .store(in: disposableBag)
         }