Detailed Description

Provides access to the device's built-in camera.

The CameraDevice is a singleton, accessible via CameraDevice::getInstance() after Vuforia::init() has succeeded.

It provides control over the camera lifecycle (init(), deinit(), start(), and stop()), frame size and FPS (selectVideoMode()), torch (if available) (setFlashTorchMode()), and autofocus (setFocusMode()).

It also provides access to advanced camera properties such as ISO and exposure compensation (setField()). See CameraField for more details.

CameraDevice and your app's lifecycle: The CameraDevice needs special handling if you respond to suspend and resume events, such as when your app is sent to the background on a mobile device. See Vuforia::init() for more details.

Inheritance diagram for CameraDevice:

Public Types
enum	MODE { MODE_DEFAULT = -1, MODE_OPTIMIZE_SPEED = -2, MODE_OPTIMIZE_QUALITY = -3 }

enum	FOCUS_MODE { FOCUS_MODE_NORMAL, FOCUS_MODE_TRIGGERAUTO, FOCUS_MODE_CONTINUOUSAUTO, FOCUS_MODE_INFINITY, FOCUS_MODE_MACRO }

Public Member Functions
virtual bool	init ()=0
	Initialize the camera. More...

virtual bool	deinit ()=0
	Deinitialize the camera. More...

virtual bool	start ()=0
	Start the camera. More...

virtual bool	stop ()=0
	Stop the camera. More...

virtual int	getNumVideoModes () const =0
	Get the number of available VideoModes. More...

virtual VideoMode	getVideoMode (int nIndex) const =0
	Get a specific VideoMode. More...

virtual VideoMode	getCurrentVideoMode () const =0
	Get a currently selected VideoMode. More...

virtual bool	selectVideoMode (int index)=0
	Tell the CameraDevice to use a particular VideoMode. More...

virtual bool	setFlashTorchMode (bool on)=0
	Enable/disable torch mode if the device supports it. More...

virtual bool	setFocusMode (int focusMode)=0
	Set a particular focus mode, or trigger a single autofocus event. More...

virtual int	getNumFields () const =0
	Get the number of CameraFields. More...

virtual bool	getCameraField (int index, CameraField &field) const =0
	Get a particular CameraField. More...

virtual bool	getFieldString (const char key, char value, size_t maxlength) const =0
	Read a camera field value. More...

virtual bool	getFieldInt64 (const char *key, Vuforia::Int64 &value) const =0

virtual bool	getFieldFloat (const char *key, float &value) const =0

virtual bool	getFieldBool (const char *key, bool &value) const =0

virtual bool	getFieldInt64Range (const char key, Vuforia::Int64 intRange) const =0

virtual bool	setField (const char key, const char value)=0
	Write a camera field value. More...

virtual bool	setField (const char *key, Vuforia::Int64 value)=0

virtual bool	setField (const char *key, float value)=0

virtual bool	setField (const char *key, bool value)=0

virtual bool	setField (const char *key, Vuforia::Int64 intRange[2])=0

Static Public Member Functions
static CameraDevice &	getInstance ()
	Get the CameraDevice singleton instance. More...

Member Enumeration Documentation

enum MODE

Enumerator
MODE_DEFAULT	Default camera mode.
MODE_OPTIMIZE_SPEED	Fast camera mode.
MODE_OPTIMIZE_QUALITY	High-quality camera mode.

enum FOCUS_MODE

Enumerator
FOCUS_MODE_NORMAL	Default focus mode.
FOCUS_MODE_TRIGGERAUTO	Triggers a single autofocus operation.
FOCUS_MODE_CONTINUOUSAUTO	Continuous autofocus mode.
FOCUS_MODE_INFINITY	Focus set to infinity.
FOCUS_MODE_MACRO	Macro mode for close-up focus.

Member Function Documentation

static CameraDevice& getInstance ( )

static

Get the CameraDevice singleton instance.

The singleton instance is available immediately after Vuforia::init() has succeeded.

It is no longer available after calling Vuforia::deinit().

virtual bool init ( )

pure virtual

Initialize the camera.

Note: This method must be handled carefully as part of your application's lifecyle. See the "Lifecycle of a Vuforia app" section on the main Vuforia reference page for more information. Lifecycle of a Vuforia app

Returns: true if the camera was initialized, or false on failure (check application logs for details).

virtual bool deinit ( )

pure virtual

Deinitialize the camera.

Release any resources created or used by the camera.

Note: This method should not be called during the execution of the UpdateCallback; This method must be handled carefully as part of your application's lifecyle. See the "Lifecycle of a Vuforia app" section on the main Vuforia reference page for more information. Lifecycle of a Vuforia app

Returns: true on success, otherwise false (such as if this method is called during execution of the UpdateCallback; check application logs for details).

virtual bool start ( )

pure virtual

Start the camera.

This method starts the process of delivering frames from the camera to Vuforia. The CameraDevice must have been initialized first via a call to init().

Depending on the type of the camera it may be necessary to perform certain configuration tasks after calling init() before it can be started (such as selectVideoMode() and/or specific calls to setField()).

Note: This method must be handled carefully as part of your application's lifecyle. Specifically, it is recommended that you start the camera after starting any required trackers. See the "Lifecycle of a Vuforia app" section on the main Vuforia reference page for more information. Lifecycle of a Vuforia app

Returns: true if the camera was started, otherwise false (check application logs for failure messages).

virtual bool stop ( )

pure virtual

Stop the camera.

Stop the delivery of frames from the camera to Vuforia.

Since the camera can consume a lot of power, you may want to use this method to suspend Vuforia when it is not actively required, such as when the user is doing non-AR/VR tasks in your app.

Note: This method must be handled carefully as part of your application's lifecyle. Specifically, it is recommended that you stop the camera before stopping any running trackers. See the "Lifecycle of a Vuforia app" section on the main Vuforia reference page for more information. Lifecycle of a Vuforia app

Returns: true if the camera was stopped, otherwise false (check application logs for failure messages).

virtual int getNumVideoModes ( ) const

pure virtual

Get the number of available VideoModes.

This is device specific and can differ between mobile devices or operating system versions.

virtual VideoMode getVideoMode ( int nIndex ) const

pure virtual

Get a specific VideoMode.

Parameters

nIndex The VideoMode to get, in the range 0..getNumVideoModes()-1

Returns: The requested VideoMode.

virtual VideoMode getCurrentVideoMode ( ) const

pure virtual

Get a currently selected VideoMode.

Get the currently selected VideoMode

Returns: the currently selected VideoMode

virtual bool selectVideoMode ( int index )

pure virtual

Tell the CameraDevice to use a particular VideoMode.

Note: This method can only be called when the camera is initialized but not started.

If this method is not called, Vuforia will select a default video mode.

To switch video modes after the camera has been started, call stop(), then deinit(), then init(), then selectVideoMode() with the new mode, then start().

Note: Calling this method changes the RenderingPrimitives returned by Device::getRenderingPrimitives(). If you have a cached copy of the RenderingPrimitives, you will need to call Device::getRenderingPrimitives() again to get an updated copy.

Parameters

index The VideoMode to set, in the range 0..getNumVideoModes()-1.

Returns: true if the video mode was selected, otherwise false.

virtual bool setFlashTorchMode ( bool on )

pure virtual

Enable/disable torch mode if the device supports it.

Returns: true if torch mode was turned on or off as requested, otherwise false.

virtual bool setFocusMode ( int focusMode )

pure virtual

Set a particular focus mode, or trigger a single autofocus event.

Note: Not all focus modes are supported on all devices.

You can trigger a single autofocus event using FOCUS_MODE_TRIGGERAUTO. Note that doing so may interrupt FOCUS_MODE_CONTINUOUSAUTO if that mode is currently set.

Parameters

focusMode The focus mode to set. See FOCUS_MODE for a list of possible values.

Returns: true if the focus mode was set as requested, otherwise false.

virtual int getNumFields ( ) const

pure virtual

Get the number of CameraFields.

Note: This may not be the complete set of camera fields available on this device.; Some keys may not be supported on every device.

virtual bool getCameraField	(	int	index,
		CameraField &	field
	)		const

pure virtual

Get a particular CameraField.

Parameters

index	The index of the field to get, in the range 0..getNumFields()-1.
field	On return, will be populated with the requested field data.

Returns: true if the requested CameraField could be got, otherwise false.

virtual bool getFieldString	(	const char *	key,
		char *	value,
		size_t	maxlength
	)		const

pure virtual

Read a camera field value.

Parameters

key	Key for the value to read. Must match one of CameraField::mKey as returned from getCameraField().
value	On return, will be populated with the value of the requested key.

Returns: true on success, false on failure or if the requested key could not be found.

virtual bool getFieldInt64	(	const char *	key,
		Vuforia::Int64 &	value
	)		const

pure virtual

virtual bool getFieldFloat	(	const char *	key,
		float &	value
	)		const

pure virtual

virtual bool getFieldBool	(	const char *	key,
		bool &	value
	)		const

pure virtual

virtual bool getFieldInt64Range	(	const char *	key,
		Vuforia::Int64 *	intRange
	)		const

pure virtual

virtual bool setField	(	const char *	key,
		const char *	value
	)

pure virtual

Write a camera field value.

Parameters

key	Key for the value to write. Must match one of CameraField::mKey as returned from getCameraField().
value	The value to write.

Returns: true on success, false on failure or if the requested key could not be found.

virtual bool setField	(	const char *	key,
		Vuforia::Int64	value
	)

pure virtual

virtual bool setField	(	const char *	key,
		float	value
	)

pure virtual

virtual bool setField	(	const char *	key,
		bool	value
	)

pure virtual

virtual bool setField	(	const char *	key,
		Vuforia::Int64	intRange[2]
	)

pure virtual

	C++	Java	Unity
C++ Reference

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Member Enumeration Documentation

Member Function Documentation