AR Recording

Note

Support: Android / iOS

OSX platform note: VOIDAR_Unity_v1.0_Beta4 does not support running on OSX platform, but building iOS app works OK.

Part 1. Introduction

By one-key Screen Record function, you can record your AR content in runtime and store it to MP4 file.

Part 2. Reading Guidelines

This tutorial is mainly to introduce how to process in Unity environment.

We assume that readers have basic experience in app development and unity usage.

For more unity3d usage information, please visit the official website of unity3d documentation.

Part 3. Development Environment

You need to install and prepare your development environment as below before you start.

OS

  • Windows 7 or higher
  • OS X 10.10 or higher

Unity Version Support

Unity3D Version VOID AR SDK Full Features
5.6.x Support All Features
2017.x Support All Features
2018.x Support All Features
2019.1.x Support All Features
2019.2.0 Support All Features
Note

Unity3D of this tutorial: Unity 2017.4.13

Unity3D Download: https://unity3d.com/cn/get-unity/download/archive

Part 4. Implementation process

Important

You just need to add the “Video Record Behaviour” script to the “ARCamera” to get AR Recording function.

The coming part of this tutorial will introduce you about the AR recording with an example of Image Recognition (Single Target).

If you are already familiar with this part, please skip to Step 10, Step 11 and Part 5.

Step 1. Open new Unity project

Open Unity with new project. Fill the Project name with “ImageTarget”, and select the location, and click [ Create project ].

1

Step 2. Import VOID AR SDK

Select[ Assets ] -> [ Import Package ] -> [ Custom Package... ], import VOID AR SDK.

2

Select the downloaded SDK file (.unitypackage), and click [ Open ] button.

3

Click [ Import ] from the prompted window. It takes minutes during the import process.

4

If there is a prompt window of “API Update Required” interface，please click [ I Made a Backup, Go Ahead! ].

5

Step 3. Delete Main Camera

Note

When you open the Unity3D, you will see the new scene in default. The new scene has two GameObjects: a "Main Camera" and a "Directional Light". We need to use the ARCamera from SDK, so please delete the default Camera.

Right click the "Main Camera” from the scene, and select [ Delete ].

6

Step 4. Drag the prefabs “ARCamera” and “ImageTarget”

Expand the directory [ Assets ] -> [ VoidAR ] -> [ Prefabs ],

and drag the prefabs “ARCamera” and “ImageTarget” to the scene.

7

When you finish the process, it shows as below:

8

Step 5. ARCamera Setup

Select ARCamera, and look up in the “Inspector” area on the right side, setup “Void AR Behaviour (Script)” properties.

  • Set MarkerType = "Image", stands for image target recognition
  • Set Simultaneous Tracking = "1", representing the number of simultaneous tracking marker is 1

9

Step 6. Marker Setup

Select ImageTarget, look up the “Inspector” area on the right side, setup the “Image Target Behaviour (Script)” properties.

  • Set Image File Path = "Panda.jpg", the format is “filename”+“Suffix JPG”
Warning

Marker files must locate in [ Assets ] -> [ StreamingAssets ] folder. This tutorial uses the built-in marker file in SDK.

10

11

Step 7. Model Setup

Note

You need to have your model for recognition under the ImageTarget.

Right click the “ImageTarget” in the scene, add a 3D model “Cube”.

12

Select the “Cube”, adjust its size and position.

13

Step 8. Save Scene

Select [ File] -> [ Save Scenes ] , click for saving your setup.

14

Setup the name as “ImageTarget”, and click [ save ] button.

15

Step 9. Debug

Warning

Make sure your PC is connected with a camera.

Click [ Play ] button.

16

Recognize successfully and complete debugging.

17

Step 10. AR Recording Setup

Select “ARCamera”, click [ Add Component ] to add the “Video Record Behaviour” script.

49

After binding, it shows as below.

The content of "MP4 File Name" is “VoidAR_”, which is the prefix of the saved video file name.

50

Select “ARCamera”, click [ Add Component ] to add the “Record Help” UI script.

203

After binding, it shows as below.

204

When finished, select [ File ] -> [ Save Scenes ] again to save the scene.

Warning

AR Recording is available only on Android and iOS. We will introduce how to build in Android and iOS.

Step 11. Publishing Builds

Build Process includes Android and iOS.

Android

First, switch the PC platform to Android platform from [ File ] -> [ Build Settings... ].

18

Select Android tag, if the [ Switch Platform ] button is grey, you need to download the Unity Android Support. Please click on the right side of the [ Open Download Page ] button, download and install.

19

Click [ Switch Platform ] button, switch the platform to Android.

20

After switch process, close the Build Settings interface first, and continue with packing.

Select [ Edit ] -> [ Preferences... ], setup the preferences parameters.

47

Select “External Tools” option, setup Android SDK and JDK。

Note

If you do not have SDK and JDK, please click [ Download ] from the interface, it will guide you to download from the prompted website.

Or you can also download from links below:

SDK: https://developer.android.com/studio/index.html

JDK: https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html

After the installation of SDK and JDK, you are able to setup their directory.

48

Select ARCamera, and look up in the “Inspector” area on the right side, setup “Void AR Behaviour (Script)” properties.

  • Set Camera = "后置摄像头"(Rear camera)

27

Select [ File ] -> [ Build Settings... ], cancel all default scenes, and click [ Add Open Scenes ] button to add current scene into the build area.

21

It shows as below:

22

Setup parameters

Click [ Player Settings... ] button, check the “Inspector” area, setup the parameters as below or as your needs.

  • Set Company = "VOIDAR"

  • Set Product Name = "ImageTarget"

  • Set Bundle Identifier = "com.VOIDAR.ImageTarget"（ Cannot use default value, otherwise it fail to build. ）

  • Important

    Cancel the selection of “Multithreaded Rendering” !

23

Finish the settings, and click [ Build ] button.

24

Set the file name as “ImageTarget”, and click [ save ] button to start building.

25

It takes minutes while building, please wait...

26

When the build is done, it will generate an apk file “ImageTarget.apk”.

Android Build is completed.

iOS

iOS Build requires Mac device ( such as MacBook Pro、MacBook、iMac、Mac mini etc. )

Switch the platform to iOS platform in Unity, and build Xcode project.

Warning

It is recommended to use Mac device to build Xcode project. If previously you make the project in Windows environment, you can export the Unity project as a unitypackage, or copy it to Mac device and build for xcode project.

Launch Unity and open the saved or copied ImageTarget project. ( Skip this step if project opened already )

28

Click [ Open ] button to open the project.

29

Switch to iOS platform in Unity, click [ File ] -> [ Build Settings... ].

30

Select iOS tag, if the [ Switch Platform ] button is grey, you need to download the Unity iOS Support. Please click on the right side of the [ Open Download Page ] button, download and install.

31

Click [ Switch Platform ] button, switch the platform to iOS.

32

Click [ Player Settings... ] button after switch.

340

Important

Cancel the selection of “Multithreaded Rendering”!

51

Close the Build Settings interface, select ARCamera, check the “Inspector” area on the right side, setup the "Void AR Behaviour (Script)” properties.

  • Set Camera = "后置摄像头"(Rear Camera)

33

Select [ File ] -> [ Build Settings... ], cancel all default scenes, and click [ Add Open Scenes ] button to add current scene into the build area.

34

It shows as below:

35

Finish the settings, and click [ Build ] button.

36

Set the project folder name “Output”, and click [ Save ].

37

Open the Xcode project.

38

Setup parameters

Filling in your configurations: your certificate, deployment target.

Click [ Unity-iPhone ] on the left side, config the parameters as below or by your customization:

  • Display Name = "VOIDAR_Test"
  • Bundle Identifier = "com.VOIDAR.Demo"
  • Version = "1.0"
  • Build = “1.0”
  • Team = “Your Certificate”
  • Deployment Target = “8.1”

39

Add Accelerate.framework

Select General tag and scroll down, click the "+" in the "Linked Frameworks and Libraries".

40

Select “Accelerate.framework” from the prompted window, and click [ Add ].

41

After doing that, you will see “Accelerate.framework” from the list of "Linked Frameworks and Libraries" as below:

42

Add privacy:

  1. Camera usage privacy

  2. Photo library usage privacy

  3. Photo library additions usage privacy

  4. Microphone usage privacy

Select “Info” tag, click the "+" below the "Supported interface orientations". In the prompting list, add the following privacy:

  • Privacy - Camera Usage Description
  • Privacy - Photo Library Usage Description
  • Privacy - Photo Library Additions Usage Description
  • Privacy - Microphone Usage Description

43

44

52

202

205

Set Enable Bitcode = “No”

Select ”Build Settings” tag, set Enable Bitcode = “No”.

45

Cancel armv7

Select "Build Settings" tab, expand Architectures, and select "Other...".

52

The pop-up interface, select "armv7" and click "-".

53

After canceling, the display is as below.

54

Connect iphone or ipad to the Mac device, Click [ Run ].

46

After building, there will be an application “VOIDAR_Test” built into your iphone or ipad.

The iOS build is done.

Part 5. How to use

After building, you can run it in your mobile device.

  • Click the "REC" button for starting recording
  • Click the "Stop" button for stopping
Note

You can find the recorded video file in your device photo album. The file locates in the "DCIM" folder in your memory card for Android, and locates in your photo album for iOS.

By here, the AR Recording process is done.