RxMediaPicker
RxMediaPicker is a RxSwift wrapper built around UIImagePickerController consisting in a simple interface for common actions like picking photos or videos stored on the device, recording a video or taking a photo.
If you ever used UIImagePickerController you know how it can become quite verbose and introduce some unnecessary complexity, as you use the same class to do everything, from picking photos or videos from the library, recording videos, etc. At the same time, you have all these different properties and methods which can be used when you are dealing with photos, others for when you're dealing with videos, and others in all cases.
If you're interested, check the resulting article RxMediaPickerโโโpicking photos and videos the cool kidsโ way!
Note: As RxMediaPicker is still in its early days, the interface may change in future versions.
Features
- Reactive wrapper built around UIImagePickerController.
- Provides an interface for common operations like picking photos from the library, recording videos, etc.
- Handles edited videos properly - something UIImagePickerController doesn't do for you!
- Decouples the typical UIImagePickerController boilerplate from your code.
- Reduces the complexity when compared to UIImagePickerController.
- Easy to integrate and reuse accross your app.
Example
For a more complete example please check the demo app included (ideally run it on a device). This is how you would record a video using the camera:
import RxMediaPicker
import RxSwift
var picker: RxMediaPicker!
let disposeBag = DisposeBag()
override func viewDidLoad() {
super.viewDidLoad()
picker = RxMediaPicker(delegate: self)
}
func recordVideo() {
picker.recordVideo(maximumDuration: 10, editable: true)
.observeOn(MainScheduler.instance)
.subscribe(onNext: { url in
// Do something with the video url obtained!
}, onError: { error in
print("Error occurred!")
}, onCompleted: {
print("Completed")
}, onDisposed: {
print("Disposed")
})
.disposed(by: disposeBag)
}
Usage
Available operations
Based on their names, the operations available on RxMediaPicker should be self-explanatory. You can record a video, or pick an existing one stored on the device, and the same thing happens for photos. The only thing to note here is that picking a video will get you the video url, and picking a photo will get you a tuple consisting in the original image and an optional edited image (if any edits were made).
func recordVideo(device: UIImagePickerController.CameraDevice = .rear,
quality: UIImagePickerController.QualityType = .typeMedium,
maximumDuration: TimeInterval = 600,
editable: Bool = false) -> Observable<URL>
func selectVideo(source: UIImagePickerController.SourceType = .photoLibrary,
maximumDuration: TimeInterval = 600,
editable: Bool = false) -> Observable<URL>
func takePhoto(device: UIImagePickerController.CameraDevice = .rear,
flashMode: UIImagePickerController.CameraFlashMode = .auto,
editable: Bool = false) -> Observable<(UIImage, UIImage?)>
func selectImage(source: UIImagePickerController.SourceType = .photoLibrary,
editable: Bool = false) -> Observable<(UIImage, UIImage?)>
RxMediaPickerDelegate
func present(picker: UIImagePickerController)
func dismiss(picker: UIImagePickerController)
To be able to use RxMediaPicker you will need to adopt the protocol RxMediaPickerDelegate. This is required to indicate RxMediaPicker how the camera/photos picker should be presented. For example, you may want to present the photos library picker in a popover on the iPad, and use the entire screen on the iPhone.
Requirements
- iOS 8.0+
- Xcode 7.0+
Instalation
CocoaPods
CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:
$ gem install cocoapods
To integrate RxMediaPicker into your Xcode project using CocoaPods, include this in your Podfile:
platform :ios, '8.0'
use_frameworks!
pod 'RxMediaPicker'
Carthage
Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with Homebrew using the following command:
$ brew update
$ brew install carthage
To integrate RxMediaPicker into your Xcode project using Carthage, specify it in your Cartfile
:
github "RxSwiftCommunity/RxMediaPicker" "master"
Run carthage
to build the framework and drag the built RxMediaPicker.framework
into your Xcode project.
Swift Package Manager
Create a Package.swift
file.
// swift-tools-version:5.0
import PackageDescription
let package = Package(
name: "YOUR_PROJECT_NAME",
dependencies: [
.package(url: "https://github.com/RxSwiftCommunity/RxMediaPicker.git", from: "2.0.0")
],
targets: [
.target(name: "YOUR_PROJECT_NAME", dependencies: ["RxMediaPicker"])
]
)
Credits
Owned and maintained by Rui Costa (@ruipfcosta).
Contributing
Bug reports and pull requests are welcome.
License
RxMediaPicker is released under the MIT license. See LICENSE for details.