ARToolKit for Android Camera Preferences

From ARToolworks support library

Jump to: navigation, search

Main Page > ARToolKit Professional > ARToolKit for Android > ARToolKit for Android Camera Preferences

Since ARToolKit for Android release 12, the provided examples have incorporated a user-adjustable camera preferences screen. There are two key preferences implemented. Firstly, on devices with more than one camera, the choice of camera, and secondly, the camera resolution.

This preferences screen is provided as part of the ARBaseLib library in the ARToolKit for Android distribution. The class identifier is It is quite straightforward to incorporate this class into your ARToolKit for Android application.

There are two approaches, depending on whether your application's AR activity inherits from, or whether it uses its own Activity and CameraSurface classes.


Applications inheriting from ARActivity

As of release 13, the example applications which inherit from ARActivity are:

  • ARSimple
  • ARSimpleInteraction
  • ARSimpleNative
  • ARSimpleNativeCars

If your application falls into this category, you need add only the essential lines of code to register the CameraPreferencesActivity in your manifest. The behaviour of providing the settings menu in response to the menu button is automatically provided by the ARActivity class. The preferences chosen by the user are automatically used in the CameraPreview class.

Just add the following to your AndroidManifest.xml file:

<activity android:name=""></activity>

Applications using custom Activity subclasses

As of release 13, the example applications which use their own Activity and CameraSurface classes are:

  • ARNative
  • ARNativeOSG
  • nftSimple
  • nftBook
  • ARMovie

If your application is based on one of these applications, a handful of changes need to be made to initialise the preferences the first time the application is run after being freshly installed, to invoke the preferences activity, and to use the actual preferences in setting up the camera.

Initialise preference defaults

Add the following code where it will be run once per install of Application, and prior to using any of the camera preferences. If you are subclassing Application.onCreate() (as all the examples do), put it into Application.onCreate(). If not subclassing Application, put it in your Activity.onCreate() method.

import android.preference.PreferenceManager;
PreferenceManager.setDefaultValues(this,, false);

Invoke preferences activity

The suggested method of invoking the preferences activity is to make it available via your applications settings menu. This is quite straightforward. Add the following code to your Activity subclass:

import android.view.Menu;
import android.view.MenuInflater;
import android.view.MenuItem;
	public boolean onCreateOptionsMenu(Menu menu) {
	    MenuInflater inflater = getMenuInflater();
	    inflater.inflate(, menu);
	    return true;
	public boolean onOptionsItemSelected(MenuItem item) {
	    if (item.getItemId() == {
			startActivity(new Intent(this, CameraPreferencesActivity.class));
			return true;
		} else {
			return super.onOptionsItemSelected(item);

This will use the menu resource provided by the ARBaseLib library. If you already have an options menu, you will most likely want to incorporate the existing values from ARBaseLib's res/menu/options.xml.

Use preferred values in setting up the camera

Once the user has actually chosen the preferences, you need to make sure you're actually using the choices, or that you're using the default values if no choice has yet been made. This code will typically be in a class which inherits from Surface and which implements CameraPreviewCallback. Take a look at the CameraSurface class in the native examples for example usage.

Code to open the correct camera chosen by the user:

import android.os.Build;
import android.preference.PreferenceManager;
Camera camera = null;
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.GINGERBREAD) camera ="pref_cameraIndex", "0")));
else camera =;

Code to attempt to configure the camera resolution.

String camResolution = PreferenceManager.getDefaultSharedPreferences(callingContext).getString("pref_cameraResolution", getResources().getString(R.string.pref_defaultValue_cameraResolution));
String[] dims = camResolution.split("x", 2);
Camera.Parameters parameters = camera.getParameters();
parameters.setPreviewSize(Integer.parseInt(dims[0]), Integer.parseInt(dims[1]));

Don't forget that the chosen resolution may not be accepted by the camera, so don't assume that the camera preview buffers will be the preferred size. You should read back the actual size in use after setting the preferred value (e.g. when sizing buffers).


The full source of CameraPreferencesActivity is provided and is easy to customise.

The source refers to a number of resources, found at the following paths:


These resources are automatically available in any project referring to ARBaseLib. If you wish to customise these, you can override in your Activity by using the same resource ID with the new value.

Notes on camera resolutions

Take care when the user chooses camera resolutions. A camera resolution with a different aspect ratio to the aspect ratio of ARToolKit's calibrated camera parameters (camera_para.dat or similar) will not track correctly!

Personal tools