https://github.com/insidegui/pipcontainer

An easy to use interface for picture-in-picture on macOS 10.12 and later
https://github.com/insidegui/pipcontainer

macos macos-sierra picture-in-picture pip swift

Last synced: about 2 months ago
JSON representation

An easy to use interface for picture-in-picture on macOS 10.12 and later

• Host: GitHub
• URL: https://github.com/insidegui/pipcontainer
• Owner: insidegui
• License: bsd-2-clause
• Created: 2016-12-26T11:53:35.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-10-01T14:16:04.000Z (about 6 years ago)
• Last Synced: 2024-03-15T03:34:20.138Z (9 months ago)
• Topics: macos, macos-sierra, picture-in-picture, pip, swift
• Language: Objective-C
• Size: 1.89 MB
• Stars: 113
• Watchers: 7
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PIPContainer

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![CocoaPods](https://img.shields.io/cocoapods/v/PIPContainer.svg)]()

An `NSViewController` subclass that can present its child view controller in picture-in-picture mode.

Please note that this project links against `PIP.framework`, which is private. Don't try to submit apps using this to the App Store.

![demo](./Screenshots/pipdemo.gif)

# Integration

## Carthage

Add the following line to your `Cartfile` and follow the [integration instructions for Carthage](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application):

```

github "insidegui/PIPContainer" ~> 1.0

```

## CocoaPods

Add the following line to your `Podfile` and then run `pod install`:

```

pod 'PIPContainer'

```

## Manually

Drag `PIPContainer.xcodeproj` to your project and add `PIPContainer.framework` to the `Embedded Binaries` section.

![manual integration](./Screenshots/embedded-binaries.png)

# Usage

## Containment

The way it works is you add the view controller you want to display in the PiP as a child view controller of `PIPContainerViewController`. This can all be done using storyboards ([see demos](./Demo)).

![storyboard containment](./Screenshots/containment.png)

## Entering and Exiting PiP mode

After you have the correct containment setup, simply call `togglePIP` on `PIPContainerViewController` to enter/exit PiP mode.

```swift

private var pip: PIPContainerViewController? {

    return parent as? PIPContainerViewController

}

    

func togglePictureInPictureMode() {

    pip?.togglePIP(nil)

}

```

You can also link UI controls like buttons and menus directly to the `togglePIP` action in Interface Builder by control-dragging to the First Responder and selecting the action `togglePIP:`.

## Getting notified about PiP commands

`PIPContainerViewController` has many block properties that you can use to get notifications about state changes.

- `pipDidPause`: Called when the pause button is pressed in the PiP panel

- `pipDidPlay`: Called when the play button is pressed in the PiP panel

- `pipWillOpen`: Called when the PiP panel is about to be opened. This is the best moment to set the `isPlaying` property of `PIPContainerViewController` to reflect the state of your player

- `pipWillClose`: Called when the PiP panel is about to be closed

- `pipDidClose`: Called after the PiP panel is closed and the view controller is back to its original position

## Demos

I encourage you to have a look at the demos to get a better understanding of how PIPContainer works:

- [ObjC demo](./Demo/ObjC)

- [Swift demo](./Demo/Swift)