livekit_pip

Native system Picture-in-Picture (PiP) for LiveKit video calls on Android and iOS.

Features

• Android — PiP via PictureInPictureParams; auto-enter on API 31+, manual enter on API 26–30. Consumer supplies a Flutter widget rendered inside the PiP window (full grid layout supported).
• iOS — PiP via AVPictureInPictureController with a native AVSampleBufferDisplayLayer; shows the dominant/active speaker. Optional local-participant self-view inset via pixel-buffer composition.
• PipState stream (unsupported → inactive → entering → active → exiting) for UI-driven reactions.
• Auto-enter on app background, configurable per platform.

Platform requirements

Android setup

In your call Activity inside AndroidManifest.xml:

android:supportsPictureInPicture="true"
android:configChanges="screenSize|smallestScreenSize|screenLayout|orientation"

Either extend LiveKitPipActivity or call PipHelper.attach(activity) manually.

iOS setup

In Info.plist, add voip (and optionally audio) to UIBackgroundModes:

<key>UIBackgroundModes</key>
<array>
  <string>voip</string>
  <string>audio</string>
</array>

For self-view in PiP on iOS 17 and below, add the multitasking camera access entitlement:

<key>com.apple.developer.avfoundation.multitasking-camera-access</key>
<true/>

Usage

import 'package:livekit_pip/livekit_pip.dart';

final pip = LiveKitPip();

await pip.initialize(
  room: room,
  config: LiveKitPipConfiguration(
    android: AndroidPipConfiguration(
      pipWidgetBuilder: (context, room) => MyCallGridWidget(room: room),
    ),
    ios: IosPipConfiguration(
      includeLocalParticipantVideo: true,
    ),
  ),
);

// Place once in your call widget tree (required for iOS; no-op on Android)
LiveKitPipView(room: room)

// Enter PiP manually
await pip.enterPiP();

// React to state changes
pip.stateStream.listen((state) {
  if (state == PipState.active) {
    // hide call controls
  }
});

// Clean up
await pip.dispose();

Prerequisite: The LiveKit Room must stay connected in the background. Do not disconnect on app lifecycle background events.

Federated plugin packages