Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kofktu/pipkit
Picture in Picture for iOS
https://github.com/kofktu/pipkit
carthage cocoapods pip swift
Last synced: 1 day ago
JSON representation
Picture in Picture for iOS
- Host: GitHub
- URL: https://github.com/kofktu/pipkit
- Owner: Kofktu
- License: mit
- Created: 2018-12-07T08:16:38.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-22T05:57:53.000Z (2 months ago)
- Last Synced: 2024-12-15T13:03:16.850Z (8 days ago)
- Topics: carthage, cocoapods, pip, swift
- Language: Swift
- Size: 16.7 MB
- Stars: 288
- Watchers: 9
- Forks: 39
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PIPKit
[](http://cocoapods.org/?q=name%3APIPKit%20author%3AKofktu)
[](https://github.com/Carthage/Carthage)
- Picture in Picture for iOS (iPhone, iPad)
## Requirements
- iOS 8.0+
- Swift 5.0
- Xcode 11
## Installation
#### CocoaPods
PIPKit is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod 'PIPKit'
```
#### Carthage
For iOS 8+ projects with [Carthage](https://github.com/Carthage/Carthage)
```
github "Kofktu/PIPKit"
```
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler. It is in early development, but Alamofire does support its use on supported platforms.
Once you have your Swift package set up, adding `PIPKit` as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
```swift
dependencies: [
.package(url: "https://github.com/Kofktu/PIPKit.git", .upToNextMajor(from: "1.0.0"))
]
```
## Usage
#### PIPUsable
```swift
public protocol PIPUsable {
var initialState: PIPState { get }
var initialPosition: PIPPosition { get }
var insetsPIPFromSafeArea: Bool { get }
var pipEdgeInsets: UIEdgeInsets { get }
var pipSize: CGSize { get }
var pipShadow: PIPShadow? { get }
var pipCorner: PIPCorner? { get }
func didChangedState(_ state: PIPState)
func didChangePosition(_ position: PIPPosition)
}
```
#### PIPKit
```swift
class PIPKit {
var isPIP: Bool
var isActive: Bool
var visibleViewController: PIPKitViewController?
class func show(with viewController: PIPKitViewController, completion: (() -> Void)? = nil)
class func dismiss(animated: Bool, completion: (() -> Void)? = nil)
}
```
#### PIPKitViewController (UIViewController & PIPUsable)
```swift
func setNeedsUpdatePIPFrame()
func startPIPMode()
func stopPIPMode()
```
## At a Glance
#### Show & Dismiss
```swift
class PIPViewController: UIViewController, PIPUsable {}
let viewController = PIPViewController()
PIPKit.show(with: viewController)
PIPKit.dismiss(animated: true)
```
#### Update PIPSize
```swift
class PIPViewController: UIViewController, PIPUsable {
func updatePIPSize() {
pipSize = CGSize()
pipEdgeInsets = UIEdgeInsets()
setNeedsUpdatePIPFrame()
}
}
```
#### FullScreen <-> PIP Mode
```swift
class PIPViewController: UIViewController, PIPUsable {
func fullScreenAndPIPMode() {
if PIPKit.isPIP {
stopPIPMode()
} else {
startPIPMode()
}
}
func didChangedState(_ state: PIPState) {}
}
```
## AVPIPKitUsable
UIView that is capable of Picture-in-Picture in iOS (AVKit.framework)
### Requirements
- iOS 15 or higher
- Info.plist - `Audio, AirPlay and Picture in Picture` in `Background Modes`. For more information, see [Apple Documentation](https://developer.apple.com/documentation/avfoundation/media_playback_and_selection/creating_a_basic_video_player_ios_and_tvos/enabling_background_audio)
### At a Glance
```swift
var PIPKit.isAVPIPKitSupported: Bool
```
#### AVPIPKitRenderer
```swift
protocol AVPIPKitRenderer {
var policy: AVPIPKitRenderPolicy { get }
var renderPublisher: AnyPublisher { get }
func start()
func stop()
}
```
#### AVPIPUIKitUsable
```swift
class View: UIView, AVPIPUIKitUsable {
var pipTargetView: UIView { self } // Return the subview that you want to show.
var renderPolicy: AVPIPKitRenderPolicy {
// .once - only once render
// .preferredFramesPerSecond - render in frames-per-second
}
}
view.startPictureInPicture()
view.stopPictureInPicture()
class ViewController: UIViewController, AVPIPUIKitUsable {
var pipTargetView: UIView { view } // Return the subview that you want to show.
func start() {
startPictureInPicture()
}
func stop() {
stopPictureInPicture()
}
}
```
## References
- UIPiPDemo (https://github.com/uakihir0/UIPiPDemo)
## Authors
Taeun Kim (kofktu),
## License
PIPKit is available under the ```MIT``` license. See the ```LICENSE``` file for more info.