Camera Metadata
Enumeration definitions for the various metadata entries. More...
Classes
| Name | |
|---|---|
| struct | MLCameraMetadataRational |
Types
| Name | |
|---|---|
| typedef struct MLCameraMetadataRational | MLCameraMetadataRational |
Enums
Functions
| Name | |
|---|---|
| MLResult | MLCameraMetadataGetColorCorrectionAvailableAberrationModes(MLHandle characteristics_handle, MLCameraMetadataColorCorrectionAberrationMode * out_data, uint32_t out_count) Gets color correction aberration modes. |
| MLResult | MLCameraMetadataGetControlAEAvailableModes(MLHandle characteristics_handle, MLCameraMetadataControlAEMode * out_data, uint32_t out_count) Gets auto-exposure modes. |
| MLResult | MLCameraMetadataGetControlAEAvailableAntibandingModes(MLHandle characteristics_handle, MLCameraMetadataControlAEAntibandingMode * out_data, uint32_t out_count) Gets anti-banding modes. |
| MLResult | MLCameraMetadataGetControlAECompensationRange(MLHandle characteristics_handle, int32_t out_data[2]) Gets auto-exposure compensation range. |
| MLResult | MLCameraMetadataGetControlAECompensationStep(MLHandle characteristics_handle, MLCameraMetadataRational * out_data) Gets AE compensation step. |
| MLResult | MLCameraMetadataGetControlAELockAvailable(MLHandle characteristics_handle, MLCameraMetadataControlAELock * out_data) Gets AE lock. |
| MLResult | MLCameraMetadataGetControlAEMaxRegions(MLHandle characteristics_handle, int32_t * out_data) Gets AE Max Regions. |
| MLResult | MLCameraMetadataGetControlAvailableModes(MLHandle characteristics_handle, MLCameraMetadataControlMode * out_data, uint32_t out_count) Gets Available Modes. |
| MLResult | MLCameraMetadataGetControlAWBAvailableModes(MLHandle characteristics_handle, MLCameraMetadataControlAWBMode * out_data, uint32_t out_count) Gets AWB modes. |
| MLResult | MLCameraMetadataGetControlAFAvailableModes(MLHandle characteristics_handle, MLCameraMetadataControlAFMode * out_data, uint32_t out_count) Gets AF modes. |
| MLResult | MLCameraMetadataGetControlAFMaxRegions(MLHandle characteristics_handle, int32_t * out_data) Gets max number of AF regions supported. |
| MLResult | MLCameraMetadataGetControlAvailableSceneModes(MLHandle characteristics_handle, MLCameraMetadataControlSceneMode * out_data, uint32_t out_count) Gets Scene modes. |
| MLResult | MLCameraMetadataGetControlAvailableEffectModes(MLHandle characteristics_handle, MLCameraMetadataControlEffectMode * out_data, uint32_t out_count) Gets Effect modes. |
| MLResult | MLCameraMetadataGetControlAWBLockAvailable(MLHandle characteristics_handle, MLCameraMetadataControlAWBLock * out_data) Gets AWB lock. |
| MLResult | MLCameraMetadataGetSensorInfoActiveArraySize(MLHandle characteristics_handle, int32_t out_data[4]) Gets sensor info active array sizes. |
| MLResult | MLCameraMetadataGetSensorInfoSensitivityRange(MLHandle characteristics_handle, int32_t out_data[2]) Gets sensor info sensitivity range (Analog Gain). |
| MLResult | MLCameraMetadataGetPostRawSensitivityBoostRange(MLHandle characteristics_handle, int32_t out_data[2]) Gets post raw sensitivity boost range (Digital Gain). |
| MLResult | MLCameraMetadataGetLensInfoHyperfocalDistance(MLHandle characteristics_handle, float * out_data) Gets lens hyperfocal distance. |
| MLResult | MLCameraMetadataGetLensInfoMinimumFocusDistance(MLHandle characteristics_handle, float * out_data) Gets lens minimum focus distance. |
| MLResult | MLCameraMetadataGetLensInfoMinimumFocusDistanceIncrement(MLHandle characteristics_handle, float * out_data) Gets lens minimum focus distance increment. The lens position can be set in multiples of distance increments between hyperfocal distance and minimum focus distance. |
| MLResult | MLCameraMetadataGetSensorOrientation(MLHandle characteristics_handle, int32_t * out_data) Gets sensor orientation degree. |
| MLResult | MLCameraMetadataGetColorCorrectionModeRequestMetadata(MLHandle request_handle, MLCameraMetadataColorCorrectionMode * out_data) Gets color correction mode. |
| MLResult | MLCameraMetadataGetColorCorrectionTransformRequestMetadata(MLHandle request_handle, MLCameraMetadataRational out_data[3][3]) Gets color correction transform. |
| MLResult | MLCameraMetadataGetColorCorrectionGainsRequestMetadata(MLHandle request_handle, float out_data[4]) Gets color correction gains. |
| MLResult | MLCameraMetadataGetColorCorrectionAberrationModeRequestMetadata(MLHandle request_handle, MLCameraMetadataColorCorrectionAberrationMode * out_data) Gets color correction aberration. |
| MLResult | MLCameraMetadataGetControlAEAntibandingModeRequestMetadata(MLHandle request_handle, MLCameraMetadataControlAEAntibandingMode * out_data) Gets AE antibanding mode. |
| MLResult | MLCameraMetadataGetControlAEExposureCompensationRequestMetadata(MLHandle request_handle, int32_t * out_data) Gets AE exposure compensation. |
| MLResult | MLCameraMetadataGetControlAELockRequestMetadata(MLHandle request_handle, MLCameraMetadataControlAELock * out_data) Gets AE lock. |
| MLResult | MLCameraMetadataGetControlAEModeRequestMetadata(MLHandle request_handle, MLCameraMetadataControlAEMode * out_data) Gets AE mode. |
| MLResult | MLCameraMetadataGetControlAERegionsRequestMetadata(MLHandle request_handle, int32_t out_data[3][5], uint32_t * out_count) Gets auto-exposure regions. |
| MLResult | MLCameraMetadataGetControlAWBLockRequestMetadata(MLHandle request_handle, MLCameraMetadataControlAWBLock * out_data) Gets AWB lock. |
| MLResult | MLCameraMetadataGetControlAWBModeRequestMetadata(MLHandle request_handle, MLCameraMetadataControlAWBMode * out_data) Gets AWB mode. |
| MLResult | MLCameraMetadataGetControlAFModeRequestMetadata(MLHandle request_handle, MLCameraMetadataControlAFMode * out_data) Gets AF mode. |
| MLResult | MLCameraMetadataGetControlAFTriggerRequestMetadata(MLHandle request_handle, MLCameraMetadataControlAFTrigger * out_data) Gets AF trigger. |
| MLResult | MLCameraMetadataGetControlAFRegionsRequestMetadata(MLHandle request_handle, int32_t out_data[3][5], uint32_t * out_count) Gets auto-focus regions. |
| MLResult | MLCameraMetadataGetAFDistanceRangeRequestMetadata(MLHandle request_handle, float out_data[2]) Gets AF distance range. Both Min and Max are specified as focus distance in diopters. The min value specifies the lower bound for focus distance used by Autofocus algorithm and should be more than min focus distance which can be queried using MLCameraMetadataGetLensInfoMinimumFocusDistance. The max value specifies the upper bound for focus distance used by Autofocus algorithm and should be less than hyperfocal distance which can be queried using api MLCameraMetadataGetLensInfoHyperfocalDistance. |
| MLResult | MLCameraMetadataGetLensFocusDistanceRequestMetadata(MLHandle request_handle, float * out_data) Gets Lens focus distance in diopters. The distance is between minimum focus distance and hyperfocal distance. |
| MLResult | MLCameraMetadataGetControlModeRequestMetadata(MLHandle request_handle, MLCameraMetadataControlMode * out_data) Gets mode. |
| MLResult | MLCameraMetadataGetControlSceneModeRequestMetadata(MLHandle request_handle, MLCameraMetadataControlSceneMode * out_data) Gets Scene mode. |
| MLResult | MLCameraMetadataGetSensorExposureTimeRequestMetadata(MLHandle request_handle, int64_t * out_data) Gets sensor exposure time. |
| MLResult | MLCameraMetadataGetSensorSensitivityRequestMetadata(MLHandle request_handle, int32_t * out_data) Gets sensor sensitivity. |
| MLResult | MLCameraMetadataGetPostRawSensitivityBoostRequestMetadata(MLHandle request_handle, int32_t * out_data) Gets post raw sensitivity boost. |
| MLResult | MLCameraMetadataGetControlEffectModeRequestMetadata(MLHandle request_handle, MLCameraMetadataControlEffectMode * out_data) Effect mode. |
| MLResult | MLCameraMetadataGetControlExposureUpperTimeLimitRequestMetadata(MLHandle request_handle, int64_t * out_data) Gets exposure time upper limit. |
| MLResult | MLCameraMetadataGetJpegGPSCoordinatesRequestMetadata(MLHandle request_handle, double out_data[3]) Gets JPEG GPS coordinates. |
| MLResult | MLCameraMetadataGetJpegGPSTimestampRequestMetadata(MLHandle request_handle, int64_t * out_data) Gets JPEG timestamp. |
| MLResult | MLCameraMetadataGetJpegThumbnailSizeRequestMetadata(MLHandle request_handle, MLCameraMetadataJpegThumbnailSize * out_data) Gets JPEG thumbnail size. |
| MLResult | MLCameraMetadataGetJpegQualityRequestMetadata(MLHandle request_handle, uint8_t * out_data) Gets JPEG quality. |
| MLResult | MLCameraMetadataGetControlForceApplyModeRequestMetadata(MLHandle request_handle, MLCameraMetadataControlForceApplyMode * out_data) Gets force apply mode. Main camera and CV Camera share the same camera hardware resources. When both the cameras are streaming, request metadata properties for both cameras are merged and then applied. While merging, the metadata properties from Main Camera take precedence over CV camera metadata properties. The force apply mode property can be used to override this. If CV Camera metadata has force apply mode on, the CV Camera metadata properties take precedence over Main Camera metadata properties. |
| MLResult | MLCameraMetadataSetColorCorrectionMode(MLHandle request_handle, const MLCameraMetadataColorCorrectionMode * data) Sets color correction mode. |
| MLResult | MLCameraMetadataSetColorCorrectionTransform(MLHandle request_handle, const MLCameraMetadataRational data[3][3]) Sets color correction transform from RGB color space to output linear sRGB. |
| MLResult | MLCameraMetadataSetColorCorrectionGains(MLHandle request_handle, const float data[4]) Sets color correction gains. The gains in the request metadata are the gains applied by the camera device. |
| MLResult | MLCameraMetadataSetColorCorrectionAberrationMode(MLHandle request_handle, const MLCameraMetadataColorCorrectionAberrationMode * data) Sets color correction chromatic aberration, minimizing chromatic artifacts that may occur. |
| MLResult | MLCameraMetadataSetControlAEAntibandingMode(MLHandle request_handle, const MLCameraMetadataControlAEAntibandingMode * data) Sets AE antiband mode. |
| MLResult | MLCameraMetadataSetControlAEExposureCompensation(MLHandle request_handle, const int32_t * data) Sets auto-exposure compensation. |
| MLResult | MLCameraMetadataSetControlAELock(MLHandle request_handle, const MLCameraMetadataControlAELock * data) Sets auto-exposure lock. |
| MLResult | MLCameraMetadataSetControlAEMode(MLHandle request_handle, const MLCameraMetadataControlAEMode * data) Sets auto-exposure mode. MLCameraMetadataControlAEMode_Off is not supported if camera is configured for 15FPS. |
| MLResult | MLCameraMetadataSetControlAERegions(MLHandle request_handle, const int32_t data[3][5], const uint32_t count) Sets auto-exposure regions. |
| MLResult | MLCameraMetadataSetControlAWBLock(MLHandle request_handle, const MLCameraMetadataControlAWBLock * data) Sets automatic white balance lock. |
| MLResult | MLCameraMetadataSetControlAWBMode(MLHandle request_handle, const MLCameraMetadataControlAWBMode * data) Sets AWB mode. |
| MLResult | MLCameraMetadataSetControlAFMode(MLHandle request_handle, const MLCameraMetadataControlAFMode * data) Sets AF mode. |
| MLResult | MLCameraMetadataSetControlAFTrigger(MLHandle request_handle, const MLCameraMetadataControlAFTrigger * data) Sets AF trigger. |
| MLResult | MLCameraMetadataSetControlAFRegions(MLHandle request_handle, const int32_t data[3][5], const uint32_t count) Sets auto-focus regions. |
| MLResult | MLCameraMetadataSetAFDistanceRange(MLHandle request_handle, const float data[2]) Sets AF distance range. Both min and max are specified as focus distance in diopters. The min value specifies the lower bound for focus distance used by Autofocus algorithm and should be more than min focus distance which can be queried using MLCameraMetadataGetLensInfoMinimumFocusDistance. The max value specifies the upper bound for focus distance used by Autofocus algorithm and should be less than hyperfocal distance which can be queried using api MLCameraMetadataGetLensInfoHyperfocalDistance. |
| MLResult | MLCameraMetadataSetLensFocusDistance(MLHandle request_handle, const float * data) Sets Lens focus distance. |
| MLResult | MLCameraMetadataSetControlMode(MLHandle request_handle, const MLCameraMetadataControlMode * data) Sets mode. |
| MLResult | MLCameraMetadataSetControlSceneMode(MLHandle request_handle, const MLCameraMetadataControlSceneMode * data) Sets Scene mode. |
| MLResult | MLCameraMetadataSetSensorExposureTime(MLHandle request_handle, const int64_t * data) Sets sensor exposure time. |
| MLResult | MLCameraMetadataSetSensorSensitivity(MLHandle request_handle, const int32_t * data) Sets sensor sensitivity. |
| MLResult | MLCameraMetadataSetPostRawSensitivityBoost(MLHandle request_handle, const int32_t * data) Sets post raw sensitivity boost. |
| MLResult | MLCameraMetadataSetControlEffectMode(MLHandle request_handle, const MLCameraMetadataControlEffectMode * data) Sets Effect mode. |
| MLResult | MLCameraMetadataSetControlExposureUpperTimeLimit(MLHandle request_handle, const int64_t * data) Sets exposure time upper limit. |
| MLResult | MLCameraMetadataSetJpegGPSCoordinates(MLHandle request_handle, const double data[3]) Sets JPEG GPS coordinates. |
| MLResult | MLCameraMetadataSetJpegGPSTimestamp(MLHandle request_handle, const int64_t * data) Sets JPEG timestamp. |
| MLResult | MLCameraMetadataSetJpegThumbnailSize(MLHandle request_handle, const MLCameraMetadataJpegThumbnailSize * data) Sets JPEG thumbnail size. |
| MLResult | MLCameraMetadataSetJpegQuality(MLHandle request_handle, const uint8_t * data) Sets JPEG quality. |
| MLResult | MLCameraMetadataSetControlForceApplyMode(MLHandle request_handle, const MLCameraMetadataControlForceApplyMode * data) Sets force apply mode. Main camera and CV Camera share the same camera hardware resources. When both the cameras are streaming, request metadata properties for both cameras are merged and then applied. While merging, the metadata properties from Main Camera take precedence over CV camera metadata properties. The force apply mode property can be used to override this. If CV Camera metadata has force apply mode on, the CV Camera metadata properties take precedence over Main Camera metadata properties. |
| MLResult | MLCameraMetadataGetColorCorrectionModeResultMetadata(MLHandle result_handle, MLCameraMetadataColorCorrectionMode * out_data) Gets color correction. |
| MLResult | MLCameraMetadataGetColorCorrectionTransformResultMetadata(MLHandle result_handle, MLCameraMetadataRational out_data[3][3]) Gets color correction transform from RGB color space to output linear sRGB. |
| MLResult | MLCameraMetadataGetColorCorrectionAberrationModeResultMetadata(MLHandle result_handle, MLCameraMetadataColorCorrectionAberrationMode * out_data) Gets color correction aberration. |
| MLResult | MLCameraMetadataGetColorCorrectionGainsResultMetadata(MLHandle result_handle, float out_data[4]) Gets color correction gains. The gains in the result metadata are the gains applied by the camera device to the current frame. |
| MLResult | MLCameraMetadataGetControlAEAntibandingModeResultMetadata(MLHandle result_handle, MLCameraMetadataControlAEAntibandingMode * out_data) Gets AE antibanding mode. |
| MLResult | MLCameraMetadataGetControlAEExposureCompensationResultMetadata(MLHandle result_handle, int32_t * out_data) Gets AE exposure compensation. |
| MLResult | MLCameraMetadataGetControlAELockResultMetadata(MLHandle result_handle, MLCameraMetadataControlAELock * out_data) Gets auto-exposure lock. |
| MLResult | MLCameraMetadataGetControlAEModeResultMetadata(MLHandle result_handle, MLCameraMetadataControlAEMode * out_data) Gets AE mode. |
| MLResult | MLCameraMetadataGetControlAERegionsResultMetadata(MLHandle result_handle, int32_t out_data[3][5], uint32_t * out_count) Gets auto-exposure regions. |
| MLResult | MLCameraMetadataGetControlAETargetFPSRangeResultMetadata(MLHandle result_handle, int32_t out_data[2]) Gets auto-exposure target FPS range. |
| MLResult | MLCameraMetadataGetControlAEStateResultMetadata(MLHandle result_handle, MLCameraMetadataControlAEState * out_data) Gets AE state. |
| MLResult | MLCameraMetadataGetControlAWBLockResultMetadata(MLHandle result_handle, MLCameraMetadataControlAWBLock * out_data) Gets AWB lock. |
| MLResult | MLCameraMetadataGetControlAWBStateResultMetadata(MLHandle result_handle, MLCameraMetadataControlAWBState * out_data) Gets AWB state. |
| MLResult | MLCameraMetadataGetControlAWBModeResultMetadata(MLHandle result_handle, MLCameraMetadataControlAWBMode * out_data) Gets AWB mode. |
| MLResult | MLCameraMetadataGetControlAFModeResultMetadata(MLHandle result_handle, MLCameraMetadataControlAFMode * out_data) Gets AF mode. |
| MLResult | MLCameraMetadataGetControlAFTriggerResultMetadata(MLHandle result_handle, MLCameraMetadataControlAFTrigger * out_data) Gets AF trigger. |
| MLResult | MLCameraMetadataGetControlAFRegionsResultMetadata(MLHandle result_handle, int32_t out_data[3][5], uint32_t * out_count) Gets auto-focus regions. |
| MLResult | MLCameraMetadataGetAFDistanceRangeResultMetadata(MLHandle result_handle, float out_data[2]) Gets AF distance range. Both Min and Max are specified as focus distance in diopters. The min value specifies the lower bound for focus distance used by Autofocus algorithm and should be more than min focus distance which can be queried using MLCameraMetadataGetLensInfoMinimumFocusDistance. The max value specifies the upper bound for focus distance used by Autofocus algorithm and should be less than hyperfocal distance which can be queried using API MLCameraMetadataGetLensInfoHyperfocalDistance. |
| MLResult | MLCameraMetadataGetControlAFStateResultMetadata(MLHandle result_handle, MLCameraMetadataControlAFState * out_data) Gets AF state. |
| MLResult | MLCameraMetadataGetControlAFSceneChangeResultMetadata(MLHandle result_handle, MLCameraMetadataControlAFSceneChange * out_data) Gets AF scene change detection status. |
| MLResult | MLCameraMetadataGetLensFocusDistanceResultMetadata(MLHandle result_handle, float * out_data) Gets Lens focus distance. |
| MLResult | MLCameraMetadataGetLensStateResultMetadata(MLHandle result_handle, MLCameraMetadataLensState * out_data) Get Lens state. |
| MLResult | MLCameraMetadataGetControlModeResultMetadata(MLHandle result_handle, MLCameraMetadataControlMode * out_data) Gets mode. |
| MLResult | MLCameraMetadataGetControlSceneModeResultMetadata(MLHandle result_handle, MLCameraMetadataControlSceneMode * out_data) Gets Scene mode. |
| MLResult | MLCameraMetadataGetSensorExposureTimeResultMetadata(MLHandle result_handle, int64_t * out_data) Gets sensor exposure time. |
| MLResult | MLCameraMetadataGetSensorSensitivityResultMetadata(MLHandle result_handle, int32_t * out_data) Gets sensor sensitivity. |
| MLResult | MLCameraMetadataGetPostRawSensitivityBoostResultMetadata(MLHandle result_handle, int32_t * out_data) Gets post raw sensitivity boost. |
| MLResult | MLCameraMetadataGetSensorTimestampResultMetadata(MLHandle result_handle, int64_t * out_data) Gets frame captured timestamp. |
| MLResult | MLCameraMetadataGetSensorFrameDurationResultMetadata(MLHandle result_handle, int64_t * out_data) Gets sensor frame duration. |
| MLResult | MLCameraMetadataGetControlEffectModeResultMetadata(MLHandle result_handle, MLCameraMetadataControlEffectMode * out_data) Gets Effect mode. |
| MLResult | MLCameraMetadataGetControlExposureUpperTimeLimitResultMetadata(MLHandle result_handle, int64_t * out_data) Gets exposure time upper limit. |
| MLResult | MLCameraMetadataGetJpegGPSCoordinatesResultMetadata(MLHandle result_handle, double out_data[3]) Gets JPEG GPS coordinates. |
| MLResult | MLCameraMetadataGetJpegGPSTimestampResultMetadata(MLHandle result_handle, int64_t * out_data) Gets JPEG timestamp. |
| MLResult | MLCameraMetadataGetJpegThumbnailSizeResultMetadata(MLHandle result_handle, MLCameraMetadataJpegThumbnailSize * out_data) Gets JPEG thumbnail size. |
| MLResult | MLCameraMetadataGetControlForceApplyModeResultMetadata(MLHandle result_handle, MLCameraMetadataControlForceApplyMode * out_data) Gets force apply mode. Main camera and CV Camera share the same camera hardware resources. When both the cameras are streaming, request metadata properties for both cameras are merged and then applied. While merging, the metadata properties from Main Camera take precedence over CV camera metadata properties. The force apply mode property can be used to override this. If CV Camera metadata has force apply mode on, the CV Camera metadata properties take precedence over Main Camera metadata properties. |
| MLResult | MLCameraMetadataGetJpegQualityResultMetadata(MLHandle result_handle, uint8_t * out_data) Gets JPEG quality. |
Detailed Description
Enumeration definitions for the various metadata entries.
APIs for getting/setting camera characteristic/request/result metadata. Main camera and CV Camera share the same camera hardware resources. It is recommended that applications try to use as much as possible the default metadata returned by MLCameraPrepareCapture otherwise metadata properties from one camera can affect the other. When both the cameras are streaming, request metadata properties for both cameras are merged and then applied. While merging, the metadata properties from Main Camera take precedence over CV camera except for metadata proprties for exposure upper time limit, JPEG gps timestamp, JPEG gps coordinates, JPEG quality and JPEG thumbnail size. The Force Apply mode setting can be used to override this. If CV Camera metadata have force apply mode on, the CV Camera metadata properties take precedence over Main Camera properties. The result metadata returned in MLCameraCaptureCallbacks can be used to check the actual metadata settings applied. For exposure upper time limit the lower of 2 values (Main Camera and CV Camera) are applied by default.If one of the cameras has force apply mode on the exposure upper time limit setting from that camera is applied. The JPEG gps timestamp , JPEG gps coordinates, JPEG quality and JPEG thumbnail size settings from one camera donot affect the other camera.
State Machine for Auto Focus for different Modes.
| AutoFocus Mode Auto/Macro | State | Transition Cause | New State |
|---|---|---|---|
| AFState_Inactive | AFTrigger_Start | AFState_ActiveScan | Start AF scan, Lens now moving |
| AFState_ActiveScan | Camera AF completes current scan | AFState_FocussedLocked | Focussed, Lens now locked |
| AFState_ActiveScan | Camera AF fails current scan | AFState_NotFocussedLocked | Not focussed, Lens now locked |
| AFState_ActiveScan | AFTrigger_Cancel | AFState_Inactive | Cancel/reset AF |
| AFState_FocussedLocked | AFTrigger_Cancel | AFState_Inactive | Cancel/reset AF |
| AFState_FocussedLocked | AFTrigger_Start | AFState_ActiveScan | Restart AF scan, Lens now moving |
| AFState_NotFocussedLocked | AFTrigger_Cancel | AFState_Inactive | Cancel/reset AF |
| AFState_NotFocussedLocked | AFTrigger_Start | AFState_ActiveScan | Restart AF scan, Lens now moving |
| AutoFocus Mode Continuous Video | State | Transition Cause | New State |
|---|---|---|---|
| AFState_PassiveScan | Camera AF completes current scan | AFState_PassiveFocussed | End AF scan, Lens Focussed |
| AFState_PassiveScan | Camera AF fails current scan | AFState_PassiveUnFocussed | End AF scan, Lens Not Focussed |
| AFState_PassiveScan | AFTrigger_Start | AFState_FocussedLocked | Immediate transition, if focus is good, Lens now locked |
| AFState_PassiveScan | AFTrigger_Start | AFState_NotFocussedLocked | Immediate transition, if focus is not good, Lens now locked |
| AFState_PassiveFocussed | Camera AF initiates new scan | AFState_PassiveScan | Restart AF scan, Lens now moving |
| AFState_PassiveUnFocussed | Camera AF initiates new scan | AFState_PassiveScan | Restart AF scan, Lens now moving |
| AFState_PassiveFocussed | AFTrigger_Start | AFState_FocussedLocked | Lens now locked and Focussed |
| AFState_PassiveUnFocussed | AFTrigger_Start | AFState_NotFocussedLocked | Lens now locked and Not Focussed |
| AFState_FocussedLocked | AFTrigger_Cancel | AFState_PassiveScan | Restart AF Scan, Lens now moving |
| AFState_NotFocussedLocked | AFTrigger_Cancel | AFState_PassiveScan | Restart AF Scan, Lens now moving |
| AutoFocus Mode Continuous Picture | State | Transition Cause | New State |
|---|---|---|---|
| AFState_PassiveScan | Camera AF completes current scan | AFState_PassiveFocussed | End AF scan, Lens Focussed |
| AFState_PassiveScan | Camera AF fails current scan | AFState_PassiveUnFocussed | End AF scan, Lens Not Focussed |
| AFState_PassiveScan | AFTrigger_Start | AFState_FocussedLocked | Eventual transition once focus is good, Lens now locked |
| AFState_PassiveScan | AFTrigger_Start | AFState_NotFocussedLocked | Eventual transition if cannot find focus, Lens now locked |
| AFState_PassiveFocussed | Camera AF initiates new scan | AFState_PassiveScan | Restart AF scan, Lens now moving |
| AFState_PassiveUnFocussed | Camera AF initiates new scan | AFState_PassiveScan | Restart AF scan, Lens now moving |
| AFState_PassiveFocussed | AFTrigger_Start | AFState_FocussedLocked | Lens now locked and Focussed |
| AFState_PassiveUnFocussed | AFTrigger_Start | AFState_NotFocussedLocked | Lens now locked and Not Focussed |
| AFState_FocussedLocked | AFTrigger_Cancel | AFState_PassiveScan | Restart AF Scan, Lens now moving |
| AFState_NotFocussedLocked | AFTrigger_Cancel | AFState_PassiveScan | Restart AF Scan, Lens now moving |
Stringify the error codes returned by these APIs, call MLMediaResultGetString.
- THIS API IS DEPRECATED IN FAVOR OF STANDARD ANDROID SDK AND NDK CAMERA APIs: https://developer.android.com/training/camera2https://developer.android.com/ndk/reference/group/camera
- THIS API IS DEPRECATED IN FAVOR OF STANDARD ANDROID SDK AND NDK CAMERA APIs: https://developer.android.com/training/camera2https://developer.android.com/ndk/reference/group/camera
Shared Object:
- camera_metadata.magicleap*
Enums Documentation
MLCameraMetadataColorCorrectionMode
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataColorCorrectionMode_TransformMatrix | 0 | Uses data provided by the High Quality or Fast method to provide a picture with the same white point as the previous frame. |
| MLCameraMetadataColorCorrectionMode_Fast | The camera device will not slow down capture rate when applying color correction. | |
| MLCameraMetadataColorCorrectionMode_HighQuality | The camera device will use the highest-quality color correction algorithm, at the expense of capture rate speed. | |
| MLCameraMetadataColorCorrectionMode_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
Color correction mode.
MLCameraMetadataColorCorrectionAberrationMode
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataColorCorrectionAberrationMode_Off | 0 | No aberration correction is applied. |
| MLCameraMetadataColorCorrectionAberrationMode_Fast | The camera device will not slow down capture rate when applying aberration correction. | |
| MLCameraMetadataColorCorrectionAberrationMode_HighQuality | The camera device will use the highest-quality aberration correction algorithm, at the expense of capture rate speed. | |
| MLCameraMetadataColorCorrectionAberrationMode_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
Color correction aberration mode.
MLCameraMetadataControlAEAntibandingMode
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataControlAEAntibandingMode_Off | 0 | AE antibanding is disabled. |
| MLCameraMetadataControlAEAntibandingMode_50Hz | 50Hz. | |
| MLCameraMetadataControlAEAntibandingMode_60Hz | 60Hz. | |
| MLCameraMetadataControlAEAntibandingMode_Auto | Auto. | |
| MLCameraMetadataControlAEAntibandingMode_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
The list of auto-exposure (AE) antibanding modes. These controls prevent the appearance of vertical lines when capturing TV screens or monitors.
MLCameraMetadataControlAELock
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataControlAELock_Off | 0 | Auto-exposure lock is disabled. The algorithm can update exposure parameters. |
| MLCameraMetadataControlAELock_On | Auto-exposure lock is enabled. The algorithm cannot update exposure parameters. | |
| MLCameraMetadataControlAELock_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
The current auto-exposure (AE) lockc controls.
MLCameraMetadataControlAEMode
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataControlAEMode_Off | 0 | Disables the camera device's auto-exposure routine. |
| MLCameraMetadataControlAEMode_On | Enables the camera device's auto-exposure routine. | |
| MLCameraMetadataControlAEMode_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
The current auto-exposure (AE) mode controls.
MLCameraMetadataControlAWBLock
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataControlAWBLock_Off | 0 | Disables the auto-white balance lock. AWB algorithm is free to update its parameters. |
| MLCameraMetadataControlAWBLock_On | Enables the auto-white balance lock. AWB algorithm cannot update its parameters. | |
| MLCameraMetadataControlAWBLock_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
Control AWB lock.
MLCameraMetadataControlAWBMode
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataControlAWBMode_Off | 0 | Disables the camera device's auto-white balance routine. |
| MLCameraMetadataControlAWBMode_Auto | Sets the camera device's auto-white balance routine to automatic. | |
| MLCameraMetadataControlAWBMode_Incandescent | Incandescent light is assumed for the white balance. Auto-white balance is disabled. White balance transforms will approximately match the CIE standard illuminant A. | |
| MLCameraMetadataControlAWBMode_Fluorescent | Fluorescent light is assumed for the white balance. Auto-white balance is disabled. White balance transforms will approximately match the CIE standard illuminant F2. | |
| MLCameraMetadataControlAWBMode_WarmFluorescent | Warm fluorescent light is assumed for the white balance. Auto-white balance is disabled. White balance transforms will approximately match the CIE standard illuminant F4. | |
| MLCameraMetadataControlAWBMode_Daylight | Daylight light is assumed for the white balance. Auto-white balance is disabled. White balance transforms will approximately match the CIE standard illuminant D65. | |
| MLCameraMetadataControlAWBMode_CloudyDaylight | Cloudy daylight is assumed for the white balance. Auto-white balance is disabled. | |
| MLCameraMetadataControlAWBMode_Twilight | Twilight light is assumed for the white balance. Auto-white balance is disabled. | |
| MLCameraMetadataControlAWBMode_Shade | Shade light is assumed for the white balance. Auto-white balance is disabled. | |
| MLCameraMetadataControlAWBMode_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
The current auto-white-balance (AWB) mode controls.
MLCameraMetadataControlAFMode
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataControlAFMode_Off | 0 | Disables the camera device's auto-focus routine. |
| MLCameraMetadataControlAFMode_Auto | Sets the camera device's auto-focus routine to automatic. | |
| MLCameraMetadataControlAFMode_Macro | Sets the camera device's auto-focus routine to close-up focusing mode. | |
| MLCameraMetadataControlAFMode_ContinuousVideo | Sets the camera device's auto-focus routine to Continuous Video Mode. The focusing behavior should be suitable for good quality video recording. | |
| MLCameraMetadataControlAFMode_ContinuousPicture | Sets the camera device's auto-focus routine to Continuous Picture Mode. The focusing behavior should be suitable for still image capture. | |
| MLCameraMetadataControlAFMode_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
The current auto-focus (AF) mode controls.
MLCameraMetadataControlAFTrigger
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataControlAFTrigger_Idle | 0 | AF trigger is idle. |
| MLCameraMetadataControlAFTrigger_Start | AF will trigger now. | |
| MLCameraMetadataControlAFTrigger_Cancel | Cancel any currently active AF trigger. | |
| MLCameraMetadataControlAFTrigger_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
The current auto-focus (AF) trigger.
MLCameraMetadataControlMode
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataControlMode_Off | 0 | Disables control of the device's metering and focusing routines (3A). |
| MLCameraMetadataControlMode_Auto | Manual control of capture parameters is disabled. | |
| MLCameraMetadataControlMode_UseSceneMode | Use a specific scene mode. This setting is available only if scene mode is supported. | |
| MLCameraMetadataControlMode_OffKeepState | Same as MLCameraMetadataControlMode_Off mode, except any statistics or state updates collected from manual captures will be discarded by the camera device. | |
| MLCameraMetadataControlMode_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
Overall control mode of the 3A (auto-white balance, auto-focus, auto-exposure) parameters.
MLCameraMetadataControlSceneMode
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataControlSceneMode_None | 0 | Scene mode not used. |
| MLCameraMetadataControlSceneMode_Action | 2 | Action mode – optimized for photos of quickly moving objects. |
| MLCameraMetadataControlSceneMode_Portrait | 3 | Portrait mode – optimized for still photos of people. |
| MLCameraMetadataControlSceneMode_Landscape | 4 | Landscape mode – optimized for photos of distant macroscopic objects. |
| MLCameraMetadataControlSceneMode_Theatre | 7 | Theatre mode – ptimized for dim, indoor settings without flash. |
| MLCameraMetadataControlSceneMode_Sports | 13 | Sports mode – similar to Action mode, and optimized for photos of quickly moving people. |
| MLCameraMetadataControlSceneMode_Party | 14 | Party mode – optimized for dim, indoor settings with multiple moving people. |
| MLCameraMetadataControlSceneMode_CandleLight | 15 | CandleLight mode – optimized for extremely dim settings with a single light source. |
| MLCameraMetadataControlSceneMode_Barcode | 16 | Barcode mode. This mode is optimized for accurately capturing barcode images with the intent of processing the barcode value. |
| MLCameraMetadataControlSceneMode_Medical | 100 | Medical mode. This mode is optimized for brightly lit settings (100-200K lux) such as an operation theater. |
| MLCameraMetadataControlSceneMode_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
Scene mode.
MLCameraMetadataControlEffectMode
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataControlEffectMode_Off | 0 | Off. |
| MLCameraMetadataControlEffectMode_Grayscale | GrayScale – maps the image into grayscale colors. | |
| MLCameraMetadataControlEffectMode_Negative | Negative – inverts the colors of the image. | |
| MLCameraMetadataControlEffectMode_Sepia | Sepia – maps the image into warm gray, red, and brown tones. | |
| MLCameraMetadataControlEffectMode_ColorSelection | ColorSelection. | |
| MLCameraMetadataControlEffectMode_Sharpening | Sharpening – emphasises the edges of adjacent areas with tonal contrast to one another. | |
| MLCameraMetadataControlEffectMode_Emboss | Emboss – applies an emboss filter, replacing each pixel with shadow or highlight depending on its light or dark boundaries. | |
| MLCameraMetadataControlEffectMode_Sketch | Sketch. | |
| MLCameraMetadataControlEffectMode_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
Effect mode. Applies color effects.
MLCameraMetadataControlAEState
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataControlAEState_Inactive | 0 | AE is off or recently reset. The camera device begins in this mode. Device may fail to report this state. |
| MLCameraMetadataControlAEState_Searching | AE does not yet have a good set of control values for the current scene. Device may fail to report this state. | |
| MLCameraMetadataControlAEState_Converged | AE has a good set of control values for the current scene. | |
| MLCameraMetadataControlAEState_Locked | AE is locked. | |
| MLCameraMetadataControlAEState_FlashRequired | AE has a good set of control values, but flash is required for good quality still capture. | |
| MLCameraMetadataControlAEState_PreCapture | AE has been asked to do a precapture sequence and is currently executing it. Once this mode is complete, AE will transition to MLCameraMetadataControlAEState_Converged or MLCameraMetadataControlAEState_FlashRequired. | |
| MLCameraMetadataControlAEState_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
Currents state of auto-exposure (AE) controls.
MLCameraMetadataControlAWBState
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataControlAWBState_Inactive | 0 | AWB is in not in automatic mode or has not yet started metering. The camera device begins in this mode. Device may fail to report this state. |
| MLCameraMetadataControlAWBState_Searching | AWB does not yet have a good set of control values for the current scene. Device may fail to report this state. | |
| MLCameraMetadataControlAWBState_Converged | AWB has a good set of control values for the current scene. | |
| MLCameraMetadataControlAWBState_Locked | AWB is locked. | |
| MLCameraMetadataControlAWBState_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
Current state of auto-white-balance (AWB) controls.
MLCameraMetadataControlAFState
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataControlAFState_Inactive | 0 | AF is off or has not yet tried to scan. |
| MLCameraMetadataControlAFState_PassiveScan | AF is currently performing an AF scan initiated by the camera device in a continuous autofocus mode. | |
| MLCameraMetadataControlAFState_PassiveFocussed | AF currently is in focus, but may restart scanning at any time. | |
| MLCameraMetadataControlAFState_ActiveScan | AF is performing an AF scan triggered by AF trigger. | |
| MLCameraMetadataControlAFState_FocusedLocked | AF is focused correctly and has locked focus. | |
| MLCameraMetadataControlAFState_NotFocusedLocked | AF has failed to focus successfully and has locked focus. | |
| MLCameraMetadataControlAFState_PassiveUnFocussed | AF finished a passive scan without finding focus,and may restart scanning at any time. | |
| MLCameraMetadataControlAFState_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
Current state of auto-focus (AF) routine.
MLCameraMetadataControlAFSceneChange
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataControlAFSceneChange_NotDetected | 0 | No scene change detected by AF. |
| MLCameraMetadataControlAFSceneChange_Detected | Scene change detected by AF. | |
| MLCameraMetadataControlAFSceneChange_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
Whether a significant scene change is detected by AF algorithm.
MLCameraMetadataLensState
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataLensState_Stationary | 0 | Lens focal length is not changing. |
| MLCameraMetadataLensState_Moving | Lens focal length is changing. | |
| MLCameraMetadataLensState_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
Current Lens status.
MLCameraMetadataScalerAvailableFormats
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataScalerAvailableFormats_RAW16 | 0x20 | Raw16. |
| MLCameraMetadataScalerAvailableFormats_RAW_OPAQUE | 0x24 | Raw opaque. |
| MLCameraMetadataScalerAvailableFormats_YV12 | 0x32315659 | TV12. |
| MLCameraMetadataScalerAvailableFormats_YCrCb_420_SP | 0x11 | YCrCb 420 SP. |
| MLCameraMetadataScalerAvailableFormats_IMPLEMENTATION_DEFINED | 0x22 | Implementation defined. |
| MLCameraMetadataScalerAvailableFormats_YCbCr_420_888 | 0x23 | YCrCb 420 888. |
| MLCameraMetadataScalerAvailableFormats_BLOB | 0x21 | BLOB. |
| MLCameraMetadataScalerAvailableFormats_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
Scaler available formats.
MLCameraMetadataScalerAvailableStreamConfigurations
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataScalerAvailableStreamConfigurations_OUTPUT | 0 | Output. |
| MLCameraMetadataScalerAvailableStreamConfigurations_INPUT | Input. | |
| MLCameraMetadataScalerAvailableStreamConfigurations_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
The available stream configurations .
MLCameraMetadataJpegThumbnailSize
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataJpegThumbnailSize_160x120 | 1 | 160x120. |
| MLCameraMetadataJpegThumbnailSize_240x135 | 2 | 240x135. |
| MLCameraMetadataJpegThumbnailSize_256x135 | 3 | 256x135. |
| MLCameraMetadataJpegThumbnailSize_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
JPEG Thumbnail Size.
MLCameraMetadataControlForceApplyMode
| Enumerator | Value | Description |
|---|---|---|
| MLCameraMetadataControlForceApplyMode_Off | 0 | Off. |
| MLCameraMetadataControlForceApplyMode_On | 1 | On. |
| MLCameraMetadataControlForceApplyMode_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
Force Apply Metadata Settings.
Types Documentation
MLCameraMetadataRational
typedef struct MLCameraMetadataRational MLCameraMetadataRational;
Rational data type.
Functions Documentation
MLCameraMetadataGetColorCorrectionAvailableAberrationModes
MLResult MLCameraMetadataGetColorCorrectionAvailableAberrationModes(
MLHandle characteristics_handle,
MLCameraMetadataColorCorrectionAberrationMode ** out_data,
uint32_t * out_count
)
Gets color correction aberration modes.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| MLCameraMetadataColorCorrectionAberrationMode ** | out_data | Array of aberration modes. The Library allocates and maintains the lifetime of the output data. |
| uint32_t * | out_count | Number of output data elements. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain color correction aberration modes due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained color correction aberration modes. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain color correction aberration modes due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAEAvailableModes
MLResult MLCameraMetadataGetControlAEAvailableModes(
MLHandle characteristics_handle,
MLCameraMetadataControlAEMode ** out_data,
uint32_t * out_count
)
Gets auto-exposure modes.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| MLCameraMetadataControlAEMode ** | out_data | Array of auto-exposure modes. The Library allocates and maintains the lifetime of the output data. |
| uint32_t * | out_count | Number of output data elements. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE modes due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE modes. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE modes due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAEAvailableAntibandingModes
MLResult MLCameraMetadataGetControlAEAvailableAntibandingModes(
MLHandle characteristics_handle,
MLCameraMetadataControlAEAntibandingMode ** out_data,
uint32_t * out_count
)
Gets anti-banding modes.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| MLCameraMetadataControlAEAntibandingMode ** | out_data | Array of anti-banding modes. The Library allocates and maintains the lifetime of the output data. |
| uint32_t * | out_count | Number of output data elements. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AntiBanding modes due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AntiBanding modes. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AntiBanding modes due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAECompensationRange
MLResult MLCameraMetadataGetControlAECompensationRange(
MLHandle characteristics_handle,
int32_t out_data[2]
)
Gets auto-exposure compensation range.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| int32_t | out_data | Array of min (1st) and max (2nd) of auto-exposure compensation. The adjustment is measured as a count of steps. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE compensation range due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE compensation range. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE compensation range due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAECompensationStep
MLResult MLCameraMetadataGetControlAECompensationStep(
MLHandle characteristics_handle,
MLCameraMetadataRational * out_data
)
Gets AE compensation step.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| MLCameraMetadataRational * | out_data | AE compensation step. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE compensation step due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE compensation step. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE compensation step due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAELockAvailable
MLResult MLCameraMetadataGetControlAELockAvailable(
MLHandle characteristics_handle,
MLCameraMetadataControlAELock * out_data
)
Gets AE lock.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| MLCameraMetadataControlAELock * | out_data | AE lock. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE lock due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE lock. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE lock due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAEMaxRegions
MLResult MLCameraMetadataGetControlAEMaxRegions(
MLHandle characteristics_handle,
int32_t * out_data
)
Gets AE Max Regions.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| int32_t * | out_data | Num AE Regions. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE Max Regions due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE Max Regions. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE Max Regions due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAvailableModes
MLResult MLCameraMetadataGetControlAvailableModes(
MLHandle characteristics_handle,
MLCameraMetadataControlMode ** out_data,
uint32_t * out_count
)
Gets Available Modes.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| MLCameraMetadataControlMode ** | out_data | Array of modes. The Library allocates and maintains the lifetime of the output data. |
| uint32_t * | out_count | Number of output data elements. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain Avaialble Modes due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained Available Modes. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain Available Modes due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAWBAvailableModes
MLResult MLCameraMetadataGetControlAWBAvailableModes(
MLHandle characteristics_handle,
MLCameraMetadataControlAWBMode ** out_data,
uint32_t * out_count
)
Gets AWB modes.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| MLCameraMetadataControlAWBMode ** | out_data | Array of AWB modes. The Library allocates and maintains the lifetime of the output data. |
| uint32_t * | out_count | Number of output data elements. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AWB modes due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AWB modes. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AWB modes due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAFAvailableModes
MLResult MLCameraMetadataGetControlAFAvailableModes(
MLHandle characteristics_handle,
MLCameraMetadataControlAFMode ** out_data,
uint32_t * out_count
)
Gets AF modes.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| MLCameraMetadataControlAFMode ** | out_data | Array of AF modes. The Library allocates and maintains the lifetime of the output data. |
| uint32_t * | out_count | Number of output data elements. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AF modes due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AF modes. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AF modes due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAFMaxRegions
MLResult MLCameraMetadataGetControlAFMaxRegions(
MLHandle characteristics_handle,
int32_t * out_data
)
Gets max number of AF regions supported.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| int32_t * | out_data | Num AF Regions. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AF Max Regions due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AF Max Regions. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AF Max Regions due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAvailableSceneModes
MLResult MLCameraMetadataGetControlAvailableSceneModes(
MLHandle characteristics_handle,
MLCameraMetadataControlSceneMode ** out_data,
uint32_t * out_count
)
Gets Scene modes.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| MLCameraMetadataControlSceneMode ** | out_data | Array of Scene modes. The Library allocates and maintains the lifetime of the output data. |
| uint32_t * | out_count | Number of output data elements. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain Scene modes due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained Scene modes. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain Scene modes due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAvailableEffectModes
MLResult MLCameraMetadataGetControlAvailableEffectModes(
MLHandle characteristics_handle,
MLCameraMetadataControlEffectMode ** out_data,
uint32_t * out_count
)
Gets Effect modes.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| MLCameraMetadataControlEffectMode ** | out_data | Array of Effect modes. The Library allocates and maintains the lifetime of the output data. |
| uint32_t * | out_count | Number of output data elements. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain Effect modes due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained Effect modes. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain Effect modes due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAWBLockAvailable
MLResult MLCameraMetadataGetControlAWBLockAvailable(
MLHandle characteristics_handle,
MLCameraMetadataControlAWBLock * out_data
)
Gets AWB lock.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| MLCameraMetadataControlAWBLock * | out_data | AWB lock. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AWB lock due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AWB lock. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AWB lock due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetSensorInfoActiveArraySize
MLResult MLCameraMetadataGetSensorInfoActiveArraySize(
MLHandle characteristics_handle,
int32_t out_data[4]
)
Gets sensor info active array sizes.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| int32_t | out_data | Active array size [left, top, right, bottom]. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain sensor info active array sizes due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained sensor info active array sizes. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain sensor info active array sizes due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetSensorInfoSensitivityRange
MLResult MLCameraMetadataGetSensorInfoSensitivityRange(
MLHandle characteristics_handle,
int32_t out_data[2]
)
Gets sensor info sensitivity range (Analog Gain).
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| int32_t | out_data | Sensor info sensitivity range[min, max]. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain sensor info sensitivity range due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained sensor info sensitivity range. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain sensor info sensitivity range due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetPostRawSensitivityBoostRange
MLResult MLCameraMetadataGetPostRawSensitivityBoostRange(
MLHandle characteristics_handle,
int32_t out_data[2]
)
Gets post raw sensitivity boost range (Digital Gain).
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| int32_t | out_data | Post raw sensitivity boost range[min, max]. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain post raw sensitivity boost range due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained post raw sensitivity boost range. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain post raw sensitivity boost range due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetLensInfoHyperfocalDistance
MLResult MLCameraMetadataGetLensInfoHyperfocalDistance(
MLHandle characteristics_handle,
float * out_data
)
Gets lens hyperfocal distance.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| float * | out_data | Lens hyperfocal distance in diopters. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain hyperfocal distance due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained hyperfocal distance. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain hyperfocal distance due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetLensInfoMinimumFocusDistance
MLResult MLCameraMetadataGetLensInfoMinimumFocusDistance(
MLHandle characteristics_handle,
float * out_data
)
Gets lens minimum focus distance.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| float * | out_data | Minimum focus distance in diopters. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain minimum focus distance due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained minimum focus distance. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain minimum focus distance due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetLensInfoMinimumFocusDistanceIncrement
MLResult MLCameraMetadataGetLensInfoMinimumFocusDistanceIncrement(
MLHandle characteristics_handle,
float * out_data
)
Gets lens minimum focus distance increment. The lens position can be set in multiples of distance increments between hyperfocal distance and minimum focus distance.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| float * | out_data | Minimum focus distance increment in diopters. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain minimum focus distance increment due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained minimum focus distance increment. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain minimum focus distance increment due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetSensorOrientation
MLResult MLCameraMetadataGetSensorOrientation(
MLHandle characteristics_handle,
int32_t * out_data
)
Gets sensor orientation degree.
Parameters
| MLHandle | characteristics_handle | Camera characteristic metadata handle acquired from MLCameraGetCameraCharacteristics. |
| int32_t * | out_data | Sensor orientation degree. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain sensor orientation degree due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained sensor orientation degree. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain sensor orientation degree due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetColorCorrectionModeRequestMetadata
MLResult MLCameraMetadataGetColorCorrectionModeRequestMetadata(
MLHandle request_handle,
MLCameraMetadataColorCorrectionMode * out_data
)
Gets color correction mode.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| MLCameraMetadataColorCorrectionMode * | out_data | Color correction mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain color correction mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained color correction mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain color correction mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetColorCorrectionTransformRequestMetadata
MLResult MLCameraMetadataGetColorCorrectionTransformRequestMetadata(
MLHandle request_handle,
MLCameraMetadataRational out_data[3][3]
)
Gets color correction transform.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| MLCameraMetadataRational | out_data | 3x3 color correction transform. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain color correction transform due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained color correction transform. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain color correction transform due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetColorCorrectionGainsRequestMetadata
MLResult MLCameraMetadataGetColorCorrectionGainsRequestMetadata(
MLHandle request_handle,
float out_data[4]
)
Gets color correction gains.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| float | out_data | Color correction gains. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain color correction gains due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained color correction gains. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain color correction gains due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetColorCorrectionAberrationModeRequestMetadata
MLResult MLCameraMetadataGetColorCorrectionAberrationModeRequestMetadata(
MLHandle request_handle,
MLCameraMetadataColorCorrectionAberrationMode * out_data
)
Gets color correction aberration.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| MLCameraMetadataColorCorrectionAberrationMode * | out_data | Color correction aberration. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain color correction aberration due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained color correction aberration. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain color correction aberration due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAEAntibandingModeRequestMetadata
MLResult MLCameraMetadataGetControlAEAntibandingModeRequestMetadata(
MLHandle request_handle,
MLCameraMetadataControlAEAntibandingMode * out_data
)
Gets AE antibanding mode.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| MLCameraMetadataControlAEAntibandingMode * | out_data | AE antibanding mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE antibanding mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE antibanding mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE antibanding mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAEExposureCompensationRequestMetadata
MLResult MLCameraMetadataGetControlAEExposureCompensationRequestMetadata(
MLHandle request_handle,
int32_t * out_data
)
Gets AE exposure compensation.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| int32_t * | out_data | Exposure compensation value. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE exposure compensation due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE exposure compensation. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE exposure compensation due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAELockRequestMetadata
MLResult MLCameraMetadataGetControlAELockRequestMetadata(
MLHandle request_handle,
MLCameraMetadataControlAELock * out_data
)
Gets AE lock.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| MLCameraMetadataControlAELock * | out_data | AE Lock. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE lock due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE lock. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE lock due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAEModeRequestMetadata
MLResult MLCameraMetadataGetControlAEModeRequestMetadata(
MLHandle request_handle,
MLCameraMetadataControlAEMode * out_data
)
Gets AE mode.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| MLCameraMetadataControlAEMode * | out_data | AE mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAERegionsRequestMetadata
MLResult MLCameraMetadataGetControlAERegionsRequestMetadata(
MLHandle request_handle,
int32_t out_data[3][5],
uint32_t * out_count
)
Gets auto-exposure regions.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| int32_t | out_data | Auto-exposure regions. Regions array of area_size x 5[xmin, ymin, xmax, ymax, weight]. Coordinates must be between [(0,0), (width, height)). |
| uint32_t * | out_count | Number of auto-exposure regions. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE regions due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE regions. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE regions due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAWBLockRequestMetadata
MLResult MLCameraMetadataGetControlAWBLockRequestMetadata(
MLHandle request_handle,
MLCameraMetadataControlAWBLock * out_data
)
Gets AWB lock.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| MLCameraMetadataControlAWBLock * | out_data | AWB Lock. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AWB lock due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AWB lock. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AWB lock due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAWBModeRequestMetadata
MLResult MLCameraMetadataGetControlAWBModeRequestMetadata(
MLHandle request_handle,
MLCameraMetadataControlAWBMode * out_data
)
Gets AWB mode.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| MLCameraMetadataControlAWBMode * | out_data | AWB mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AWB mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AWB mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AWB mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAFModeRequestMetadata
MLResult MLCameraMetadataGetControlAFModeRequestMetadata(
MLHandle request_handle,
MLCameraMetadataControlAFMode * out_data
)
Gets AF mode.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| MLCameraMetadataControlAFMode * | out_data | AF mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AF mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AF mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AF mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAFTriggerRequestMetadata
MLResult MLCameraMetadataGetControlAFTriggerRequestMetadata(
MLHandle request_handle,
MLCameraMetadataControlAFTrigger * out_data
)
Gets AF trigger.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| MLCameraMetadataControlAFTrigger * | out_data | AF trigger. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AF trigger due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AF trigger. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AF trigger due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAFRegionsRequestMetadata
MLResult MLCameraMetadataGetControlAFRegionsRequestMetadata(
MLHandle request_handle,
int32_t out_data[3][5],
uint32_t * out_count
)
Gets auto-focus regions.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| int32_t | out_data | Auto-focus regions. Regions array of area_size x 5[xmin, ymin, xmax, ymax, weight]. Coordinates must be between [(0,0), (width, height)). |
| uint32_t * | out_count | Number of auto-focus regions. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AF regions due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AF regions. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AF regions due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetAFDistanceRangeRequestMetadata
MLResult MLCameraMetadataGetAFDistanceRangeRequestMetadata(
MLHandle request_handle,
float out_data[2]
)
Gets AF distance range. Both Min and Max are specified as focus distance in diopters. The min value specifies the lower bound for focus distance used by Autofocus algorithm and should be more than min focus distance which can be queried using MLCameraMetadataGetLensInfoMinimumFocusDistance. The max value specifies the upper bound for focus distance used by Autofocus algorithm and should be less than hyperfocal distance which can be queried using api MLCameraMetadataGetLensInfoHyperfocalDistance.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| float | out_data | AF distance range [min, max]. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AF distance range due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AF distance range. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AF distance range due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetLensFocusDistanceRequestMetadata
MLResult MLCameraMetadataGetLensFocusDistanceRequestMetadata(
MLHandle request_handle,
float * out_data
)
Gets Lens focus distance in diopters. The distance is between minimum focus distance and hyperfocal distance.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| float * | out_data | Lens focus distance. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain Lens focus distance range due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained Lens focus distance range. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain Lens focus distance range due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlModeRequestMetadata
MLResult MLCameraMetadataGetControlModeRequestMetadata(
MLHandle request_handle,
MLCameraMetadataControlMode * out_data
)
Gets mode.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| MLCameraMetadataControlMode * | out_data | Mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlSceneModeRequestMetadata
MLResult MLCameraMetadataGetControlSceneModeRequestMetadata(
MLHandle request_handle,
MLCameraMetadataControlSceneMode * out_data
)
Gets Scene mode.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| MLCameraMetadataControlSceneMode * | out_data | Scene mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain scene mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained scene mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain scene mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetSensorExposureTimeRequestMetadata
MLResult MLCameraMetadataGetSensorExposureTimeRequestMetadata(
MLHandle request_handle,
int64_t * out_data
)
Gets sensor exposure time.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| int64_t * | out_data | Duration each pixel is exposed to light in nanoseconds. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain sensor exposure time due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained sensor exposure time. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain sensor exposure time due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetSensorSensitivityRequestMetadata
MLResult MLCameraMetadataGetSensorSensitivityRequestMetadata(
MLHandle request_handle,
int32_t * out_data
)
Gets sensor sensitivity.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| int32_t * | out_data | Sensor sensitivity. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain sensor sensitivity due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained sensor sensitivity. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain sensor sensitivity due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetPostRawSensitivityBoostRequestMetadata
MLResult MLCameraMetadataGetPostRawSensitivityBoostRequestMetadata(
MLHandle request_handle,
int32_t * out_data
)
Gets post raw sensitivity boost.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| int32_t * | out_data | Post raw sensitivity boost. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain post raw sensitivity boost due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained post raw sensitivity boost. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain post raw sensitivity boost due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlEffectModeRequestMetadata
MLResult MLCameraMetadataGetControlEffectModeRequestMetadata(
MLHandle request_handle,
MLCameraMetadataControlEffectMode * out_data
)
Effect mode.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| MLCameraMetadataControlEffectMode * | out_data | Effect mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain effect mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained effect mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain effect mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlExposureUpperTimeLimitRequestMetadata
MLResult MLCameraMetadataGetControlExposureUpperTimeLimitRequestMetadata(
MLHandle request_handle,
int64_t * out_data
)
Gets exposure time upper limit.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| int64_t * | out_data | Exposure time upper limit for auto exposure algorithm. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain exposure time upper limit due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained exposure time upper limit. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain exposure time upperlimit due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetJpegGPSCoordinatesRequestMetadata
MLResult MLCameraMetadataGetJpegGPSCoordinatesRequestMetadata(
MLHandle request_handle,
double out_data[3]
)
Gets JPEG GPS coordinates.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| double | out_data | JPEG GPS coordinates – latitude and longitude in degrees, altitude in meters. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain JPEG GPS coordinates due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained JPEG GPS coordinates. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain JPEG GPS coordinates due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetJpegGPSTimestampRequestMetadata
MLResult MLCameraMetadataGetJpegGPSTimestampRequestMetadata(
MLHandle request_handle,
int64_t * out_data
)
Gets JPEG timestamp.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| int64_t * | out_data | JPEG timestamp in UNIX Epoch time (UTC in seconds since January 1, 1970). |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain JPEG timestamp due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained JPEG timestamp. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain JPEG timestamp due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetJpegThumbnailSizeRequestMetadata
MLResult MLCameraMetadataGetJpegThumbnailSizeRequestMetadata(
MLHandle request_handle,
MLCameraMetadataJpegThumbnailSize * out_data
)
Gets JPEG thumbnail size.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| MLCameraMetadataJpegThumbnailSize * | out_data | Resolution of embedded JPEG thumbnail. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain JPEG thumbnail size due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained JPEG thumbnail size. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain JPEG thumbnail size due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetJpegQualityRequestMetadata
MLResult MLCameraMetadataGetJpegQualityRequestMetadata(
MLHandle request_handle,
uint8_t * out_data
)
Gets JPEG quality.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| uint8_t * | out_data | Compression quality of JPEG thumbnail, with 100 being the highest quality, and 1 the lowest. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain JPEG quality due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained JPEG quality. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain JPEG quality due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlForceApplyModeRequestMetadata
MLResult MLCameraMetadataGetControlForceApplyModeRequestMetadata(
MLHandle request_handle,
MLCameraMetadataControlForceApplyMode * out_data
)
Gets force apply mode. Main camera and CV Camera share the same camera hardware resources. When both the cameras are streaming, request metadata properties for both cameras are merged and then applied. While merging, the metadata properties from Main Camera take precedence over CV camera metadata properties. The force apply mode property can be used to override this. If CV Camera metadata has force apply mode on, the CV Camera metadata properties take precedence over Main Camera metadata properties.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| MLCameraMetadataControlForceApplyMode * | out_data | Force apply mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain force apply mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained force apply mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain force apply mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetColorCorrectionMode
MLResult MLCameraMetadataSetColorCorrectionMode(
MLHandle request_handle,
const MLCameraMetadataColorCorrectionMode * data
)
Sets color correction mode.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const MLCameraMetadataColorCorrectionMode * | data | Color correction mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set color correction mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set color correction mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set color correction mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetColorCorrectionTransform
MLResult MLCameraMetadataSetColorCorrectionTransform(
MLHandle request_handle,
const MLCameraMetadataRational data[3][3]
)
Sets color correction transform from RGB color space to output linear sRGB.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const MLCameraMetadataRational | data | Color correction transform (3x3). Set all values to 0/1 to clear the data. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set color correction transform due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set color correction transform. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set color correction transform due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetColorCorrectionGains
MLResult MLCameraMetadataSetColorCorrectionGains(
MLHandle request_handle,
const float data[4]
)
Sets color correction gains. The gains in the request metadata are the gains applied by the camera device.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const float | data | An array of floats for 4 color channel color correction gains. Set all values to 0 to clear the data. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set color correction gains due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set color correction gains. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set color correction gains due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetColorCorrectionAberrationMode
MLResult MLCameraMetadataSetColorCorrectionAberrationMode(
MLHandle request_handle,
const MLCameraMetadataColorCorrectionAberrationMode * data
)
Sets color correction chromatic aberration, minimizing chromatic artifacts that may occur.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const MLCameraMetadataColorCorrectionAberrationMode * | data | Color correction aberration. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set color correction aberration due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set color correction aberration. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set color correction aberration due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetControlAEAntibandingMode
MLResult MLCameraMetadataSetControlAEAntibandingMode(
MLHandle request_handle,
const MLCameraMetadataControlAEAntibandingMode * data
)
Sets AE antiband mode.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const MLCameraMetadataControlAEAntibandingMode * | data | AE antibanding mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set AE antiband mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set AE antiband mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set AE antiband mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetControlAEExposureCompensation
MLResult MLCameraMetadataSetControlAEExposureCompensation(
MLHandle request_handle,
const int32_t * data
)
Sets auto-exposure compensation.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const int32_t * | data | Exposure compensation value as a count of steps. If exposure compensation is set to 0, no exposure compensation will be applied. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set AE exposure compensation due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set AE exposure compensation. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set AE exposure compensation due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetControlAELock
MLResult MLCameraMetadataSetControlAELock(
MLHandle request_handle,
const MLCameraMetadataControlAELock * data
)
Sets auto-exposure lock.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const MLCameraMetadataControlAELock * | data | Auto-exposure Lock. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set AE lock due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set AE lock. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set AE lock due to an unknown error. |
Required Permissions:
- None
When auto-exposure is locked, the algorithm cannot update its parameters and adjust exposure times and sensitivity.
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetControlAEMode
MLResult MLCameraMetadataSetControlAEMode(
MLHandle request_handle,
const MLCameraMetadataControlAEMode * data
)
Sets auto-exposure mode. MLCameraMetadataControlAEMode_Off is not supported if camera is configured for 15FPS.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const MLCameraMetadataControlAEMode * | data | Auto-exposure mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set AE mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set AE mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set AE mode due to an unknown error. |
| MLResult | MLMediaGenericResult_InvalidOperation | Failed to set AE Mode due to conflict between fps setting and AE Mode. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetControlAERegions
MLResult MLCameraMetadataSetControlAERegions(
MLHandle request_handle,
const int32_t data[3][5],
const uint32_t count
)
Sets auto-exposure regions.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const int32_t | data | Auto-exposure regions. Regions array of area_size x 5[xmin, ymin, xmax, ymax, weight] array with all zeros and count 1 clears the data. Coordinates must be between [(0,0), (width, height)). Max width, height can be obtained using MLCameraMetadataGetSensorInfoActiveArraySize. Weight for a region can be between [0,1000].For a region to be used its weight should be > 0. Weight is used to decide relative priority between multiple regions. |
| const uint32_t | count | Number of auto-exposure regions. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set AE regions due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set AE regions. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set AE regions due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetControlAWBLock
MLResult MLCameraMetadataSetControlAWBLock(
MLHandle request_handle,
const MLCameraMetadataControlAWBLock * data
)
Sets automatic white balance lock.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const MLCameraMetadataControlAWBLock * | data | Automatic White Balance Lock. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set AE target FPS range due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set automatic white balance lock. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set automatic white balance lock due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetControlAWBMode
MLResult MLCameraMetadataSetControlAWBMode(
MLHandle request_handle,
const MLCameraMetadataControlAWBMode * data
)
Sets AWB mode.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const MLCameraMetadataControlAWBMode * | data | AWB mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set AWB mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set AWB mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set AWB mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetControlAFMode
MLResult MLCameraMetadataSetControlAFMode(
MLHandle request_handle,
const MLCameraMetadataControlAFMode * data
)
Sets AF mode.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const MLCameraMetadataControlAFMode * | data | AF mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set AF mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully set AF mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set AF mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetControlAFTrigger
MLResult MLCameraMetadataSetControlAFTrigger(
MLHandle request_handle,
const MLCameraMetadataControlAFTrigger * data
)
Sets AF trigger.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const MLCameraMetadataControlAFTrigger * | data | AF trigger. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set AF trigger due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully set AF trigger. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set AF trigger due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetControlAFRegions
MLResult MLCameraMetadataSetControlAFRegions(
MLHandle request_handle,
const int32_t data[3][5],
const uint32_t count
)
Sets auto-focus regions.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const int32_t | data | Auto-focus regions. Regions array of area_size x 5[xmin, ymin, xmax, ymax, weight]. Coordinates must be between [(0,0), (width, height)). Max width, height can be obtained using MLCameraMetadataGetSensorInfoActiveArraySize. Weight for a region can be between [0,1000]. For a region to be used its weight should be > 0. All regions with weight > 0 are treated as same priority. |
| const uint32_t | count | Number of auto-focus regions. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set AF regions due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully set AF regions. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set AF regions due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetAFDistanceRange
MLResult MLCameraMetadataSetAFDistanceRange(
MLHandle request_handle,
const float data[2]
)
Sets AF distance range. Both min and max are specified as focus distance in diopters. The min value specifies the lower bound for focus distance used by Autofocus algorithm and should be more than min focus distance which can be queried using MLCameraMetadataGetLensInfoMinimumFocusDistance. The max value specifies the upper bound for focus distance used by Autofocus algorithm and should be less than hyperfocal distance which can be queried using api MLCameraMetadataGetLensInfoHyperfocalDistance.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const float | data | AF distance range [min, max]. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set AF distance range due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully set AF distance range. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set AF distance range due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetLensFocusDistance
MLResult MLCameraMetadataSetLensFocusDistance(
MLHandle request_handle,
const float * data
)
Sets Lens focus distance.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const float * | data | Lens focus distance. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set Lens focus distance due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully set Lens focus distance. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set Lens focus distance due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetControlMode
MLResult MLCameraMetadataSetControlMode(
MLHandle request_handle,
const MLCameraMetadataControlMode * data
)
Sets mode.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const MLCameraMetadataControlMode * | data | Mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetControlSceneMode
MLResult MLCameraMetadataSetControlSceneMode(
MLHandle request_handle,
const MLCameraMetadataControlSceneMode * data
)
Sets Scene mode.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const MLCameraMetadataControlSceneMode * | data | Scene mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set scene mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set scene mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set scene mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetSensorExposureTime
MLResult MLCameraMetadataSetSensorExposureTime(
MLHandle request_handle,
const int64_t * data
)
Sets sensor exposure time.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const int64_t * | data | Duration each pixel is exposed to light in nanoseconds. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set sensor exposure time due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set sensor exposure time. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set sensor exposure time due to an unknown error. |
Required Permissions:
- None
Exposure time provided should be less than frame duration(1/framerate). If the sensor can't expose this exact duration, it will shorten the duration exposed to the nearest possible value.
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetSensorSensitivity
MLResult MLCameraMetadataSetSensorSensitivity(
MLHandle request_handle,
const int32_t * data
)
Sets sensor sensitivity.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const int32_t * | data | Sensor sensitivity. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set sensor sensitivity due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set sensor sensitivity. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set sensor sensitivity due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetPostRawSensitivityBoost
MLResult MLCameraMetadataSetPostRawSensitivityBoost(
MLHandle request_handle,
const int32_t * data
)
Sets post raw sensitivity boost.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const int32_t * | data | Post raw sensitivity boost. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set post raw sensitivity boost due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set post raw sensitivity boost. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set post raw sensitivity boost due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetControlEffectMode
MLResult MLCameraMetadataSetControlEffectMode(
MLHandle request_handle,
const MLCameraMetadataControlEffectMode * data
)
Sets Effect mode.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const MLCameraMetadataControlEffectMode * | data | Effect mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set effect mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set effect mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set effect mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetControlExposureUpperTimeLimit
MLResult MLCameraMetadataSetControlExposureUpperTimeLimit(
MLHandle request_handle,
const int64_t * data
)
Sets exposure time upper limit.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const int64_t * | data | Exposure time upper limit. Null pointer will clear the data. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set exposure time upper limit due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set exposure time upper limit. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set exposure time upperlimit due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetJpegGPSCoordinates
MLResult MLCameraMetadataSetJpegGPSCoordinates(
MLHandle request_handle,
const double data[3]
)
Sets JPEG GPS coordinates.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const double | data | JPEG GPS coordinates – latitude and longitude in degrees, altitude in meters.Null pointer will clear the data. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set JPEG GPS coordinates due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set JPEG GPS coordinates. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set JPEG GPS coordinates due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetJpegGPSTimestamp
MLResult MLCameraMetadataSetJpegGPSTimestamp(
MLHandle request_handle,
const int64_t * data
)
Sets JPEG timestamp.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const int64_t * | data | JPEG timestamp in UNIX Epoch time (UTC in seconds since January 1, 1970). Null pointer will clear the data. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set JPEG timestamp due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set JPEG timestamp. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set JPEG timestamp due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetJpegThumbnailSize
MLResult MLCameraMetadataSetJpegThumbnailSize(
MLHandle request_handle,
const MLCameraMetadataJpegThumbnailSize * data
)
Sets JPEG thumbnail size.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const MLCameraMetadataJpegThumbnailSize * | data | Resolution of embedded JPEG thumbnail. Null pointer will prevent the inclusion of a thumbnail. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set JPEG thumbnail size due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set JPEG thumbnail size. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set JPEG thumbnail size due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetJpegQuality
MLResult MLCameraMetadataSetJpegQuality(
MLHandle request_handle,
const uint8_t * data
)
Sets JPEG quality.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const uint8_t * | data | Compression quality of JPEG thumbnail, with 100 being the highest quality, and 1 the lowest. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set JPEG quality due to an invalid input parameter. |
| MLResult | MLResult_Ok | Set JPEG quality. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set JPEG quality due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataSetControlForceApplyMode
MLResult MLCameraMetadataSetControlForceApplyMode(
MLHandle request_handle,
const MLCameraMetadataControlForceApplyMode * data
)
Sets force apply mode. Main camera and CV Camera share the same camera hardware resources. When both the cameras are streaming, request metadata properties for both cameras are merged and then applied. While merging, the metadata properties from Main Camera take precedence over CV camera metadata properties. The force apply mode property can be used to override this. If CV Camera metadata has force apply mode on, the CV Camera metadata properties take precedence over Main Camera metadata properties.
Parameters
| MLHandle | request_handle | Camera capture request metadata handle acquired from MLCameraPrepareCapture. |
| const MLCameraMetadataControlForceApplyMode * | data | Force apply mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to set force apply mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully set force apply mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to set force apply mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetColorCorrectionModeResultMetadata
MLResult MLCameraMetadataGetColorCorrectionModeResultMetadata(
MLHandle result_handle,
MLCameraMetadataColorCorrectionMode * out_data
)
Gets color correction.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataColorCorrectionMode * | out_data | Color correction mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain color correction due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained color correction. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain color correction due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetColorCorrectionTransformResultMetadata
MLResult MLCameraMetadataGetColorCorrectionTransformResultMetadata(
MLHandle result_handle,
MLCameraMetadataRational out_data[3][3]
)
Gets color correction transform from RGB color space to output linear sRGB.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataRational | out_data | 3x3 color correction transform matrix. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain color correction transform due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained color correction transform. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain color correction transform due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetColorCorrectionAberrationModeResultMetadata
MLResult MLCameraMetadataGetColorCorrectionAberrationModeResultMetadata(
MLHandle result_handle,
MLCameraMetadataColorCorrectionAberrationMode * out_data
)
Gets color correction aberration.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataColorCorrectionAberrationMode * | out_data | Color correction aberration mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain color correction aberration due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained color correction aberration. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain color correction aberration due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetColorCorrectionGainsResultMetadata
MLResult MLCameraMetadataGetColorCorrectionGainsResultMetadata(
MLHandle result_handle,
float out_data[4]
)
Gets color correction gains. The gains in the result metadata are the gains applied by the camera device to the current frame.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| float | out_data | An array of floats for 4 color channel color correction gains. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain color correction gains due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained color correction gains. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain color correction gains due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAEAntibandingModeResultMetadata
MLResult MLCameraMetadataGetControlAEAntibandingModeResultMetadata(
MLHandle result_handle,
MLCameraMetadataControlAEAntibandingMode * out_data
)
Gets AE antibanding mode.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataControlAEAntibandingMode * | out_data | AE antibanding mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE antibanding mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE antibanding mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE antibanding mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAEExposureCompensationResultMetadata
MLResult MLCameraMetadataGetControlAEExposureCompensationResultMetadata(
MLHandle result_handle,
int32_t * out_data
)
Gets AE exposure compensation.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| int32_t * | out_data | AE exposure compensation. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE exposure compensation due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE exposure compensation. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE exposure compensation due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAELockResultMetadata
MLResult MLCameraMetadataGetControlAELockResultMetadata(
MLHandle result_handle,
MLCameraMetadataControlAELock * out_data
)
Gets auto-exposure lock.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataControlAELock * | out_data | AE lock. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE lock due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE lock. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE lock due to an unknown error. |
Required Permissions:
- None
When auto-exposure is locked, the algorithm cannot update its parameters and adjust exposure times and sensitivity.
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAEModeResultMetadata
MLResult MLCameraMetadataGetControlAEModeResultMetadata(
MLHandle result_handle,
MLCameraMetadataControlAEMode * out_data
)
Gets AE mode.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataControlAEMode * | out_data | AE control mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAERegionsResultMetadata
MLResult MLCameraMetadataGetControlAERegionsResultMetadata(
MLHandle result_handle,
int32_t out_data[3][5],
uint32_t * out_count
)
Gets auto-exposure regions.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| int32_t | out_data | Auto-exposure regions. Regions array of area_size x 5[xmin, ymin, xmax, ymax, weight]. Coordinates must be between [(0,0), (width, height)). |
| uint32_t * | out_count | Number of auto-exposure regions. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE regions due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE regions. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE regions due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAETargetFPSRangeResultMetadata
MLResult MLCameraMetadataGetControlAETargetFPSRangeResultMetadata(
MLHandle result_handle,
int32_t out_data[2]
)
Gets auto-exposure target FPS range.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| int32_t | out_data | Target range over which good exposure can be maintained by adjusting the capture frame rate. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE target FPS range due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE target FPS range. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE target FPS range due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAEStateResultMetadata
MLResult MLCameraMetadataGetControlAEStateResultMetadata(
MLHandle result_handle,
MLCameraMetadataControlAEState * out_data
)
Gets AE state.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataControlAEState * | out_data | AE state. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AE state due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AE state. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AE state due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAWBLockResultMetadata
MLResult MLCameraMetadataGetControlAWBLockResultMetadata(
MLHandle result_handle,
MLCameraMetadataControlAWBLock * out_data
)
Gets AWB lock.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataControlAWBLock * | out_data | AWB Lock. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AWB lock due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AWB lock. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AWB lock due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAWBStateResultMetadata
MLResult MLCameraMetadataGetControlAWBStateResultMetadata(
MLHandle result_handle,
MLCameraMetadataControlAWBState * out_data
)
Gets AWB state.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataControlAWBState * | out_data | AWB state. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AWB state due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AWB state. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AWB state due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAWBModeResultMetadata
MLResult MLCameraMetadataGetControlAWBModeResultMetadata(
MLHandle result_handle,
MLCameraMetadataControlAWBMode * out_data
)
Gets AWB mode.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataControlAWBMode * | out_data | AWB mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AWB mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AWB mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AWB mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAFModeResultMetadata
MLResult MLCameraMetadataGetControlAFModeResultMetadata(
MLHandle result_handle,
MLCameraMetadataControlAFMode * out_data
)
Gets AF mode.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataControlAFMode * | out_data | AF mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AF mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AF mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AF mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAFTriggerResultMetadata
MLResult MLCameraMetadataGetControlAFTriggerResultMetadata(
MLHandle result_handle,
MLCameraMetadataControlAFTrigger * out_data
)
Gets AF trigger.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataControlAFTrigger * | out_data | AF trigger. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AF trigger due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AF trigger. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AF trigger due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAFRegionsResultMetadata
MLResult MLCameraMetadataGetControlAFRegionsResultMetadata(
MLHandle result_handle,
int32_t out_data[3][5],
uint32_t * out_count
)
Gets auto-focus regions.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| int32_t | out_data | Auto-focus regions. Regions array of area_size x 5[xmin, ymin, xmax, ymax, weight]. Coordinates must be between [(0,0), (width, height)). |
| uint32_t * | out_count | Number of auto-focus regions. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AF regions due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AF regions. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AF regions due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetAFDistanceRangeResultMetadata
MLResult MLCameraMetadataGetAFDistanceRangeResultMetadata(
MLHandle result_handle,
float out_data[2]
)
Gets AF distance range. Both Min and Max are specified as focus distance in diopters. The min value specifies the lower bound for focus distance used by Autofocus algorithm and should be more than min focus distance which can be queried using MLCameraMetadataGetLensInfoMinimumFocusDistance. The max value specifies the upper bound for focus distance used by Autofocus algorithm and should be less than hyperfocal distance which can be queried using API MLCameraMetadataGetLensInfoHyperfocalDistance.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| float | out_data | AF distance range [min, max]. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AF distance range due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AF distance range. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AF distance range due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAFStateResultMetadata
MLResult MLCameraMetadataGetControlAFStateResultMetadata(
MLHandle result_handle,
MLCameraMetadataControlAFState * out_data
)
Gets AF state.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataControlAFState * | out_data | AF state. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AF state due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AF state. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AF state due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlAFSceneChangeResultMetadata
MLResult MLCameraMetadataGetControlAFSceneChangeResultMetadata(
MLHandle result_handle,
MLCameraMetadataControlAFSceneChange * out_data
)
Gets AF scene change detection status.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataControlAFSceneChange * | out_data | AF scene change detected or not. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain AF scene change detection status due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained AF scene change detection status. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain AF scene change detection status due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetLensFocusDistanceResultMetadata
MLResult MLCameraMetadataGetLensFocusDistanceResultMetadata(
MLHandle result_handle,
float * out_data
)
Gets Lens focus distance.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| float * | out_data | Lens focus distance. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain Lens focus distance range due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained Lens focus distance range. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain Lens focus distance range due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetLensStateResultMetadata
MLResult MLCameraMetadataGetLensStateResultMetadata(
MLHandle result_handle,
MLCameraMetadataLensState * out_data
)
Get Lens state.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataLensState * | out_data | Lens state. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain Lens state due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained Lens state. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain Lens state due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlModeResultMetadata
MLResult MLCameraMetadataGetControlModeResultMetadata(
MLHandle result_handle,
MLCameraMetadataControlMode * out_data
)
Gets mode.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataControlMode * | out_data | Obtained mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlSceneModeResultMetadata
MLResult MLCameraMetadataGetControlSceneModeResultMetadata(
MLHandle result_handle,
MLCameraMetadataControlSceneMode * out_data
)
Gets Scene mode.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataControlSceneMode * | out_data | Scene mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain scene mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained scene mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain scene mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetSensorExposureTimeResultMetadata
MLResult MLCameraMetadataGetSensorExposureTimeResultMetadata(
MLHandle result_handle,
int64_t * out_data
)
Gets sensor exposure time.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| int64_t * | out_data | Duration each pixel is exposed to light in nanoseconds. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain sensor exposure time due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained sensor exposure time. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain sensor exposure time due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetSensorSensitivityResultMetadata
MLResult MLCameraMetadataGetSensorSensitivityResultMetadata(
MLHandle result_handle,
int32_t * out_data
)
Gets sensor sensitivity.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| int32_t * | out_data | Sensor sensitivity. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain sensor sensitivity due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained sensor sensitivity. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain sensor sensitivity due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetPostRawSensitivityBoostResultMetadata
MLResult MLCameraMetadataGetPostRawSensitivityBoostResultMetadata(
MLHandle result_handle,
int32_t * out_data
)
Gets post raw sensitivity boost.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| int32_t * | out_data | Post raw sensitivity boost. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain post raw sensitivity boost due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained post raw sensitivity boost. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain post raw sensitivity boost due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetSensorTimestampResultMetadata
MLResult MLCameraMetadataGetSensorTimestampResultMetadata(
MLHandle result_handle,
int64_t * out_data
)
Gets frame captured timestamp.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| int64_t * | out_data | Timestamp in nanoseconds when captured. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain frame captured timestamp due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained frame captured timestamp. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain frame captured timestamp due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetSensorFrameDurationResultMetadata
MLResult MLCameraMetadataGetSensorFrameDurationResultMetadata(
MLHandle result_handle,
int64_t * out_data
)
Gets sensor frame duration.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| int64_t * | out_data | Sensor frame duration. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain sensor frame duration due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained sensor frame duration. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain sensor frame duration due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlEffectModeResultMetadata
MLResult MLCameraMetadataGetControlEffectModeResultMetadata(
MLHandle result_handle,
MLCameraMetadataControlEffectMode * out_data
)
Gets Effect mode.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataControlEffectMode * | out_data | Effect mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain effect mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained effect mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain effect mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlExposureUpperTimeLimitResultMetadata
MLResult MLCameraMetadataGetControlExposureUpperTimeLimitResultMetadata(
MLHandle result_handle,
int64_t * out_data
)
Gets exposure time upper limit.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| int64_t * | out_data | Exposure time upper limit. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain exposure time upper limit due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained exposure time upper limit. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain exposure time upperlimit due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetJpegGPSCoordinatesResultMetadata
MLResult MLCameraMetadataGetJpegGPSCoordinatesResultMetadata(
MLHandle result_handle,
double out_data[3]
)
Gets JPEG GPS coordinates.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| double | out_data | JPEG GPS coordinates – latitude and longitude in degrees, altitude in meters. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain JPEG GPS coordinates due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained JPEG GPS coordinates. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain JPEG GPS coordinates due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetJpegGPSTimestampResultMetadata
MLResult MLCameraMetadataGetJpegGPSTimestampResultMetadata(
MLHandle result_handle,
int64_t * out_data
)
Gets JPEG timestamp.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| int64_t * | out_data | JPEG timestamp in UNIX Epoch time (UTC in seconds since January 1, 1970). |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain JPEG timestamp due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained JPEG timestamp. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain JPEG timestamp due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetJpegThumbnailSizeResultMetadata
MLResult MLCameraMetadataGetJpegThumbnailSizeResultMetadata(
MLHandle result_handle,
MLCameraMetadataJpegThumbnailSize * out_data
)
Gets JPEG thumbnail size.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataJpegThumbnailSize * | out_data | Resolution of embedded JPEG thumbnail. When set to 0, thumbnail will not be included. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain JPEG thumbnail size due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained JPEG thumbnail size. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain JPEG thumbnail size due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetControlForceApplyModeResultMetadata
MLResult MLCameraMetadataGetControlForceApplyModeResultMetadata(
MLHandle result_handle,
MLCameraMetadataControlForceApplyMode * out_data
)
Gets force apply mode. Main camera and CV Camera share the same camera hardware resources. When both the cameras are streaming, request metadata properties for both cameras are merged and then applied. While merging, the metadata properties from Main Camera take precedence over CV camera metadata properties. The force apply mode property can be used to override this. If CV Camera metadata has force apply mode on, the CV Camera metadata properties take precedence over Main Camera metadata properties.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| MLCameraMetadataControlForceApplyMode * | out_data | Force apply mode. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain force apply mode due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained force apply mode. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain force apply mode due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20
MLCameraMetadataGetJpegQualityResultMetadata
MLResult MLCameraMetadataGetJpegQualityResultMetadata(
MLHandle result_handle,
uint8_t * out_data
)
Gets JPEG quality.
Parameters
| MLHandle | result_handle | Camera capture result metadata handle returned in MLCameraCaptureCallbacks. |
| uint8_t * | out_data | Compression quality of JPEG thumbnail, with 100 being the highest quality, and 1 the lowest. |
Returns
| MLResult | MLResult_InvalidParam | Failed to obtain JPEG quality due to an invalid input parameter. |
| MLResult | MLResult_Ok | Successfully obtained JPEG quality. |
| MLResult | MLResult_UnspecifiedFailure | Failed to obtain JPEG quality due to an unknown error. |
Required Permissions:
- None
Deprecated since 1.4.0. Scheduled for removal.
API Level:
- 20