Skip to main content
Version: 0.23.0

Variable: PipContainerView

const PipContainerView: ForwardRefExoticComponent<PipContainerViewProps & RefAttributes<PipContainerViewRef>>

Defined in: packages/react-native-client/src/components/PipContainerView.tsx:55

A view component for Picture-in-Picture functionality with split-screen layout.

Automatically displays:

  • Primary view (left): Local camera track or placeholder text
  • Secondary view (right): Remote track with active VAD (voice activity) or placeholder text

Use a ref to call methods on this component:

const pipRef = useRef<PipContainerViewRef>(null); // Start PiP manually (if startAutomatically is false) await pipRef.current?.startPictureInPicture(); // Stop PiP manually await pipRef.current?.stopPictureInPicture();

Param

Whether to start PiP automatically when app goes to background (default: true)

Param

Whether to stop PiP automatically when app comes to foreground (default: true)

Param

Whether to allow camera to continue running in PiP mode (default: false, iOS only)

Param

Text to display when local camera is unavailable (default: "No camera")

Param

Text to display when no remote speaker is active (default: "No active speaker")