Record your SceneKit and ARKit scenes easily.

SV Hawks

Last update: Dec 22, 2022

Related tags

Augmented Reality SceneKitVideoRecorder

Overview

SceneKitVideoRecorder

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Apps using SceneKitVideoRecorder

Surreal AR Arrow

Send a PR to add your app here

Installation

SceneKitVideoRecorder is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'SceneKitVideoRecorder'

To install Swift 4 branch add the following line to your Podfile:

pod 'SceneKitVideoRecorder', :git => 'https://github.com/svtek/SceneKitVideoRecorder.git', :branch => 'swift4'

Usage

Add NSMicrophoneUsageDescription to info.plist

Add below code to your view controller

var recorder: SceneKitVideoRecorder?
override func viewDidLayoutSubviews() {
    super.viewDidLayoutSubviews()

    if recorder == nil {
        var options = SceneKitVideoRecorder.Options.default

        let scale = UIScreen.main.nativeScale
        let sceneSize = sceneView.bounds.size
        options.videoSize = CGSize(width: sceneSize.width * scale, height: sceneSize.height * scale)
        recorder = try! SceneKitVideoRecorder(withARSCNView: sceneView, options: options)
    }
}

@IBAction func startRecording (sender: UIButton) {
  self.recorder?.startWriting().onSuccess {
    print("Recording Started")
  }
}

@IBAction func stopRecording (sender: UIButton) {
  self.recorder?.finishWriting().onSuccess { [weak self] url in
    print("Recording Finished", url)
  }
}

Performance tips

Here is a piece of Apple sample code

 if let camera = sceneView.pointOfView?.camera {
  camera.wantsHDR = true
  camera.wantsExposureAdaptation = true
  camera.exposureOffset = -1
  camera.minimumExposure = -1
}

The line camera.wantsHDR = true and camera.wantsExposureAdaptation = true causes a huge drop in video recording performance. You should remove or disable it for video recording.

Author

	Omer Karisman _{Product Manager @ MojiLaLa}		Sahin Boydas _{Co-Founder @ MojiLaLa}

Inspired from

noppefoxwolf, [email protected]

License

SceneKitVideoRecorder is available under the MIT license. See the LICENSE file for more info.

Comments

startWriting() method not working properly
I can't make the new version work. I'm probably doing something wrong.

Like the demo project, I'm calling:

recorder=try! SceneKitVideoRecorder(withARSCNView: sceneView) in viewDidLoad()

recorder.setupMicrophone() in viewWillAppear

then recorder.startWriting() when pushing the record button

startDisplayLink() method is never called. So when finishWriting is called, isRecording is false and it returns without actually stoping the recording. Then when I push the record button again I get Terminating app due to uncaught exception 'NSInternalInconsistencyException', reason: '*** -[AVAssetWriter addInput:] Cannot call method when status is 3'.
bug Can’t Reproduce
opened by mariedm 16
Video is not being saved / File is empty
After calling startWriting and finishWriting multiple times in a row, the recorder stops working. A file is created, but it is empty. This happens with the demo project as well as my own. In the demo project I'm getting the error: Video /private/var/mobile/Containers/Data/Application/09B7703C-A173-4EB5-BC8E-F482C2ACDAD8/tmp/output.mp4 cannot be saved to the saved photos album: Error Domain=AVFoundationErrorDomain Code=-11800 "The operation could not be completed" UserInfo={NSUnderlyingError=0x1c0445310 {Error Domain=NSOSStatusErrorDomain Code=-12893 "(null)"

Issue environment:

Device Model: iPhone 7 Plus

Xcode Version: Xcode 9 GM

iOS Version: 11.0 (15A372)

Pod Version or Repo Commit: 1.3.1

bug
opened by LeonardRockstar 13
Starting white frame
Hi,

The video recording works fine but all the videos have a single transparent frame. How can i avoid that or remove it so that thumbnails shows correct image in all places.

Issue environment:

Device Model: iPhone 7

Xcode Version: 9

iOS Version: 11

Pod Version or Repo Commit: 1.3.2

Issue Details:
bug
opened by hablema 7
Different video bugs on different devices
[+] Issue is reproducible in the Demo Project

[+] Issue is reproducible with a clean install

[+] You are running on a Device and not the Simulator

[+] You have searched existing issues (Open and Closed)

[+] You are using an appropriate version of XCode and iOS

Runs well on iPhone 6S with iOS 11 beta.

Issue environment:

Device Model: iPhone 7 plus

Xcode Version: Xcode 9 GM

iOS Version: 11 release

Pod Version or Repo Commit: last version

Issue Details: The video is corrupted, please have a look at the photo. Bug with incorrect size is also can be seen on iPhone 6S Plus (without color bug), so I think this is a problem of all 5.5 iPhones.
bug
opened by notdetninja47 5

How to handle error if the recording is corrupted?

Hello, this library works GREAT!!!

When recording or more importantly stopping and saving, how do I handle errors if the video url is somehow messed up?

The current callback in your example Swift file is a URL:

self.recorder?.finishWriting().onSuccess { [weak self] url in
                
    self?.checkAuthorizationAndPresentActivityController(toShare: url, using: self!)
}

Is there tuple available with a URL and NSERROR?

 self.recorder?.finishWriting().onSuccess { [weak self] (url, error) in

    if let error = error {

         // alert user recording failed
         return
    }

    self?.checkAuthorizationAndPresentActivityController(toShare: url, using: self!)
}

Or is the error handling in an entirely different function meaning we call one for success and another for failure?:

self.sceneKitVideoRecorder?.finishWriting().onFailure(callback: { [weak self](error) in
                
    print("Recording Failed")
})

opened by lsamaria 4

Audio not recorded
Issue environment:

Device Model: iPhone 7

Xcode Version: 9.2 Beta 2

iOS Version: 11.1

Pod Version or Repo Commit: 1.4.0

Issue Details:

The audio is not being recorded in the new method recorder?.setupAudio() . Have tried adding it in the beginning of the controller also in the recordbuttontapped method. Still no audio. The microphone permission was asked first time asked and allowed.
bug
opened by hablema 4

Crash: A pixel buffer cannot be appended when readyForMoreMediaData is NO

Issue environment:

Device Model: iPhone 6S
Xcode Version: 9
iOS Version: 11

Issue Details:

Sometimes the recorder crashes, line 343

self?.pixelBufferAdaptor.append(pixelBuffer, withPresentationTime: appendTime)

Error message:

'NSInternalInconsistencyException', reason: '*** -[AVAssetWriterInputPixelBufferAdaptor appendPixelBuffer:withPresentationTime:] A pixel buffer cannot be appended when readyForMoreMediaData is NO.'

opened by Francescu 4

Chromakeyed video recording cause white background
Issue environment:

Device Model: iPhone mini running iOS 15

Xcode Version: Xcode 13

iOS Version: iOS 15

Pod Version or Repo Commit:

Issue Details: I record the scene where I play a video ver a SCNPlane in which I remove green background of video using surface shader. This cause recorded video to have a white background instead of transparent one. Any ideas?
opened by ozgurshn 3
Crash on finishWriting: index 0 beyond bounds for empty NSArray
Issue environment:

Device Model: iPhone X, iPhone 8 plus

Xcode Version: 9.1

iOS Version: 11

Pod Version or Repo Commit: dc742c912fac986edb68471ccefdd7b24b928b1a

Issue Details:
opened by Francescu 3

How to check if recorder is recording?

How can I check if the recorder is recording? For eg.

if recorder?.isWriting {

    _ = recorder?.startWriting()

} else {

    recorder?.finishWriting().onSuccess { [weak self] url in

        print("recording success", url)
                
    }.onFailure(callback: { (error) in

        print("recording failed", error)
    })
}

opened by lsamaria 2

[Swift4] Updated syntax and changed two property modifiers

• Updated syntaxes and method signatures to latest Swift 4.2 • Changed isPrepared and isRecording properties access modifiers to public. This changes are needed if user wants to update UI based on current recording status.

opened by mjhassan 2
Multiple ARSessions causes crash
Before submitting an issue please make sure that:

[*] Issue is reproducable in the Demo Project

[*] Issue is reproducable with a clean install

[*] You are running on a Device and not the Simulator

[*] You have searched existing issues (Open and Closed)

[*] You are using an appropriate version of XCode and iOS

Issue environment:

Device Model: iPhone 6 Plus

Xcode Version: 11.4

iOS Version: 13.4

Pod Version or Repo Commit: 1.6.0

Issue Details:

I am trying to record multiple ARSessions and it is causing crash.
opened by askari01 0
Crash fix

Occasionally getting crash:

-[AVAssetWriterInputPixelBufferAdaptor appendPixelBuffer:withPresentationTime:] A pixel buffer cannot be appended when readyForMoreMediaData is NO

And suggest PR to fix it.

opened by michdavydov 0
Do you plan a Swift 5 version?
Before submitting an issue please make sure that:

[ ] Issue is reproducable in the Demo Project

[ ] Issue is reproducable with a clean install

[ ] You are running on a Device and not the Simulator

[ ] You have searched existing issues (Open and Closed)

[ ] You are using an appropriate version of XCode and iOS

Issue environment:

Device Model:

Xcode Version:

iOS Version:

Pod Version or Repo Commit:

Issue Details:
opened by sebastienboulogne 5
For Ipad landscape mode - records portrait video
Before submitting an issue please make sure that:

[ ] Issue is reproducable in the Demo Project

[ ] Issue is reproducable with a clean install

[x] You are running on a Device and not the Simulator

[ ] You have searched existing issues (Open and Closed)

[ ] You are using an appropriate version of XCode and iOS

Issue environment:

Device Model:

Xcode Version:

iOS Version:

Pod Version or Repo Commit:

Issue Details:
opened by Dharini17 8
Swift 5 ?
Before submitting an issue please make sure that:

[ ] Issue is reproducable in the Demo Project

[ ] Issue is reproducable with a clean install

[ ] You are running on a Device and not the Simulator

[ ] You have searched existing issues (Open and Closed)

[ ] You are using an appropriate version of XCode and iOS

Issue environment:

Device Model:

Xcode Version:

iOS Version:

Pod Version or Repo Commit:

Issue Details:
opened by sebastienboulogne 2

Releases(1.2.0)

1.2.0(Sep 8, 2017)

Source code(tar.gz)
Source code(zip)
1.1.0(Sep 8, 2017)

Source code(tar.gz)
Source code(zip)
1.0.3(Sep 4, 2017)

By moving displayLink invalidation above asset writer finishing.
Source code(tar.gz)
Source code(zip)
1.0.1(Sep 4, 2017)

Added a static CIContext to refrain from creating it on every frame
Source code(tar.gz)
Source code(zip)
1.0.0(Sep 4, 2017)

Source code(tar.gz)
Source code(zip)
0.9.0(Aug 30, 2017)

Source code(tar.gz)
Source code(zip)

Owner

SV Hawks

GitHub

ARDicee - Simple augmented reality app using SceneKit and ARKit

ARDicee Simple augmented reality app using SceneKit and ARKit Requirements Xcode

3 Feb 4, 2022

AR Ruler - A simple iOS app made using ARKit and SceneKit

A simple iOS app made using ARKit and SceneKit.Which can try to simplify little things in your life such as measuring stuff.

5 Aug 31, 2022

Easily use ARKit to detect facial gestures.

Easily use ARKit to detect facial gestures. FaceTrigger is a simple to use class that hides the details of using ARKit's ARSCNView to recognize facial gestures via ARFaceAnchor.BlendShapeLocations

67 Jun 16, 2022

ARVoxelKit - Lightweight Framework for Voxel graphic using AR + SceneKit

ARVoxelKit Lightweight Framework for Voxel graphic using AR + SceneKit Requirements ARVoxelKit requires iOS 11 and devices, which support ARKit Usage

79 Dec 29, 2022

Swift framework for loading various 3d models in SceneKit

AssetImportKit AssetImportKit is a cross platform library (macOS, iOS) that coverts the files supported by Assimp to SceneKit scenes. Features AssetIm

74 Nov 30, 2022

A library that allows you to generate and update environment maps in real-time using the camera feed and ARKit's tracking capabilities.

ARKitEnvironmentMapper Example To run the example project, clone the repo, and run pod install from the Example directory first. Installation ARKitEnv

91 Dec 4, 2022

A library that allows you to generate and update environment maps in real-time using the camera feed and ARKit's tracking capabilities.

ARKitEnvironmentMapper Example To run the example project, clone the repo, and run pod install from the Example directory first. Installation ARKitEnv

91 Dec 4, 2022