RecordAR

Class

RecordAR

RecordAR is an ARView sub-class that renders an ARSCNView or ARSKView content with the device's camera stream to generate a video 📹, photo 🌄, live photo 🎇 or GIF 🎆.

---

Topics

Initialization

init (ARSceneKit:ARSCNView)

Initializes 🌞🍳 a new RecordAR object with an ARSCNView 🚀.

init (ARSpriteKit:ARSKView)

Initializes 🌞🍳 a new RecordAR object with an ARSKView 👾.

Configuration

var delegate:RecordARDelegate

An object that passes the AR video recorder errors and status through the protocol methods.

var renderAR:RenderARDelegate

An object that passes the AR rendered content through the protocol method.

var status:RecordARStatus

An object that returns the AR recorder current status.

var micStatus:RecordARMicrophoneStatus

An object that returns the current Microphone status.

var requestMicPermission:RecordARMicrophonePermission

An object that allow configuring when to ask for Microphone permission, if needed. Default is .auto.

var fps:ARVideoFrameRate

An object that allow customizing the video frame per second rate. Default is .auto.

var videoOrientation:ARVideoOrientation

An object that allow customizing the video orientation. Default is .auto.

var onlyRenderWhileRecording:Bool

A boolean that enables or disables AR content rendering before recording for image & video processing. Default is true.

var onlyRenderWhileRecording:Bool

A boolean that enables or disables AR content rendering before recording for image & video processing. Default is true.

var enableAudio:Bool

A boolean that enables or disables audio recording. Default is true.

var enableMixWithOthers:Bool

A boolean that enables or disables audio mixWithOthers if audio recording is enabled. This allows playing music and recording audio at the same time. Default is true.

var onlyRenderWhileRecording:Bool

A boolean that enables or disables AR content rendering before recording for image & video processing. Default is true.

var adjustVideoForSharing:Bool

A boolean that enables or disables adjusting captured media for sharing online. Default is true.

var adjustGIFForSharing:Bool

A boolean that enables or disables adjusting captured GIFs for sharing online. Default is true.

var deleteCacheWhenExported:Bool

A boolean that enables or disables clearing cached media after exporting to Camera Roll. Default is true.

Methods

func photo() -> UIImage

A method that renders a photo 🌄 and returns it as UIImage.

func livePhoto(export:Bool, _ finished: ((_ status:Bool, _ livePhoto:PHLivePhotoPlus?, _ permissionStatus:PHAuthorizationStatus?, _ exported:Bool) -> Swift.Void)? = nil)

A method that renders a PHLivePhoto 🎇 and returns PHLivePhotoPlus in the completion handler.

func gif(forDuration duration:TimeInterval, export:Bool, _ finished: ((_ status:Bool, _ gifPath: URL?, _ permissionStatus:PHAuthorizationStatus?, _ exported:Bool) -> Swift.Void)? = nil)

A method that renders a GIF 🎆 image and returns its local path (URL) in the completion handler.

func record()

A method that starts or resumes ⏯ recording a video 📹.

func record(forDuration duration:TimeInterval, _ finished: ((_ videoPath: URL) -> Swift.Void)? = nil)

A method that starts recording a video 📹 with a specified duration ⏳ in seconds.

func pause()

A method that pauses recording a video ⏸📹.

func stopAndExport(_ finished: ((_ videoPath: URL, _ permissionStatus:PHAuthorizationStatus, _ exported:Bool) -> Swift.Void)? = nil)

A method that stops ⏹ recording a video 📹 and exports it to the Photo Library 📲💾.

func stop(_ finished:((_ videoPath: URL) -> Swift.Void)? = nil)

A method that stops ⏹ recording a video 📹 and returns the video path in the completion handler.

func export(video path:URL, _ finished: ((_ exported:Bool, _ permissionStatus:PHAuthorizationStatus)

A method that exports a video 📹 file path to the Photo Library 📲💾.

func export(image path:URL?=nil, UIImage:UIImage?=nil, _ finished: ((_ exported:Bool, _ permissionStatus:PHAuthorizationStatus) -> Swift.Void)? = nil)

A method that exports any image 🌄/🎆 (including gif, jpeg, and png) to the Photo Library 📲💾.

func export(live photo:PHLivePhotoPlus, _ finished: ((_ exported:Bool, _ permissionStatus:PHAuthorizationStatus)

A method that exports a PHLivePhotoPlus 🎇 object to the Photo Library 📲💾.

func requestMicrophonePermission(_ finished: ((_ status: Bool) -> Swift.Void)? = nil)

A method that requsts microphone 🎙 permission manually, if micPermission is set to manual.