flutter_in_app_pip 1.0.0

A Flutter Package to easily implement in-app pip in a flutter application.

In App PiP for Flutter

A Flutter Package to help easily implement in-app PiP(Picture in Picture) in a flutter application. Written completely in dart.

Features

Easily Implement PiP(Picture in Picture) in app.

Automatically Handle showing different widgets in the original view when in pip and when not in pip.

Provides the ability to update the size of the pip widget later after starting pip.

Getting started

Import the package.

Replace your MaterialApp with PiPMaterialApp.

Optionally provide the pipHeight and pipWidth parameters. These correspond to the height and width of your pip widget.

Usage

After replacing your MaterialApp with PiPMaterialApp, use

 PictureInPicture.startPiP(pipWidget: MyPiPWidget());

to start PiP view in your app.

When you wish to stop PiP, use

PictureInPicture.stopPiP();

Use PiPWidget for additional functionalities like handling events on close of pip e.g.

PictureInPicture.startPiP(
    pipWidget:PiPWidget(child: ChildWidget(),onPiPClose: (){
      //Handle closing events e.g. dispose controllers.
      
    },)
);

Additonally, you can also use PiPCapableWidget to handle the view changes in case of PiP start and stop e.g.

PiPCapableWidget(
    whileNotInPip: ChildToShowWhileNotInPiP(),
    whileInPip: ChildToShowWhileInPiP(),
);

Update the size of the pip view like below:

PictureInPicture.updatePiPWindowSize(height: height, width: width);

Note

Please do not use the builder property of the PiPMarterialApp.

That's it. Enjoy!