CameraField Class Reference

Detailed Description

Represents advanced properties of the camera.

Camera fields represent advanced camera properties and capture parameters such as exposure compensation, ISO and others. A field may be read only (e.g. maximum exposure compensation value) or read-write (e.g. exposure compensation value).

Camera fields are accessed as key-value pairs, where the value may be one of multiple basic types.

Camera fields are highly platform dependent and the keys to identify a given property and available values to set will vary across operating system, operating system version, camera API version and the device model itself.

In addition, camera drivers and firmware may not interpret the values set in a consistent way, or may ignore the set values completely. Therefore, you should only rely on CameraField when you have a specific use case and device in mind.

Finally, setting non-standard values may adversely affect Vuforia tracking performance as well as cause functional issues.

Note

The CameraField methods may only be called after the CameraDevice has been initialized.

CameraField is currently only available on Android devices.

Public Types
enum	DataType {   TypeString,   TypeInt64,   TypeFloat,   TypeBool,   TypeInt64Range,   TypeUnknown }
	Type for the data stored in a CameraField. More...

Public Member Functions
	CameraField ()
	Default constructor. More...

Public Attributes
DataType	mType
	The data type of this field. More...
const char *	mKey
	The key to identify this field. More...

Member Enumeration Documentation

enum DataType

Type for the data stored in a CameraField.

On some platforms, all CameraFields are TypeString.

Enumerator
TypeString	Null terminated array of characters (ASCII)
TypeInt64	64-bit signed integer
TypeFloat	Single precision floating point.
TypeBool	Boolean.
TypeInt64Range	Array of two 64-bit signed integer values.
TypeUnknown	On some platforms the type may not be known at runtime. Setting or getting a parameter of TypeUnknown will fail.

Constructor & Destructor Documentation

CameraField ( )

inline

Default constructor.

Member Data Documentation

DataType mType

The data type of this field.

const char* mKey

The key to identify this field.

Note

The string is only valid until the next call to CameraDevice::getCameraField(). If you need to hold on to it for any reason, make a copy of it.