Swift Objective-C
Switch branches/tags
Latest commit 2a87e4a Dec 13, 2017 @AFathi AFathi Update README.md

README.md

ARVideoKit

An iOS Framework that enables developers to capture videos πŸ“Ή, photos πŸŒ„, Live Photos πŸŽ‡, and GIFs πŸŽ† with ARKit content.

In other words, you NO LONGER have to screen record/screenshot to capture videos πŸ“Ή and photos πŸŒ„ of your awesome ARKit apps!

Table of Contents Description
Documentation Describes the configuration options ARVideoKit offers
Preview Displays 2 GIF images captured using the supported gif method in ARVideoKit
Key Features Lists the key features ARVideoKit offers
Compatibility Describes the ARVideoKit device and iOS compatibality
Example Project Explains how to run the example project provided in this repository
Installation Describes the Manual option to install ARVideoKit
Implementation Lists the steps needed, notes, and reference for more options
Publishing to the App Store Describes the steps required before submitting an application using ARVideoKit to the App Store.
Donate Donations will help me to keep maintaining ARVideoKit and open source it to everyone soon ❀️
License Describes ARVideoKit license
AppCoda Tutorial Check out the detailed tutorial about implementing ARVideoKit with SpriteKit ☺️

Preview

πŸ‘Ύ Initialized with SpriteKitπŸ‘‡ ‍‍‍‍‍‍ ‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ πŸš€ Initialized with SceneKit πŸ‘‡ ‍‍‍‍‍‍ ‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍ ‍‍ ‍‍‍‍‍‍ ‍‍

SpriteKit Preview SceneKit Preview

Key Features

βœ… Capture Photos from ARSCNView and ARSKView

βœ… Capture Live Photos & GIFs from ARSCNView and ARSKView

βœ… Record Videos from ARSCNView and ARSKView

βœ… Pause/Resume video

βœ… Allow device's Music playing in the background while recording a video

βœ… Returns rendered and raw buffers in a protocol method for additional Image & Video processing

Compatibility

ARVideoKit is compatible on iOS devices that support both ARKit and Metal. Check Apple's iOS Device Compatibility Reference for more information.

ARVideoKit requires:

  • iOS 11
  • Swift 3.2 or higher

Example Project

To try the example project, simply clone this repository and open ARVideoKit-Example.xcodeproj project file.

It's recommended to test SKViewController by assigning it as the initial view controller. is initial VC

Installation

Manual

Drag the ARVideoKit.framework file as an embedded binary of your project targets. ARVideoKit.framework can be found in the /Framework/ folder of this repository. Tutorial

Implementation

  1. import ARVideoKit in the application delegate AppDelegate.swift and a UIViewController with an ARKit scene.

  2. In the application delegate AppDelegate.swift, add this πŸ‘‡ in order to allow the framework access and identify the supported device orientations. Recommended if the application supports landscape orientations.

func application(_ application: UIApplication, supportedInterfaceOrientationsFor window: UIWindow?) -> UIInterfaceOrientationMask {
return ViewAR.orientation
}
  1. In the selected UIViewController class, create an optional type RecordAR global variable.
var recorder:RecordAR?
  1. Initialize RecordAR with ARSCNView or ARSKView. Recommended to initialize in viewDidLoad().

Initializing RecordAR with ARSCNView

recorder = RecordAR(ARSceneKit: sceneView)

Initializing RecordAR with ARSKView

recorder = RecordAR(ARSpriteKit: SKSceneView)
  1. Call the prepare() method in viewWillAppear(_ animated: Bool)
let configuration = ARWorldTrackingConfiguration()
recorder?.prepare(configuration)
  1. Call the rest() method in viewWillDisappear(_ animated: Bool)
recorder?.rest()
  1. Call the record() method in the proper method to start recording.
@IBAction func startRecording(_ sender: UIButton) {
recorder?.record()
}
  1. Call the stopAndExport() method in the proper method to stop recording.
@IBAction func stopRecording(_ sender: UIButton) {
recorder?.stopAndExport()
}

NOTE

Make sure you add the usage description of the camera, microphone, and photo library in the app's Info.plist.

<key>NSCameraUsageDescription</key>
<string>AR Camera</string>
<key>NSPhotoLibraryAddUsageDescription</key>
<string>Export AR Media</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>Export AR Media</string>
<key>NSMicrophoneUsageDescription</key>
<string>Audiovisual Recording</string>

Info Plist Screenshot

You're all set. πŸ€“

Check RecordAR documentation for more options!

Publishing to the App Store

Before publishing to the App Store make sure to add the ARVideoKit License to your app licences list.

Additionally, you MUST strip out the simulator architectures from the framework before pushing an application to the App Store.

To do so, follow those steps:

  1. Install Carthage

Download Carthage.pkg from here

Or install with Homebrew using this command brew install carthage

  1. Go to your project target's Build Phase

screen shot 2017-11-14 at 8 21 44 pm

  1. Add a new Run Script Phase

screen shot 2017-11-14 at 8 22 14 pm

  1. Add the following command to the Run Script Phase
/usr/local/bin/carthage copy-frameworks

screen shot 2017-11-14 at 8 30 12 pm

  1. Finally, add ARVideoKit.framework file path as an Input File. In my case, I have it in a folder named Frameworks inside my project folder

screen shot 2017-11-14 at 8 41 06 pm

Donate

Donations will help me to keep maintining ARVideoKit Framework & open source this project to everyone soon ❀️

Donate

License

Copyright 2017 Ahmed Fathi Bekhit, www.ahmedbekhit.com, me@ahmedbekhit.com

ARVideoKit is licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.