CameraController.h File Reference

Controller to access camera-specific functionality in the Vuforia Engine. More...

Classes
struct	VuCameraRegionOfInterest
	Data structure for setting and getting focus and exposure regions of interest in the camera image. More...
struct	VuCameraVideoMode
	Camera video mode description. More...
struct	VuCameraField
	Camera field description. More...

Typedefs
typedef struct VuCameraVideoModeList_	VuCameraVideoModeList
	List of video modes available for a camera.
typedef struct VuCameraFieldList_	VuCameraFieldList
	List of properties available for a camera. More...

Enumerations
enum	VuCameraVideoModePreset : int32_t {   VU_CAMERA_VIDEO_MODE_PRESET_DEFAULT = 0x1,   VU_CAMERA_VIDEO_MODE_PRESET_OPTIMIZE_SPEED = 0x2,   VU_CAMERA_VIDEO_MODE_PRESET_OPTIMIZE_QUALITY = 0x3 }
	Supported camera video mode presets. More...
enum	VuCameraFocusMode : int32_t {   VU_CAMERA_FOCUS_MODE_UNKNOWN = 0x1,   VU_CAMERA_FOCUS_MODE_TRIGGERAUTO = 0x3,   VU_CAMERA_FOCUS_MODE_CONTINUOUSAUTO = 0x4,   VU_CAMERA_FOCUS_MODE_INFINITY = 0x5,   VU_CAMERA_FOCUS_MODE_MACRO = 0x6,   VU_CAMERA_FOCUS_MODE_FIXED = 0x7 }
	Supported camera focus modes. More...
enum	VuCameraExposureMode : int32_t {   VU_CAMERA_EXPOSURE_MODE_UNKNOWN = 0x1,   VU_CAMERA_EXPOSURE_MODE_TRIGGERAUTO = 0x2,   VU_CAMERA_EXPOSURE_MODE_CONTINUOUSAUTO = 0x3,   VU_CAMERA_EXPOSURE_MODE_FIXED = 0x4 }
	Supported camera exposure modes. More...
enum	VuCameraFieldDataType : int32_t {   VU_CAMERA_FIELD_DATA_TYPE_STRING = 0x1,   VU_CAMERA_FIELD_DATA_TYPE_INT64 = 0x2,   VU_CAMERA_FIELD_DATA_TYPE_FLOAT = 0x3,   VU_CAMERA_FIELD_DATA_TYPE_BOOL = 0x4,   VU_CAMERA_FIELD_DATA_TYPE_INT64_RANGE = 0x5 }
	Type for the data stored in a CameraField. More...

Functions
VuResult	vuEngineGetCameraController (const VuEngine *engine, VuController **controller)
	Retrieve Camera Controller to get access to camera-specific functionality in Engine.
VuResult	vuCameraControllerGetVideoModes (const VuController *controller, VuCameraVideoModeList *cameraVideoModeList)
	Get all the supported video modes for the camera. More...
VuResult	vuCameraVideoModeListCreate (VuCameraVideoModeList **list)
	Create a camera video mode list.
VuResult	vuCameraVideoModeListGetSize (const VuCameraVideoModeList *list, int32_t *listSize)
	Get number of elements in a camera video mode list.
VuResult	vuCameraVideoModeListGetElement (const VuCameraVideoModeList *list, int32_t element, VuCameraVideoMode *videoMode)
	Get an element in a camera video mode list.
VuResult	vuCameraVideoModeListDestroy (VuCameraVideoModeList *list)
	Destroy a camera video mode list.
VuResult	vuCameraControllerGetActiveVideoMode (const VuController *controller, VuCameraVideoModePreset *cameraVideoModePreset)
	Get the the currently active video mode of the camera.
VuResult	vuCameraControllerSetActiveVideoMode (VuController *controller, VuCameraVideoModePreset cameraVideoModePreset)
	Set the current video mode of the camera from the list of supported presets. More...
VuResult	vuCameraControllerGetFlashMode (const VuController *controller, VuBool *flashMode)
	Get the current flash mode of the camera. More...
VuResult	vuCameraControllerSetFlashMode (VuController *controller, VuBool flashMode)
	Set the flash mode of the camera. More...
VuResult	vuCameraControllerGetFocusMode (const VuController *controller, VuCameraFocusMode *focusMode)
	Get the current focus mode of the camera. More...
VuResult	vuCameraControllerSetFocusMode (VuController *controller, VuCameraFocusMode focusMode)
	Set the focus mode of the camera. More...
VuResult	vuCameraControllerGetExposureMode (const VuController *controller, VuCameraExposureMode *exposureMode)
	Get the current exposure mode of the camera. More...
VuResult	vuCameraControllerSetExposureMode (VuController *controller, VuCameraExposureMode exposureMode)
	Set the exposure mode of the camera. More...
VuResult	vuCameraControllerIsFocusModeSupported (VuController *controller, VuCameraFocusMode focusMode, VuBool *isFocusModeSupported)
	Check if setting a specific focus mode is supported on the current device. More...
VuResult	vuCameraControllerIsExposureModeSupported (VuController *controller, VuCameraExposureMode exposureMode, VuBool *isExposureModeSupported)
	Check if setting a specific exposure mode is supported on the current device. More...
VuResult	vuCameraControllerGetFocusRegion (const VuController *controller, VuCameraRegionOfInterest *focusROI)
	Get the region of interest currently active for camera focus control. More...
VuResult	vuCameraControllerSetFocusRegion (VuController *controller, VuCameraRegionOfInterest focusROI)
	Set the active region of interest for camera focus control. More...
VuResult	vuCameraControllerGetExposureRegion (const VuController *controller, VuCameraRegionOfInterest *exposureROI)
	Get the region of interest currently active for camera exposure control. More...
VuResult	vuCameraControllerSetExposureRegion (VuController *controller, VuCameraRegionOfInterest exposureROI)
	Set the active region of interest for camera exposure control. More...
VuResult	vuCameraControllerIsFocusRegionSupported (const VuController *controller, VuBool *isFocusRegionSupported)
	Check if setting a focus region is supported on the current device. More...
VuResult	vuCameraControllerIsExposureRegionSupported (const VuController *controller, VuBool *isExposureRegionSupported)
	Check if setting an exposure region is supported on the current device. More...
VuResult	vuCameraControllerGetSupportedCameraFields (const VuController *controller, VuCameraFieldList *cameraFieldList)
	Get all the supported video modes for the camera. More...
VuResult	vuCameraFieldListCreate (VuCameraFieldList **list)
	Create a camera field list. More...
VuResult	vuCameraFieldListGetSize (const VuCameraFieldList *list, int32_t *listSize)
	Get number of elements in a camera field list. More...
VuResult	vuCameraFieldListGetElement (const VuCameraFieldList *list, int32_t element, VuCameraField *cameraField)
	Get an element in a camera field list. More...
VuResult	vuCameraFieldListDestroy (VuCameraFieldList *list)
	Destroy a camera field list. More...
VuResult	vuCameraControllerGetFieldString (const VuController *controller, const char *key, char *value, int32_t maxLength)
	Read a camera field of type string. More...
VuResult	vuCameraControllerSetFieldString (VuController *controller, const char *key, const char *value)
	Write a camera field value of type string. More...
VuResult	vuCameraControllerGetFieldInt64 (const VuController *controller, const char *key, int64_t *value)
	Read a camera field of type int64. More...
VuResult	vuCameraControllerSetFieldInt64 (VuController *controller, const char *key, int64_t value)
	Write a camera field value of type int64. More...
VuResult	vuCameraControllerGetFieldFloat (const VuController *controller, const char *key, float *value)
	Read a camera field of type float. More...
VuResult	vuCameraControllerSetFieldFloat (VuController *controller, const char *key, float value)
	Write a camera field value of type float. More...
VuResult	vuCameraControllerGetFieldBool (const VuController *controller, const char *key, VuBool *value)
	Read a camera field of type Boolean. More...
VuResult	vuCameraControllerSetFieldBool (VuController *controller, const char *key, VuBool value)
	Write a camera field value of type Boolean. More...
VuResult	vuCameraControllerGetFieldInt64Range (const VuController *controller, const char *key, int64_t *value)
	Read a camera field of type int64 range. More...
VuResult	vuCameraControllerSetFieldInt64Range (VuController *controller, const char *key, int64_t value[2])
	Write a camera field value of type int64 range. More...
VuResult	vuCameraControllerGetRegisteredImageFormats (const VuController *controller, VuImagePixelFormatList *list)
	Get list of image formats registered to be returned with the camera frame.
VuResult	vuCameraControllerRegisterImageFormat (VuController *controller, VuImagePixelFormat format)
	Register an image format to be returned with the camera frame. More...
VuResult	vuCameraControllerUnregisterImageFormat (VuController *controller, VuImagePixelFormat format)
	Unregister an image format to be returned with the camera frame. More...

Detailed Description

Controller to access camera-specific functionality in the Vuforia Engine.