@stream-io/video-react-native-sdk 1.29.4 → 1.30.1-beta.0

package/ios/PictureInPicture/PictureInPictureContent.swift

@@ -0,0 +1,173 @@
+//
+// Copyright © 2024 Stream.io Inc. All rights reserved.
+//
+// Adapted from stream-video-swift for React Native SDK
+// Original: https://github.com/GetStream/stream-video-swift/blob/develop/Sources/StreamVideoSwiftUI/Utils/PictureInPicture/PictureInPictureContent.swift
+//
+
+import Foundation
+
+/// Represents the content state for the Picture-in-Picture window.
+///
+/// This enum defines the different states that the PiP window can display:
+/// - `inactive`: No content is being shown (PiP is not active)
+/// - `video`: Live video from a participant (camera or screen share)
+/// - `avatar`: Participant avatar placeholder (when video is disabled)
+/// - `screenSharing`: Screen share content with indicator overlay
+/// - `reconnecting`: Connection recovery indicator
+///
+/// The React Native SDK receives content state from the JavaScript layer through
+/// the bridge, unlike the upstream Swift SDK which observes call state internally.
+enum PictureInPictureContent: Equatable, CustomStringConvertible {
+    /// No content - PiP is inactive or transitioning
+    case inactive
+
+    /// Video content from a participant
+    /// - Parameters:
+    ///   - track: The WebRTC video track to render
+    ///   - participantName: The participant's display name (for fallback)
+    ///   - participantImageURL: URL to participant's profile image (for fallback)
+    case video(track: RTCVideoTrack?, participantName: String?, participantImageURL: String?)
+
+    /// Screen sharing content
+    /// - Parameters:
+    ///   - track: The WebRTC video track containing screen share
+    ///   - participantName: Name of the participant sharing their screen
+    case screenSharing(track: RTCVideoTrack?, participantName: String?)
+
+    /// Avatar placeholder shown when video is disabled
+    /// - Parameters:
+    ///   - participantName: The participant's display name (for initials)
+    ///   - participantImageURL: URL to participant's profile image
+    case avatar(participantName: String?, participantImageURL: String?)
+
+    /// Connection recovery indicator
+    case reconnecting
+
+    // MARK: - CustomStringConvertible
+
+    var description: String {
+        switch self {
+        case .inactive:
+            return ".inactive"
+        case let .video(track, name, _):
+            return ".video(track:\(track?.trackId ?? "nil"), name:\(name ?? "-"))"
+        case let .screenSharing(track, name):
+            return ".screenSharing(track:\(track?.trackId ?? "nil"), name:\(name ?? "-"))"
+        case let .avatar(name, _):
+            return ".avatar(name:\(name ?? "-"))"
+        case .reconnecting:
+            return ".reconnecting"
+        }
+    }
+
+    // MARK: - Equatable
+
+    static func == (lhs: PictureInPictureContent, rhs: PictureInPictureContent) -> Bool {
+        switch (lhs, rhs) {
+        case (.inactive, .inactive):
+            return true
+        case let (.video(lhsTrack, lhsName, lhsImage), .video(rhsTrack, rhsName, rhsImage)):
+            return isSameTrackInstance(lhsTrack, rhsTrack)
+                && lhsName == rhsName
+                && lhsImage == rhsImage
+        case let (.screenSharing(lhsTrack, lhsName), .screenSharing(rhsTrack, rhsName)):
+            return isSameTrackInstance(lhsTrack, rhsTrack)
+                && lhsName == rhsName
+        case let (.avatar(lhsName, lhsImage), .avatar(rhsName, rhsImage)):
+            return lhsName == rhsName
+                && lhsImage == rhsImage
+        case (.reconnecting, .reconnecting):
+            return true
+        default:
+            return false
+        }
+    }
+
+    /// Track identity must be reference-based so reconnect-created tracks
+    /// with reused `trackId` still propagate through content updates.
+    private static func isSameTrackInstance(_ lhs: RTCVideoTrack?, _ rhs: RTCVideoTrack?) -> Bool {
+        switch (lhs, rhs) {
+        case (nil, nil):
+            return true
+        case let (lhsTrack?, rhsTrack?):
+            return lhsTrack === rhsTrack
+        default:
+            return false
+        }
+    }
+
+    // MARK: - Convenience Properties
+
+    /// Returns the video track if this content has one, nil otherwise
+    var track: RTCVideoTrack? {
+        switch self {
+        case let .video(track, _, _):
+            return track
+        case let .screenSharing(track, _):
+            return track
+        case .inactive, .avatar, .reconnecting:
+            return nil
+        }
+    }
+
+    /// Returns the participant name if available
+    var participantName: String? {
+        switch self {
+        case let .video(_, name, _):
+            return name
+        case let .screenSharing(_, name):
+            return name
+        case let .avatar(name, _):
+            return name
+        case .inactive, .reconnecting:
+            return nil
+        }
+    }
+
+    /// Returns the participant image URL if available
+    var participantImageURL: String? {
+        switch self {
+        case let .video(_, _, imageURL):
+            return imageURL
+        case let .avatar(_, imageURL):
+            return imageURL
+        case .inactive, .screenSharing, .reconnecting:
+            return nil
+        }
+    }
+
+    /// Whether this content represents an active video stream
+    var hasActiveVideo: Bool {
+        switch self {
+        case .video, .screenSharing:
+            return true
+        case .inactive, .avatar, .reconnecting:
+            return false
+        }
+    }
+
+    /// Whether this content is screen sharing
+    var isScreenSharing: Bool {
+        if case .screenSharing = self {
+            return true
+        }
+        return false
+    }
+
+    /// Whether this content shows an avatar
+    var isShowingAvatar: Bool {
+        if case .avatar = self {
+            return true
+        }
+        return false
+    }
+
+    /// Whether this content shows the reconnection view
+    var isReconnecting: Bool {
+        if case .reconnecting = self {
+            return true
+        }
+        return false
+    }
+}

package/ios/PictureInPicture/PictureInPictureContentState.swift

@@ -0,0 +1,123 @@
+//
+// Copyright © 2024 Stream.io Inc. All rights reserved.
+//
+// Adapted from stream-video-swift PictureInPictureStore for React Native SDK
+// The React Native SDK receives state from the JavaScript bridge rather than
+// observing call state internally, so this is a simplified state container.
+//
+
+import Combine
+import Foundation
+
+/// Manages the content state for the Picture-in-Picture window.
+///
+/// This class provides centralized state management for the PiP content view system.
+/// Unlike the upstream `PictureInPictureStore` which uses a Flux-like action/dispatch pattern,
+/// this implementation is optimized for the React Native bridge where state updates come
+/// from the JavaScript layer.
+///
+/// State changes are published via Combine to allow reactive updates in the view layer.
+///
+/// Concurrency model:
+/// - This state container is main-thread confined.
+/// - `RTCVideoTrack` references are never sent across queues.
+final class PictureInPictureContentState {
+
+    /// A full state snapshot that can be applied atomically.
+    struct Snapshot {
+        var track: RTCVideoTrack?
+        var participantName: String?
+        var participantImageURL: String?
+        var isVideoEnabled: Bool
+        var isScreenSharing: Bool
+        var isReconnecting: Bool
+    }
+
+    // MARK: - Published State
+
+    /// The current content being displayed in the PiP window.
+    @Published private(set) var content: PictureInPictureContent = .inactive
+
+    /// Publisher for observing content changes.
+    var contentPublisher: AnyPublisher<PictureInPictureContent, Never> {
+        $content.eraseToAnyPublisher()
+    }
+
+    // MARK: - Private
+
+    private var snapshot: Snapshot = makeDefaultSnapshot()
+
+    // MARK: - Initialization
+
+    init() {}
+
+    // MARK: - State Update
+
+    /// Applies all content inputs in one step to avoid parallel update paths.
+    func apply(_ snapshot: Snapshot) {
+        ensureMainThread()
+        self.snapshot = snapshot
+        publishIfNeeded(for: snapshot)
+    }
+
+    /// Resets all state to defaults.
+    /// Called when cleaning up after a call ends.
+    func reset() {
+        ensureMainThread()
+        snapshot = Self.makeDefaultSnapshot()
+        if content != .inactive {
+            content = .inactive
+        }
+    }
+
+    /// Computes and publishes content based on the latest snapshot.
+    private func publishIfNeeded(for snapshot: Snapshot) {
+        let newContent: PictureInPictureContent
+
+        // Priority order: reconnecting > screen sharing > avatar (video disabled) > video > avatar fallback
+        if snapshot.isReconnecting {
+            newContent = .reconnecting
+        } else if snapshot.isScreenSharing {
+            newContent = .screenSharing(
+                track: snapshot.track,
+                participantName: snapshot.participantName
+            )
+        } else if !snapshot.isVideoEnabled {
+            newContent = .avatar(
+                participantName: snapshot.participantName,
+                participantImageURL: snapshot.participantImageURL
+            )
+        } else if snapshot.isVideoEnabled, snapshot.track != nil {
+            newContent = .video(
+                track: snapshot.track,
+                participantName: snapshot.participantName,
+                participantImageURL: snapshot.participantImageURL
+            )
+        } else {
+            newContent = .avatar(
+                participantName: snapshot.participantName,
+                participantImageURL: snapshot.participantImageURL
+            )
+        }
+
+        if content != newContent {
+            content = newContent
+        }
+    }
+
+    /// PiP content state is expected to be mutated on the main thread only.
+    private func ensureMainThread() {
+        dispatchPrecondition(condition: .onQueue(.main))
+    }
+
+    private static func makeDefaultSnapshot() -> Snapshot {
+        Snapshot(
+            track: nil,
+            participantName: nil,
+            participantImageURL: nil,
+            isVideoEnabled: true,
+            isScreenSharing: false,
+            isReconnecting: false
+        )
+    }
+}

package/ios/PictureInPicture/PictureInPictureDelegateProxy.swift

@@ -0,0 +1,89 @@
+//
+// Copyright © 2024 Stream.io Inc. All rights reserved.
+//
+
+import AVKit
+import Combine
+
+/// A wrapper around AVPictureInPictureControllerDelegate that publishes all
+/// delegate method calls via a single Combine publisher.
+///
+/// This proxy enables reactive handling of PiP lifecycle events and allows
+/// multiple subscribers to observe PiP state changes through a unified interface.
+final class PictureInPictureDelegateProxy: NSObject, AVPictureInPictureControllerDelegate {
+
+    /// Enum representing each AVPictureInPictureControllerDelegate method call
+    /// with its respective associated values.
+    enum Event: CustomStringConvertible {
+        case willStart(AVPictureInPictureController)
+        case didStart(AVPictureInPictureController)
+        case failedToStart(AVPictureInPictureController, Error)
+        case willStop(AVPictureInPictureController)
+        case didStop(AVPictureInPictureController)
+        case restoreUI(AVPictureInPictureController, (Bool) -> Void)
+
+        var description: String {
+            switch self {
+            case .willStart:
+                return ".willStart"
+            case .didStart:
+                return ".didStart"
+            case let .failedToStart(_, error):
+                return ".failedToStart(error: \(error.localizedDescription))"
+            case .willStop:
+                return ".willStop"
+            case .didStop:
+                return ".didStop"
+            case .restoreUI:
+                return ".restoreUI"
+            }
+        }
+    }
+
+    /// The Combine publisher that emits Picture-in-Picture delegate events.
+    var publisher: AnyPublisher<Event, Never> {
+        eventSubject.eraseToAnyPublisher()
+    }
+
+    private let eventSubject = PassthroughSubject<Event, Never>()
+
+    // MARK: - AVPictureInPictureControllerDelegate
+
+    func pictureInPictureControllerWillStartPictureInPicture(
+        _ pictureInPictureController: AVPictureInPictureController
+    ) {
+        eventSubject.send(.willStart(pictureInPictureController))
+    }
+
+    func pictureInPictureControllerDidStartPictureInPicture(
+        _ pictureInPictureController: AVPictureInPictureController
+    ) {
+        eventSubject.send(.didStart(pictureInPictureController))
+    }
+
+    func pictureInPictureController(
+        _ pictureInPictureController: AVPictureInPictureController,
+        failedToStartPictureInPictureWithError error: Error
+    ) {
+        eventSubject.send(.failedToStart(pictureInPictureController, error))
+    }
+
+    func pictureInPictureControllerWillStopPictureInPicture(
+        _ pictureInPictureController: AVPictureInPictureController
+    ) {
+        eventSubject.send(.willStop(pictureInPictureController))
+    }
+
+    func pictureInPictureControllerDidStopPictureInPicture(
+        _ pictureInPictureController: AVPictureInPictureController
+    ) {
+        eventSubject.send(.didStop(pictureInPictureController))
+    }
+
+    func pictureInPictureController(
+        _ pictureInPictureController: AVPictureInPictureController,
+        restoreUserInterfaceForPictureInPictureStopWithCompletionHandler completionHandler: @escaping (Bool) -> Void
+    ) {
+        eventSubject.send(.restoreUI(pictureInPictureController, completionHandler))
+    }
+}

package/ios/PictureInPicture/PictureInPictureEnforcedStopAdapter.swift

@@ -0,0 +1,166 @@
+//
+// Copyright © 2024 Stream.io Inc. All rights reserved.
+//
+
+import AVKit
+import Combine
+import UIKit
+
+/// An adapter responsible for enforcing the stop of Picture-in-Picture
+/// playback when the application returns to the foreground.
+///
+/// This adapter listens to application state changes and PiP activity to ensure
+/// PiP is stopped when the app becomes active (foreground). This behavior matches
+/// iOS user expectations where PiP should dismiss when returning to the app.
+final class PictureInPictureEnforcedStopAdapter {
+
+    private enum DisposableKey: String {
+        case stopEnforceOperation
+    }
+
+    private enum ApplicationState: Equatable {
+        case foreground
+        case background
+        case unknown
+    }
+
+    /// Refresh-rate-based timer interval used for enforcement attempts.
+    private let refreshRate: TimeInterval
+
+    /// Lifecycle subscriptions.
+    private var cancellables: Set<AnyCancellable> = []
+
+    /// Keyed operations that can be replaced/cancelled independently.
+    private var operationCancellables: [String: AnyCancellable] = [:]
+
+    /// Initializes the adapter with a Picture-in-Picture controller and
+    /// starts observing application state and PiP activity to enforce stop.
+    ///
+    /// - Parameter pictureInPictureController: The PiP controller to manage.
+    init(_ pictureInPictureController: StreamPictureInPictureControllerProtocol) {
+        refreshRate = Self.makeRefreshRate()
+
+        // Keep enforcement strictly state-driven: we only run the stop loop
+        // while the app is foregrounded *and* PiP is still active.
+        Publishers
+            .CombineLatest(
+                Self.makeApplicationStatePublisher(),
+                pictureInPictureController
+                    .isPictureInPictureActivePublisher
+                    .removeDuplicates()
+            )
+            .receive(on: DispatchQueue.main)
+            .sink { [weak self, weak pictureInPictureController] applicationState, isActive in
+                self?.didUpdate(
+                    applicationState: applicationState,
+                    isPictureInPictureActive: isActive,
+                    pictureInPictureController: pictureInPictureController
+                )
+            }
+            .store(in: &cancellables)
+    }
+
+    deinit {
+        cancellables.removeAll()
+        removeAllOperations()
+    }
+
+    // MARK: - Private helpers
+
+    private func didUpdate(
+        applicationState: ApplicationState,
+        isPictureInPictureActive: Bool,
+        pictureInPictureController: StreamPictureInPictureControllerProtocol?
+    ) {
+        switch (applicationState, isPictureInPictureActive) {
+        case (.foreground, true):
+            // Foreground + active PiP is the only state where we enforce stop.
+            startStopEnforcement(for: pictureInPictureController)
+        default:
+            // Any other state (background/inactive PiP) should tear down the loop.
+            removeOperation(for: DisposableKey.stopEnforceOperation.rawValue)
+        }
+    }
+
+    private func startStopEnforcement(
+        for pictureInPictureController: StreamPictureInPictureControllerProtocol?
+    ) {
+        guard let pictureInPictureController else {
+            removeOperation(for: DisposableKey.stopEnforceOperation.rawValue)
+            return
+        }
+
+        let operation = Timer
+            .publish(every: refreshRate, on: .main, in: .common)
+            .autoconnect()
+            .filter { _ in
+                UIApplication.shared.applicationState == .active
+            }
+            .sink { [weak pictureInPictureController] _ in
+                // Calling stop repeatedly at display cadence covers cases where
+                // AVKit does not settle PiP shutdown on the first attempt.
+                pictureInPictureController?.stopPictureInPicture()
+            }
+
+        store(operation, key: DisposableKey.stopEnforceOperation.rawValue)
+    }
+
+    private func store(_ operation: AnyCancellable, key: String) {
+        // Keyed replacement ensures exactly one enforcement loop is active.
+        removeOperation(for: key)
+        operationCancellables[key] = operation
+    }
+
+    private func removeOperation(for key: String) {
+        operationCancellables[key]?.cancel()
+        operationCancellables[key] = nil
+    }
+
+    private func removeAllOperations() {
+        operationCancellables.values.forEach { $0.cancel() }
+        operationCancellables.removeAll()
+    }
+
+    private static func makeApplicationStatePublisher(
+        notificationCenter: NotificationCenter = .default
+    ) -> AnyPublisher<ApplicationState, Never> {
+        let foreground = Publishers.Merge(
+            notificationCenter
+                .publisher(for: UIApplication.willEnterForegroundNotification)
+                .map { _ in ApplicationState.foreground },
+            notificationCenter
+                .publisher(for: UIApplication.didBecomeActiveNotification)
+                .map { _ in ApplicationState.foreground }
+        )
+        let background = notificationCenter
+            .publisher(for: UIApplication.didEnterBackgroundNotification)
+            .map { _ in ApplicationState.background }
+
+        return Publishers.Merge(foreground, background)
+            // Emit the current app state immediately so newly created adapters
+            // do not wait for the next lifecycle notification.
+            .prepend(currentApplicationState())
+            .removeDuplicates()
+            .eraseToAnyPublisher()
+    }
+
+    private static func currentApplicationState() -> ApplicationState {
+        switch UIApplication.shared.applicationState {
+        case .active:
+            return .foreground
+        case .background:
+            return .background
+        case .inactive:
+            return .unknown
+        @unknown default:
+            return .unknown
+        }
+    }
+
+    private static func makeRefreshRate() -> TimeInterval {
+        // Keep cadence aligned to the device's display refresh rate while
+        // enforcing a practical minimum (30fps) for older/limited devices.
+        let maximumFramesPerSecond = max(30, UIScreen.main.maximumFramesPerSecond)
+        return 1.0 / Double(maximumFramesPerSecond)
+    }
+}

package/ios/PictureInPicture/PictureInPictureLogger.swift

@@ -0,0 +1,16 @@
+//
+// Copyright © 2024 Stream.io Inc. All rights reserved.
+//
+
+import Foundation
+
+/// Centralized logger for Picture in Picture diagnostics.
+///
+/// Logging is debug-only to avoid production noise and overhead.
+enum PictureInPictureLogger {
+    static func log(_ message: @autoclosure () -> String) {
+        #if DEBUG
+        NSLog("PiP - %@", message())
+        #endif
+    }
+}