@tiledev/sdk-apptile-live-selling 0.2.5 → 0.3.0

package/ios/LivePipController.swift

@@ -1,327 +0,0 @@
-import AVKit
-import ZegoExpressEngine
-
-/// Frame pipeline and PIP window for the live stream.
-///
-/// Why this exists at all: the React Native Zego wrapper exposes no picture-in-picture, and iOS
-/// cannot put a live stream in a PIP window without a sample-buffer layer to hand AVKit. The
-/// engine's own `ZegoTextureView` is not one, so the frames have to be intercepted.
-///
-/// The trick that keeps this small is `enableEngineRender`: the engine keeps drawing into the
-/// texture view exactly as before *and* calls us back with each frame. Without it, custom
-/// rendering replaces engine rendering outright and every surface in the app would have to be
-/// rewritten around this layer.
-final class LivePipController: NSObject {
-  static let shared = LivePipController()
-
-  /// `(eventName, payload)`. Set by the module; the controller never assumes a listener.
-  var onEvent: ((String, [String: Any]) -> Void)?
-
-  private var displayLayer: AVSampleBufferDisplayLayer?
-  private var pipController: AVPictureInPictureController?
-  private var hostView: UIView?
-  private var streamID: String?
-  private var configured = false
-  private var armed = false
-  /// Set between `restoreUserInterfaceForPictureInPictureStop` and `didStop`, which is the only
-  /// way to tell "the user expanded the window" from "the user closed it" — both end in `didStop`.
-  private var restoring = false
-
-  // MARK: - Engine wiring
-
-  /// `sharedEngine` is annotated non-null, so Swift imports it as non-optional — but it really does
-  /// return nil until `createEngine` has run, and every entry point here can be reached before
-  /// that. Laundering it through an optional restores the check the annotation removed.
-  private static func engine() -> ZegoExpressEngine? {
-    let candidate: ZegoExpressEngine? = ZegoExpressEngine.shared()
-    return candidate
-  }
-
-  /// Turns on custom rendering. Must run after the engine exists and before the first
-  /// `startPlayingStream`: the SDK only accepts this configuration while nothing is playing.
-  func configure() throws {
-    if configured { return }
-    guard let engine = Self.engine() else {
-      throw LivePipError.engineMissing
-    }
-
-    let config = ZegoCustomVideoRenderConfig()
-    config.bufferType = .cvPixelBuffer
-    config.frameFormatSeries = .RGB
-    // The whole reason the app's existing video path survives this feature.
-    config.enableEngineRender = true
-
-    engine.enableCustomVideoRender(true, config: config)
-    engine.setCustomVideoRenderHandler(self)
-    configured = true
-  }
-
-  /// The stream whose frames feed the PIP window. Pass nil when playback stops.
-  func setStream(_ id: String?) {
-    if streamID == id { return }
-    // Stop the old stream's callbacks before switching, or a cohost swap leaves both feeding.
-    if let previous = streamID, let engine = Self.engine() {
-      engine.enableRemoteVideoCustomVideoRender(false, streamID: previous)
-    }
-    streamID = id
-    applyFrameCallbacks()
-  }
-
-  /// Per-stream rather than global: the frame callback copies every frame out of the engine, so it
-  /// stays off until a PIP window is actually wanted.
-  private func applyFrameCallbacks() {
-    guard let id = streamID, let engine = Self.engine() else { return }
-    engine.enableRemoteVideoCustomVideoRender(armed, streamID: id)
-  }
-
-  // MARK: - PIP lifecycle
-
-  /// Arming is what makes backgrounding the app hand over to a system PIP window: iOS starts it
-  /// itself through `canStartPictureInPictureAutomaticallyFromInline`, with no JavaScript running
-  /// at that moment. Nothing else produces a seamless handoff — by the time a background
-  /// notification reaches JS the transition has already been missed.
-  func setArmed(_ next: Bool) {
-    if armed == next { return }
-    armed = next
-    applyFrameCallbacks()
-
-    onMain { [weak self] in
-      guard let self else { return }
-      if next {
-        self.buildController()
-      } else {
-        self.teardownController()
-      }
-    }
-  }
-
-  func start() {
-    onMain { [weak self] in
-      guard let self, let controller = self.pipController else { return }
-      if self.restoring { return }
-      if controller.isPictureInPictureActive { return }
-      controller.startPictureInPicture()
-    }
-  }
-
-  func stop() {
-    onMain { [weak self] in
-      guard let self, let controller = self.pipController else { return }
-      if controller.isPictureInPictureActive { controller.stopPictureInPicture() }
-    }
-  }
-
-  private func buildController() {
-    let layer = displayLayer ?? makeDisplayLayer()
-    displayLayer = layer
-
-    if pipController == nil {
-      let source = AVPictureInPictureController.ContentSource(
-        sampleBufferDisplayLayer: layer,
-        playbackDelegate: self
-      )
-      let controller = AVPictureInPictureController(contentSource: source)
-      controller.delegate = self
-      controller.canStartPictureInPictureAutomaticallyFromInline = true
-      pipController = controller
-    } else {
-      pipController?.canStartPictureInPictureAutomaticallyFromInline = true
-    }
-  }
-
-  private func teardownController() {
-    if let controller = pipController, controller.isPictureInPictureActive {
-      controller.stopPictureInPicture()
-    }
-    pipController?.canStartPictureInPictureAutomaticallyFromInline = false
-    pipController = nil
-    displayLayer?.flushAndRemoveImage()
-    displayLayer?.removeFromSuperlayer()
-    displayLayer = nil
-    hostView?.removeFromSuperview()
-    hostView = nil
-    restoring = false
-  }
-
-  /// AVKit will not start PIP for a layer that is not in a window, so the layer gets a 1×1 host in
-  /// the corner of the key window, behind everything. It is a real, attached, on-screen layer —
-  /// just too small to notice. Rendering it into the app's actual video view instead would draw a
-  /// second copy of the stream over the engine's own.
-  private func makeDisplayLayer() -> AVSampleBufferDisplayLayer {
-    let layer = AVSampleBufferDisplayLayer()
-    layer.videoGravity = .resizeAspect
-    layer.frame = CGRect(x: 0, y: 0, width: 1, height: 1)
-
-    let host = UIView(frame: CGRect(x: 0, y: 0, width: 1, height: 1))
-    host.isUserInteractionEnabled = false
-    host.layer.addSublayer(layer)
-    hostView = host
-
-    if let window = Self.keyWindow() {
-      window.insertSubview(host, at: 0)
-    }
-    return layer
-  }
-
-  private static func keyWindow() -> UIWindow? {
-    UIApplication.shared.connectedScenes
-      .compactMap { $0 as? UIWindowScene }
-      .first { $0.activationState == .foregroundActive }?
-      .windows.first { $0.isKeyWindow }
-      ?? UIApplication.shared.connectedScenes
-        .compactMap { $0 as? UIWindowScene }
-        .flatMap { $0.windows }
-        .first
-  }
-
-  private func onMain(_ work: @escaping () -> Void) {
-    if Thread.isMainThread { work() } else { DispatchQueue.main.async(execute: work) }
-  }
-}
-
-// MARK: - Frames
-
-extension LivePipController: ZegoCustomVideoRenderHandler {
-  func onRemoteVideoFrameCVPixelBuffer(
-    _ buffer: CVPixelBuffer,
-    param: ZegoVideoFrameParam,
-    streamID: String
-  ) {
-    guard armed, streamID == self.streamID, let layer = displayLayer else { return }
-    guard let sample = Self.makeSampleBuffer(from: buffer) else { return }
-
-    layer.enqueue(sample)
-    // -11847 is "layer failed while detached"; it sticks until the layer is rebuilt, so a silent
-    // black PIP window is the alternative to noticing it here.
-    if layer.status == .failed {
-      layer.flush()
-    }
-  }
-
-  private static func makeSampleBuffer(from pixelBuffer: CVPixelBuffer) -> CMSampleBuffer? {
-    var formatDescription: CMVideoFormatDescription?
-    guard
-      CMVideoFormatDescriptionCreateForImageBuffer(
-        allocator: kCFAllocatorDefault,
-        imageBuffer: pixelBuffer,
-        formatDescriptionOut: &formatDescription
-      ) == noErr,
-      let format = formatDescription
-    else { return nil }
-
-    // A live stream has no timeline to seek, so the frames carry no timestamps and are shown as
-    // they arrive; `kCMSampleAttachmentKey_DisplayImmediately` is what makes that legal.
-    var timing = CMSampleTimingInfo(
-      duration: .invalid,
-      presentationTimeStamp: .invalid,
-      decodeTimeStamp: .invalid
-    )
-    var sampleBuffer: CMSampleBuffer?
-    guard
-      CMSampleBufferCreateForImageBuffer(
-        allocator: kCFAllocatorDefault,
-        imageBuffer: pixelBuffer,
-        dataReady: true,
-        makeDataReadyCallback: nil,
-        refcon: nil,
-        formatDescription: format,
-        sampleTiming: &timing,
-        sampleBufferOut: &sampleBuffer
-      ) == noErr,
-      let sample = sampleBuffer
-    else { return nil }
-
-    if
-      let attachments = CMSampleBufferGetSampleAttachmentsArray(sample, createIfNecessary: true),
-      CFArrayGetCount(attachments) > 0
-    {
-      let raw = CFArrayGetValueAtIndex(attachments, 0)
-      let dictionary = unsafeBitCast(raw, to: CFMutableDictionary.self)
-      CFDictionarySetValue(
-        dictionary,
-        Unmanaged.passUnretained(kCMSampleAttachmentKey_DisplayImmediately).toOpaque(),
-        Unmanaged.passUnretained(kCFBooleanTrue).toOpaque()
-      )
-    }
-
-    return sample
-  }
-}
-
-// MARK: - AVPictureInPictureControllerDelegate
-
-extension LivePipController: AVPictureInPictureControllerDelegate {
-  func pictureInPictureControllerDidStartPictureInPicture(
-    _ pictureInPictureController: AVPictureInPictureController
-  ) {
-    onEvent?("onPipStart", [:])
-  }
-
-  func pictureInPictureController(
-    _ pictureInPictureController: AVPictureInPictureController,
-    failedToStartPictureInPictureWithError error: Error
-  ) {
-    restoring = false
-    onEvent?("onPipError", ["message": error.localizedDescription])
-  }
-
-  func pictureInPictureController(
-    _ pictureInPictureController: AVPictureInPictureController,
-    restoreUserInterfaceForPictureInPictureStopWithCompletionHandler completionHandler: @escaping (
-      Bool
-    ) -> Void
-  ) {
-    restoring = true
-    onEvent?("onPipRestore", [:])
-    completionHandler(true)
-  }
-
-  func pictureInPictureControllerDidStopPictureInPicture(
-    _ pictureInPictureController: AVPictureInPictureController
-  ) {
-    let restored = restoring
-    restoring = false
-    onEvent?("onPipStop", ["restored": restored])
-  }
-}
-
-// MARK: - AVPictureInPictureSampleBufferPlaybackDelegate
-
-extension LivePipController: AVPictureInPictureSampleBufferPlaybackDelegate {
-  func pictureInPictureController(
-    _ pictureInPictureController: AVPictureInPictureController,
-    setPlaying playing: Bool
-  ) {
-    // A live stream cannot pause, so the play/pause button is a no-op rather than a lie about state.
-  }
-
-  func pictureInPictureControllerTimeRangeForPlayback(
-    _ pictureInPictureController: AVPictureInPictureController
-  ) -> CMTimeRange {
-    // Infinite: this is what makes AVKit render live controls instead of a scrubber.
-    CMTimeRange(start: .zero, duration: .positiveInfinity)
-  }
-
-  func pictureInPictureControllerIsPlaybackPaused(
-    _ pictureInPictureController: AVPictureInPictureController
-  ) -> Bool {
-    false
-  }
-
-  func pictureInPictureController(
-    _ pictureInPictureController: AVPictureInPictureController,
-    didTransitionToRenderSize newRenderSize: CMVideoDimensions
-  ) {}
-
-  func pictureInPictureController(
-    _ pictureInPictureController: AVPictureInPictureController,
-    skipByInterval skipInterval: CMTime,
-    completion completionHandler: @escaping () -> Void
-  ) {
-    completionHandler()
-  }
-}
-
-enum LivePipError: Error {
-  case engineMissing
-}

package/ios/LivePipModule.swift

@@ -1,35 +0,0 @@
-import ExpoModulesCore
-
-public class LivePipModule: Module {
-  public func definition() -> ModuleDefinition {
-    Name("LivePip")
-
-    Events("onPipStart", "onPipStop", "onPipRestore", "onPipError")
-
-    OnCreate {
-      LivePipController.shared.onEvent = { [weak self] name, payload in
-        self?.sendEvent(name, payload)
-      }
-    }
-
-    AsyncFunction("configure") {
-      try LivePipController.shared.configure()
-    }
-
-    AsyncFunction("setStream") { (streamId: String?) in
-      LivePipController.shared.setStream(streamId)
-    }
-
-    AsyncFunction("setArmed") { (armed: Bool) in
-      LivePipController.shared.setArmed(armed)
-    }
-
-    AsyncFunction("start") {
-      LivePipController.shared.start()
-    }
-
-    AsyncFunction("stop") {
-      LivePipController.shared.stop()
-    }
-  }
-}

package/plugin/build/index.d.ts

@@ -1,29 +0,0 @@
-import { type ConfigPlugin } from 'expo/config-plugins';
-/**
- * Everything a prebuilt project needs for live selling that a library cannot declare for itself.
- *
- * All four of these live in files `expo prebuild` regenerates — `android/build.gradle`,
- * `AndroidManifest.xml`, `Info.plist` — so an edit made by hand survives exactly until the next native
- * build. That is the worst kind of failure: it works on the machine that set it and silently stops
- * working in CI.
- */
-export interface LiveSellingPluginProps {
-    /**
-     * Whether to set up system picture-in-picture. Default true.
-     *
-     * Off still leaves the Zego repository and the permission strings, which the SDK needs regardless.
-     */
-    pip?: boolean;
-    /** Shown verbatim by iOS when the camera is first opened. Co-hosting needs it. */
-    cameraPermission?: string;
-    microphonePermission?: string;
-    /**
-     * Add CAMERA and RECORD_AUDIO on Android. Default true.
-     *
-     * Worth keeping even on a viewer-only build: Zego links both APIs, and App Store validation rejects
-     * the upload (ITMS-90683) on the linked symbols alone.
-     */
-    capturePermissions?: boolean;
-}
-declare const withLiveSelling: ConfigPlugin<LiveSellingPluginProps | void>;
-export default withLiveSelling;

package/plugin/build/index.js

@@ -1,101 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const config_plugins_1 = require("expo/config-plugins");
-const DEFAULT_CAMERA = 'Used to appear on camera when you join a live show as a guest.';
-const DEFAULT_MICROPHONE = 'Used to be heard when you join a live show as a guest.';
-/** Idempotence marker: a second prebuild must not append the block again. */
-const ZEGO_MARKER = '// @generated by @tiledev/sdk-apptile-live-selling';
-/**
- * Zego's own Maven repository.
- *
- * `zego-express-engine-reactnative` declares `im.zego:express-video`, which lives only on
- * `storage.zego.im/maven` — not Google, Maven Central or JitPack. The library's own build.gradle names
- * that repo, but Gradle resolves a subproject's runtime dependencies with the *consuming* project's
- * repositories, so `:app:debugRuntimeClasspath` searches only what the root script declares and fails
- * at configuration time with "Could not find im.zego:express-video" on a clean checkout —
- * unconditionally, for whoever next runs `expo run:android`.
- */
-const ZEGO_REPO_BLOCK = `
-${ZEGO_MARKER}
-allprojects {
-  repositories {
-    maven { url "https://storage.zego.im/maven" }
-  }
-}
-`;
-const withZegoMavenRepo = (config) => (0, config_plugins_1.withProjectBuildGradle)(config, (inner) => {
-    if (inner.modResults.language !== 'groovy') {
-        throw new Error(`@tiledev/sdk-apptile-live-selling expects a Groovy android/build.gradle; got ${inner.modResults.language}`);
-    }
-    if (!inner.modResults.contents.includes(ZEGO_MARKER)) {
-        inner.modResults.contents += ZEGO_REPO_BLOCK;
-    }
-    return inner;
-});
-/**
- * The configuration a PIP transition changes.
- *
- * Anything not listed here recreates the activity instead of resizing it — which means the React host
- * restarts on the way into the window, so the stream drops and the PIP window shows a fresh launch.
- * `smallestScreenSize` is the one prebuild does not already write, and it is the one that matters:
- * entering PIP is exactly a change of smallest width.
- */
-const REQUIRED_CONFIG_CHANGES = [
-    'screenSize',
-    'smallestScreenSize',
-    'screenLayout',
-    'orientation',
-];
-/**
- * `android:supportsPictureInPicture` is an attribute of the *activity*, and the activity belongs to
- * the app — a library manifest cannot add it, which is why this is a plugin at all.
- */
-const withLivePipAndroid = (config) => (0, config_plugins_1.withAndroidManifest)(config, (inner) => {
-    var _a;
-    const activity = config_plugins_1.AndroidConfig.Manifest.getMainActivityOrThrow(inner.modResults);
-    activity.$['android:supportsPictureInPicture'] = 'true';
-    // Merged rather than replaced: prebuild's own list carries `keyboard`, `uiMode` and friends, and
-    // dropping those would recreate the activity when the keyboard opens.
-    const declared = ((_a = activity.$['android:configChanges']) !== null && _a !== void 0 ? _a : '').split('|').filter(Boolean);
-    for (const change of REQUIRED_CONFIG_CHANGES) {
-        if (!declared.includes(change))
-            declared.push(change);
-    }
-    activity.$['android:configChanges'] = declared.join('|');
-    return inner;
-});
-/**
- * `UIBackgroundModes: ["audio"]` is what keeps a system PIP window alive: without it iOS suspends the
- * app and the window freezes on its last frame within seconds.
- */
-const withLivePipIos = (config, props) => (0, config_plugins_1.withInfoPlist)(config, (inner) => {
-    var _a, _b, _c, _d;
-    const plist = inner.modResults;
-    if (props.pip !== false) {
-        const modes = new Set(Array.isArray(plist.UIBackgroundModes) ? plist.UIBackgroundModes : []);
-        modes.add('audio');
-        plist.UIBackgroundModes = Array.from(modes);
-    }
-    // Not overwritten when the app already sets its own — a host that has written brand-specific copy
-    // means it, and Apple shows these strings verbatim.
-    plist.NSCameraUsageDescription =
-        (_b = (_a = plist.NSCameraUsageDescription) !== null && _a !== void 0 ? _a : props.cameraPermission) !== null && _b !== void 0 ? _b : DEFAULT_CAMERA;
-    plist.NSMicrophoneUsageDescription =
-        (_d = (_c = plist.NSMicrophoneUsageDescription) !== null && _c !== void 0 ? _c : props.microphonePermission) !== null && _d !== void 0 ? _d : DEFAULT_MICROPHONE;
-    return inner;
-});
-const withCapturePermissions = (config) => config_plugins_1.AndroidConfig.Permissions.withPermissions(config, [
-    'android.permission.CAMERA',
-    'android.permission.RECORD_AUDIO',
-]);
-const withLiveSelling = (config, props) => {
-    const options = props !== null && props !== void 0 ? props : {};
-    let next = withZegoMavenRepo(config);
-    next = withLivePipIos(next, options);
-    if (options.pip !== false)
-        next = withLivePipAndroid(next);
-    if (options.capturePermissions !== false)
-        next = withCapturePermissions(next);
-    return next;
-};
-exports.default = withLiveSelling;