Metadata

MLCameraMetadata Summary placeholder. More...

Detailed Description

public class Metadata; 

Details*

MLCameraMetadata description goes here.

---

Public Fields

Handle

public ulong Handle { get; set; }

---

Public Methods

MLResult GetColorCorrectionAberrationModeRequestMetadata

Gets color correction aberration.

public MLResult GetColorCorrectionAberrationModeRequestMetadata(
    out ColorCorrectionAberrationMode OutData
)

Parameters

Type	Name	Description
out ColorCorrectionAberrationMode	OutData

---

MLResult GetColorCorrectionAberrationModeResultMetadata

Gets color correction aberration.

public MLResult GetColorCorrectionAberrationModeResultMetadata(
    out ColorCorrectionAberrationMode OutData
)

Parameters

Type	Name	Description
out ColorCorrectionAberrationMode	OutData

---

MLResult GetColorCorrectionAvailableAberrationModes

Gets color correction aberration modes.

public MLResult GetColorCorrectionAvailableAberrationModes(
    out ColorCorrectionAberrationMode [] OutData
)

Parameters

Type	Name	Description
out ColorCorrectionAberrationMode []	OutData

---

MLResult GetColorCorrectionGainsRequestMetadata

Gets color correction gains.

public MLResult GetColorCorrectionGainsRequestMetadata(
    out float [] OutData
)

Parameters

Type	Name	Description
out float []	OutData

---

MLResult GetColorCorrectionGainsResultMetadata

Gets color correction gains.

public MLResult GetColorCorrectionGainsResultMetadata(
    out float [] OutData
)

Parameters

Type	Name	Description
out float []	OutData

---

MLResult GetColorCorrectionModeRequestMetadata

Gets color correction mode.

public MLResult GetColorCorrectionModeRequestMetadata(
    out ColorCorrectionMode OutData
)

Parameters

Type	Name	Description
out ColorCorrectionMode	OutData

---

MLResult GetColorCorrectionModeResultMetadata

Gets color correction.

public MLResult GetColorCorrectionModeResultMetadata(
    out ColorCorrectionMode OutData
)

Parameters

Type	Name	Description
out ColorCorrectionMode	OutData

---

MLResult GetColorCorrectionTransformRequestMetadata

Gets color correction transform.

public MLResult GetColorCorrectionTransformRequestMetadata(
    out Rational OutData[][]
)

Parameters

Type	Name	Description
out Rational	OutData[][]	Rational data type.

---

MLResult GetColorCorrectionTransformResultMetadata

Gets color correction transform.

public MLResult GetColorCorrectionTransformResultMetadata(
    out Rational OutData[][]
)

Parameters

Type	Name	Description
out Rational	OutData[][]	Rational data type.

---

MLResult GetControlAEAntibandingModeRequestMetadata

Gets AE antibanding mode.

public MLResult GetControlAEAntibandingModeRequestMetadata(
    out ControlAEAntibandingMode OutData
)

Parameters

Type	Name	Description
out ControlAEAntibandingMode	OutData

---

MLResult GetControlAEAntibandingModeResultMetadata

Gets AE antibanding mode.

public MLResult GetControlAEAntibandingModeResultMetadata(
    out ControlAEAntibandingMode OutData
)

Parameters

Type	Name	Description
out ControlAEAntibandingMode	OutData

---

MLResult GetControlAEAvailableModes

Gets AE modes.

public MLResult GetControlAEAvailableModes(
    out ControlAEMode [] OutData
)

Parameters

Type	Name	Description
out ControlAEMode []	OutData

---

MLResult GetControlAECompensationRange

Gets AE compensation range.

public MLResult GetControlAECompensationRange(
    out int [] OutData
)

Parameters

Type	Name	Description
out int []	OutData

---

MLResult GetControlAECompensationStep

Gets AE compensation step.

public MLResult GetControlAECompensationStep(
    out Rational OutData
)

Parameters

Type	Name	Description
out Rational	OutData	Rational data type.

---

MLResult GetControlAEExposureCompensationRequestMetadata

Gets AE exposure compensation.

public MLResult GetControlAEExposureCompensationRequestMetadata(
    out int OutData
)

Parameters

Type	Name	Description
out int	OutData

---

MLResult GetControlAEExposureCompensationResultMetadata

Gets AE exposure compensation.

public MLResult GetControlAEExposureCompensationResultMetadata(
    out int OutData
)

Parameters

Type	Name	Description
out int	OutData

---

MLResult GetControlAELockAvailable

Gets AE lock.

public MLResult GetControlAELockAvailable(
    out ControlAELock OutData
)

Parameters

Type	Name	Description
out ControlAELock	OutData

---

MLResult GetControlAELockRequestMetadata

Gets AE lock.

public MLResult GetControlAELockRequestMetadata(
    out ControlAELock OutData
)

Parameters

Type	Name	Description
out ControlAELock	OutData

---

MLResult GetControlAELockResultMetadata

Gets AE lock.

public MLResult GetControlAELockResultMetadata(
    out ControlAELock OutData
)

Parameters

Type	Name	Description
out ControlAELock	OutData

---

MLResult GetControlAEMaxRegions

Gets AE Max Regions.

public MLResult GetControlAEMaxRegions(
    out int OutData
)

Parameters

Type	Name	Description
out int	OutData

---

MLResult GetControlAEModeRequestMetadata

Gets AE mode.

public MLResult GetControlAEModeRequestMetadata(
    out ControlAEMode OutData
)

Parameters

Type	Name	Description
out ControlAEMode	OutData

---

MLResult GetControlAEModeResultMetadata

Gets AE mode.

public MLResult GetControlAEModeResultMetadata(
    out ControlAEMode OutData
)

Parameters

Type	Name	Description
out ControlAEMode	OutData

---

MLResult GetControlAERegionsRequestMetadata

Gets AE regions.

public MLResult GetControlAERegionsRequestMetadata(
    out int OutData[][]
)

Parameters

Type	Name	Description
out int	OutData[][]

---

MLResult GetControlAERegionsResultMetadata

Gets AE regions.

public MLResult GetControlAERegionsResultMetadata(
    out int OutData[][]
)

Parameters

Type	Name	Description
out int	OutData[][]

---

MLResult GetControlAEStateResultMetadata

Gets AE state.

public MLResult GetControlAEStateResultMetadata(
    out ControlAEState OutData
)

Parameters

Type	Name	Description
out ControlAEState	OutData

---

MLResult GetControlAETargetFPSRangeResultMetadata

Gets AE target FPS range.

public MLResult GetControlAETargetFPSRangeResultMetadata(
    out int [] OutData
)

Parameters

Type	Name	Description
out int []	OutData

---

MLResult GetControlAFAvailableModes

Gets AF modes

public MLResult GetControlAFAvailableModes(
    out ControlAFMode [] OutData
)

Parameters

Type	Name	Description
out ControlAFMode []	OutData	API mode

Returns: MLResult.Code.InvalidParam: Failed to obtain result due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to obtain result due to an unknown error.

---

MLResult GetControlAFDistanceRangeRequestMetadata

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 GetLensInfoMinimumFocusDistance. 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 GetLensInfoHyperfocalDistance.

public MLResult GetControlAFDistanceRangeRequestMetadata(
    out float Min,
    out float Max
)

Parameters

Type	Name	Description
out float	Min	Min AF distance
out float	Max	Max AF distance

Returns: MLResult.Code.InvalidParam: Failed to obtain result due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to obtain result due to an unknown error.

---

MLResult GetControlAFDistanceRangeResultMetadata

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 GetLensInfoMinimumFocusDistance. 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 GetLensInfoHyperfocalDistance.

public MLResult GetControlAFDistanceRangeResultMetadata(
    out float Min,
    out float Max
)

Parameters

Type	Name	Description
out float	Min	Min AF distance
out float	Max	Max AF distance

Returns: MLResult.Code.InvalidParam: Failed to obtain result due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to obtain result due to an unknown error.

---

MLResult GetControlAFModeRequestMetadata

Gets AF mode

public MLResult GetControlAFModeRequestMetadata(
    out ControlAFMode OutData
)

Parameters

Type	Name	Description
out ControlAFMode	OutData	AF Mode

Returns: MLResult.Code.InvalidParam: Failed to obtain result due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to obtain result due to an unknown error.

---

MLResult GetControlAFModeResultMetadata

Gets AF mode

public MLResult GetControlAFModeResultMetadata(
    out ControlAFMode Data
)

Parameters

Type	Name	Description
out ControlAFMode	Data	AF mode

Returns: MLResult.Code.InvalidParam: Failed to obtain result due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to obtain result due to an unknown error.

---

MLResult GetControlAFSceneChangeResultMetadata

Gets AF scene change detection status

public MLResult GetControlAFSceneChangeResultMetadata(
    out ControlAFSceneChange Data
)

Parameters

Type	Name	Description
out ControlAFSceneChange	OutData	AF scene change detected or not

Returns: MLResult.Code.InvalidParam: Failed to obtain result due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to obtain result due to an unknown error.

---

MLResult GetControlAFStateResultMetadata

Gets AF state

public MLResult GetControlAFStateResultMetadata(
    out ControlAFState Data
)

Parameters

Type	Name	Description
out ControlAFState	Data	AF state

Returns: MLResult.Code.InvalidParam: Failed to obtain result due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to obtain result due to an unknown error.

---

MLResult GetControlAFTriggerRequestMetadata

Gets AF trigger

public MLResult GetControlAFTriggerRequestMetadata(
    out ControlAFTrigger OutData
)

Parameters

Type	Name	Description
out ControlAFTrigger	OutData	AF trigger

Returns: MLResult.Code.InvalidParam: Failed to obtain result due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to obtain result due to an unknown error.

---

MLResult GetControlAFTriggerResultMetadata

Gets AF trigger

public MLResult GetControlAFTriggerResultMetadata(
    out ControlAFTrigger Data
)

Parameters

Type	Name	Description
out ControlAFTrigger	OutData	AF trigger

Returns: MLResult.Code.InvalidParam: Failed to obtain result due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to obtain result due to an unknown error.

---

MLResult GetControlAWBAvailableModes

Gets AWB modes.

public MLResult GetControlAWBAvailableModes(
    out ControlAWBMode [] OutData
)

Parameters

Type	Name	Description
out ControlAWBMode []	OutData

---

MLResult GetControlAWBLockAvailable

Gets AWB lock.

public MLResult GetControlAWBLockAvailable(
    out ControlAWBLock OutData
)

Parameters

Type	Name	Description
out ControlAWBLock	OutData

---

MLResult GetControlAWBLockRequestMetadata

Gets AWB lock.

public MLResult GetControlAWBLockRequestMetadata(
    out ControlAWBLock OutData
)

Parameters

Type	Name	Description
out ControlAWBLock	OutData

---

MLResult GetControlAWBLockResultMetadata

Gets AWB lock.

public MLResult GetControlAWBLockResultMetadata(
    out ControlAWBLock OutData
)

Parameters

Type	Name	Description
out ControlAWBLock	OutData

---

MLResult GetControlAWBModeRequestMetadata

Gets AWB mode.

public MLResult GetControlAWBModeRequestMetadata(
    out ControlAWBMode OutData
)

Parameters

Type	Name	Description
out ControlAWBMode	OutData

---

MLResult GetControlAWBModeResultMetadata

Gets AWB mode.

public MLResult GetControlAWBModeResultMetadata(
    out ControlAWBMode OutData
)

Parameters

Type	Name	Description
out ControlAWBMode	OutData

---

MLResult GetControlAWBStateResultMetadata

Gets AWB state.

public MLResult GetControlAWBStateResultMetadata(
    out ControlAWBState OutData
)

Parameters

Type	Name	Description
out ControlAWBState	OutData

---

MLResult GetControlAvailableEffectModes

Gets Effect modes.

public MLResult GetControlAvailableEffectModes(
    out ControlEffectMode [] OutData
)

Parameters

Type	Name	Description
out ControlEffectMode []	OutData

---

MLResult GetControlAvailableModes

Gets Available Modes.

public MLResult GetControlAvailableModes(
    out ControlMode [] OutData
)

Parameters

Type	Name	Description
out ControlMode []	OutData

---

MLResult GetControlAvailableSceneModes

Gets Scene modes.

public MLResult GetControlAvailableSceneModes(
    out ControlSceneMode [] OutData
)

Parameters

Type	Name	Description
out ControlSceneMode []	OutData

---

MLResult GetControlEffectModeRequestMetadata

Effect mode.

public MLResult GetControlEffectModeRequestMetadata(
    out ControlEffectMode OutData
)

Parameters

Type	Name	Description
out ControlEffectMode	OutData

---

MLResult GetControlEffectModeResultMetadata

Gets Effect mode.

public MLResult GetControlEffectModeResultMetadata(
    out ControlEffectMode OutData
)

Parameters

Type	Name	Description
out ControlEffectMode	OutData

---

MLResult GetControlExposureUpperTimeLimitRequestMetadata

Gets exposure time upper limit.

public MLResult GetControlExposureUpperTimeLimitRequestMetadata(
    out long OutData
)

Parameters

Type	Name	Description
out long	OutData

---

MLResult GetControlExposureUpperTimeLimitResultMetadata

Gets exposure time upper limit.

public MLResult GetControlExposureUpperTimeLimitResultMetadata(
    out long OutData
)

Parameters

Type	Name	Description
out long	OutData

---

MLResult GetControlForceApplyModeRequestMetadata

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.

public MLResult GetControlForceApplyModeRequestMetadata(
    out ControlForceApplyMode OutData
)

Parameters

Type	Name	Description
out ControlForceApplyMode	OutData

---

MLResult GetControlForceApplyModeResultMetadata

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.

public MLResult GetControlForceApplyModeResultMetadata(
    out ControlForceApplyMode OutData
)

Parameters

Type	Name	Description
out ControlForceApplyMode	OutData

---

MLResult GetControlModeRequestMetadata

Gets mode.

public MLResult GetControlModeRequestMetadata(
    out ControlMode OutData
)

Parameters

Type	Name	Description
out ControlMode	OutData

---

MLResult GetControlModeResultMetadata

Gets mode.

public MLResult GetControlModeResultMetadata(
    out ControlMode OutData
)

Parameters

Type	Name	Description
out ControlMode	OutData

---

MLResult GetControlSceneModeRequestMetadata

Gets Scene mode.

public MLResult GetControlSceneModeRequestMetadata(
    out ControlSceneMode OutData
)

Parameters

Type	Name	Description
out ControlSceneMode	OutData

---

MLResult GetControlSceneModeResultMetadata

Gets Scene mode.

public MLResult GetControlSceneModeResultMetadata(
    out ControlSceneMode OutData
)

Parameters

Type	Name	Description
out ControlSceneMode	OutData

---

MLResult GetJpegGPSCoordinatesRequestMetadata

Gets jpeg GPS coordinates.

public MLResult GetJpegGPSCoordinatesRequestMetadata(
    out double [] OutData
)

Parameters

Type	Name	Description
out double []	OutData

---

MLResult GetJpegGPSCoordinatesResultMetadata

Gets jpeg GPS coordinates.

public MLResult GetJpegGPSCoordinatesResultMetadata(
    out double [] OutData
)

Parameters

Type	Name	Description
out double []	OutData

---

MLResult GetJpegGPSTimestampRequestMetadata

Gets jpeg timestamp.

public MLResult GetJpegGPSTimestampRequestMetadata(
    out long OutData
)

Parameters

Type	Name	Description
out long	OutData

---

MLResult GetJpegGPSTimestampResultMetadata

Gets jpeg timestamp.

public MLResult GetJpegGPSTimestampResultMetadata(
    out long OutData
)

Parameters

Type	Name	Description
out long	OutData

---

MLResult GetJpegQualityRequestMetadata

Gets jpeg quality.

public MLResult GetJpegQualityRequestMetadata(
    out byte OutData
)

Parameters

Type	Name	Description
out byte	OutData

---

MLResult GetJpegQualityResultMetadata

Gets jpeg quality.

public MLResult GetJpegQualityResultMetadata(
    out byte OutData
)

Parameters

Type	Name	Description
out byte	OutData

---

MLResult GetJpegThumbnailSizeRequestMetadata

Gets jpeg thumbnail size.

public MLResult GetJpegThumbnailSizeRequestMetadata(
    out JpegThumbnailSize OutData
)

Parameters

Type	Name	Description
out JpegThumbnailSize	OutData

---

MLResult GetJpegThumbnailSizeResultMetadata

Gets jpeg thumbnail size.

public MLResult GetJpegThumbnailSizeResultMetadata(
    out JpegThumbnailSize OutData
)

Parameters

Type	Name	Description
out JpegThumbnailSize	OutData

---

MLResult GetLensFocusDistanceRequestMetadata

Gets Lens focus distance in diopters. The distance is between minimum focus distance and hyperfocal distance.

public MLResult GetLensFocusDistanceRequestMetadata(
    out float OutData
)

Parameters

Type	Name	Description
out float	OutData

Returns: MLResult.Code.InvalidParam: Failed to obtain result due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to obtain result due to an unknown error.

---

MLResult GetLensFocusDistanceResultMetadata

Gets Lens focus distance

public MLResult GetLensFocusDistanceResultMetadata(
    out float Data
)

Parameters

Type	Name	Description
out float	Data	Lens focus distance

Returns: MLResult.Code.InvalidParam: Failed to obtain result due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to obtain result due to an unknown error.

---

MLResult GetLensInfoHyperfocalDistance

Gets lens hyperfocal distance in diopters

public MLResult GetLensInfoHyperfocalDistance(
    out float OutData
)

Parameters

Type	Name	Description
out float	OutData	Lens hyperfocal distance in diopters

Returns: MLResult.Code.InvalidParam: Failed to obtain result due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to obtain result due to an unknown error.

---

MLResult GetLensInfoMinimumFocusDistance

Gets lens minimum focus distance in diopters

public MLResult GetLensInfoMinimumFocusDistance(
    out float OutData
)

Parameters

Type	Name	Description
out float	OutData	Lens minimum focus distance in diopters

Returns: MLResult.Code.InvalidParam: Failed to obtain result due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to obtain result due to an unknown error.

---

MLResult GetLensInfoMinimumFocusDistanceIncrement

Gets lens minimum focus distance increment. The lens position can be set in multiples of distance increments between hyperfocal distance and minimum focus distance.

public MLResult GetLensInfoMinimumFocusDistanceIncrement(
    out float OutData
)

Parameters

Type	Name	Description
out float	OutData	Minimum focus distance increment in diopters

Returns: MLResult.Code.InvalidParam: Failed to obtain result due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to obtain result due to an unknown error.

---

MLResult GetLensStateResultMetadata

Get Lens state

public MLResult GetLensStateResultMetadata(
    out LensState Data
)

Parameters

Type	Name	Description
out LensState	Data	Lens state

Returns: MLResult.Code.InvalidParam: Failed to obtain result due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to obtain result due to an unknown error.

---

MLResult GetSensorExposureTimeRequestMetadata

Gets sensor exposure time.

public MLResult GetSensorExposureTimeRequestMetadata(
    out long OutData
)

Parameters

Type	Name	Description
out long	OutData

---

MLResult GetSensorExposureTimeResultMetadata

Gets sensor exposure time.

public MLResult GetSensorExposureTimeResultMetadata(
    out long OutData
)

Parameters

Type	Name	Description
out long	OutData

---

MLResult GetSensorFrameDurationResultMetadata

Gets sensor frame duration.

public MLResult GetSensorFrameDurationResultMetadata(
    out long OutData
)

Parameters

Type	Name	Description
out long	OutData

---

MLResult GetSensorInfoActiveArraySize

Gets sensor info active array sizes.

public MLResult GetSensorInfoActiveArraySize(
    out int [] OutData
)

Parameters

Type	Name	Description
out int []	OutData

---

MLResult GetSensorInfoSensitivityRange

Gets sensor info sensitivity range.

public MLResult GetSensorInfoSensitivityRange(
    out int [] OutData
)

Parameters

Type	Name	Description
out int []	OutData

---

MLResult GetSensorOrientation

Gets sensor orientation degree.

public MLResult GetSensorOrientation(
    out int OutData
)

Parameters

Type	Name	Description
out int	OutData

---

MLResult GetSensorSensitivityRequestMetadata

Gets sensor sensitivity.

public MLResult GetSensorSensitivityRequestMetadata(
    out int OutData
)

Parameters

Type	Name	Description
out int	OutData

---

MLResult GetSensorSensitivityResultMetadata

Gets sensor sensitivity.

public MLResult GetSensorSensitivityResultMetadata(
    out int OutData
)

Parameters

Type	Name	Description
out int	OutData

---

MLResult GetSensorTimestampResultMetadata

Gets frame captured timestamp.

public MLResult GetSensorTimestampResultMetadata(
    out long OutData
)

Parameters

Type	Name	Description
out long	OutData

---

MLResult SetColorCorrectionAberrationMode

Sets color correction aberration.

public MLResult SetColorCorrectionAberrationMode(
    ColorCorrectionAberrationMode Data
)

Parameters

Type	Name	Description
ColorCorrectionAberrationMode	Data

---

MLResult SetColorCorrectionGains

Sets color correction gains.

public MLResult SetColorCorrectionGains(
    float [] Data
)

Parameters

Type	Name	Description
float []	Data

---

MLResult SetColorCorrectionMode

Sets color correction mode.

public MLResult SetColorCorrectionMode(
    ColorCorrectionMode Data
)

Parameters

Type	Name	Description
ColorCorrectionMode	Data

---

MLResult SetColorCorrectionTransform

Sets color correction transform.

public MLResult SetColorCorrectionTransform(
    Rational Data[][]
)

Parameters

Type	Name	Description
Rational	Data[][]	Rational data type.

---

MLResult SetControlAEAntibandingMode

Sets AE antiband mode.

public MLResult SetControlAEAntibandingMode(
    ControlAEAntibandingMode Data
)

Parameters

Type	Name	Description
ControlAEAntibandingMode	Data

---

MLResult SetControlAEExposureCompensation

Sets AE exposure compensation.

public MLResult SetControlAEExposureCompensation(
    int Data
)

Parameters

Type	Name	Description
int	Data

---

MLResult SetControlAELock

Sets AE lock.

public MLResult SetControlAELock(
    ControlAELock Data
)

Parameters

Type	Name	Description
ControlAELock	Data

---

MLResult SetControlAEMode

Sets AE mode. ControlAEMode_Off is not supported if camera is configured for 15FPS

public MLResult SetControlAEMode(
    ControlAEMode Data
)

Parameters

Type	Name	Description
ControlAEMode	Data

---

MLResult SetControlAERegions

set AE regions.

public MLResult SetControlAERegions(
    int Data[][]
)

Parameters

Type	Name	Description
int	Data[][]

---

MLResult SetControlAFDistanceRange

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 GetLensInfoMinimumFocusDistance. 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 GetLensInfoHyperfocalDistance.

public MLResult SetControlAFDistanceRange(
    float Min,
    float Max
)

Parameters

Type	Name	Description
float	Min	Min AF distance
float	Max	Max AF distance

Returns: MLResult.Code.InvalidParam: Failed to set value due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to set value due to an unknown error.

---

MLResult SetControlAFMode

Sets AF mode

public MLResult SetControlAFMode(
    ControlAFMode Mode
)

Parameters

Type	Name	Description
ControlAFMode	Mode	AF mode

Returns: MLResult.Code.InvalidParam: Failed to set value due to an invalid input parameter. MLResult.Code.Ok: Successfully set value MLResult.Code.UnspecifiedFailure: Failed to set value due to an unknown error.

---

MLResult SetControlAFTrigger

Sets AF trigger

public MLResult SetControlAFTrigger(
    ControlAFTrigger Trigger
)

Parameters

Type	Name	Description
ControlAFTrigger	Trigger	AF trigger

Returns: MLResult.Code.InvalidParam: Failed to set value due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to set value due to an unknown error.

---

MLResult SetControlAWBLock

Sets AWB lock.

public MLResult SetControlAWBLock(
    ControlAWBLock Data
)

Parameters

Type	Name	Description
ControlAWBLock	Data

---

MLResult SetControlAWBMode

Sets AWB mode.

public MLResult SetControlAWBMode(
    ControlAWBMode Data
)

Parameters

Type	Name	Description
ControlAWBMode	Data

---

MLResult SetControlEffectMode

Sets Effect mode.

public MLResult SetControlEffectMode(
    ControlEffectMode Data
)

Parameters

Type	Name	Description
ControlEffectMode	Data

---

MLResult SetControlExposureUpperTimeLimit

Sets exposure time upper limit.

public MLResult SetControlExposureUpperTimeLimit(
    long Data
)

Parameters

Type	Name	Description
long	Data

---

MLResult SetControlForceApplyMode

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.

public MLResult SetControlForceApplyMode(
    ControlForceApplyMode Data
)

Parameters

Type	Name	Description
ControlForceApplyMode	Data

---

MLResult SetControlMode

Sets mode.

public MLResult SetControlMode(
    ControlMode Data
)

Parameters

Type	Name	Description
ControlMode	Data

---

MLResult SetControlSceneMode

Sets Scene mode.

public MLResult SetControlSceneMode(
    ControlSceneMode Data
)

Parameters

Type	Name	Description
ControlSceneMode	Data

---

MLResult SetJpegGPSCoordinates

Sets jpeg GPS coordinates.

public MLResult SetJpegGPSCoordinates(
    double [] Data
)

Parameters

Type	Name	Description
double []	Data

---

MLResult SetJpegGPSTimestamp

Sets jpeg timestamp.

public MLResult SetJpegGPSTimestamp(
    long Data
)

Parameters

Type	Name	Description
long	Data

---

MLResult SetJpegQuality

Sets jpeg quality.

public MLResult SetJpegQuality(
    byte Data
)

Parameters

Type	Name	Description
byte	Data

---

MLResult SetJpegThumbnailSize

Sets jpeg thumbnail size.

public MLResult SetJpegThumbnailSize(
    JpegThumbnailSize Data
)

Parameters

Type	Name	Description
JpegThumbnailSize	Data

---

MLResult SetLensFocusDistance

Sets Lens focus distance

public MLResult SetLensFocusDistance(
    float Distance
)

Parameters

Type	Name	Description
float	OutData	API result

Returns: MLResult.Code.InvalidParam: Failed to set value due to an invalid input parameter. MLResult.Code.Ok: Successfully obtained result MLResult.Code.UnspecifiedFailure: Failed to set value due to an unknown error.

---

MLResult SetSensorExposureTime

Sets sensor exposure time.

public MLResult SetSensorExposureTime(
    long Data
)

Parameters

Type	Name	Description
long	Data

---

MLResult SetSensorSensitivity

Sets sensor sensitivity.

public MLResult SetSensorSensitivity(
    int Data
)

Parameters

Type	Name	Description
int	Data

---

Public Enums

ColorCorrectionAberrationMode

Enumerator	Value	Description
Off	0	Off.
Fast		Fast.
HighQuality		High Quality.

Details*

Color correction aberration mode.

---

ColorCorrectionMode

Enumerator	Value	Description
TransformMatrix	0	Transform Matrix.
Fast		Fast.
HighQuality		High Quality.

---

ControlAEAntibandingMode

Enumerator	Value	Description
Off	0	Off.
Mode_50Hz		50Hz.
Mode_60Hz		60Hz.
Auto		Auto.

Details*

Control AE anti-banding mode.

---

ControlAELock

Enumerator	Value	Description
Off	0	Off.
On		On.

Details*

Control AE lock.

---

ControlAEMode

Enumerator	Value	Description
Off	0	Off.
On		On.

Details*

Control AE mode.

---

ControlAEState

Enumerator	Value	Description
Inactive	0	Inactive.
Searching		Searching.
Converged		Converged.
Locked		Locked.
FlashRequired		Flash required.
PreCapture		Pre-capture.

Details*

Control AE state.

---

ControlAFMode

The current auto-focus (AF) mode controls.

Enumerator	Value	Description
Off	0	Disables the camera device's auto-focus routine.
Auto		Sets the camera device's auto-focus routine to automatic.
Macro		Sets the camera device's auto-focus routine to close-up focusing mode.
ContinuousVideo		Sets the camera device's auto-focus routine to Continuous Video Mode. The focusing behavior should be suitable for good quality video recording.
ContinuousPicture		Sets the camera device's auto-focus routine to Continuous Picture Mode. The focusing behavior should be suitable for still image capture.

---

ControlAFSceneChange

Whether a significant scene change is detected by AF algorithm.

Enumerator	Value	Description
NotDetected	0	No scene change detected by AF.
Detected		Scene change detected by AF.

---

ControlAFState

Current state of auto-focus (AF) routine.

Enumerator	Value	Description
Inactive	0	AF is off or has not yet tried to scan.
PassiveScan		AF is currently performing an AF scan initiated by the camera device in a continuous autofocus mode.
PassiveFocused		AF currently is in focus, but may restart scanning at any time
ActiveScan		AF is performing an AF scan triggered by AF trigger
FocusedLocked		AF is focused correctly and has locked focus.
NotFocusedLocked		AF has failed to focus successfully and has locked focus.
PassiveUnFocused		AF finished a passive scan without finding focus,and may restart scanning at any time.

---

ControlAFTrigger

The current auto-focus (AF) trigger.

Enumerator	Value	Description
Idle	0	AF trigger is idle.
Start		AF will trigger now.
Cancel		Cancel any currently active AF trigger.

---

ControlAWBLock

Enumerator	Value	Description
Off	0	Off.
On		On.

Details*

Control AWB lock.

---

ControlAWBMode

Enumerator	Value	Description
Off	0	Off.
Auto		Auto.
Incandescent		Incandescent.
Fluorescent		Fluorescent.
WarmFluorescent		Warm fluorescent.
Daylight		Daylight.
CloudyDaylight		Cloudy daylight.
Twilight		Twilight.
Shade		Shade.

Details*

Control AWB mode.

---

ControlAWBState

Enumerator	Value	Description
Inactive	0	Inactive.
Searching		Searching.
Converged		Converged.
Locked		Locked.

Details*

Control AWB state.

---

ControlEffectMode

Enumerator	Value	Description
Off	0	Off.
Grayscale		GrayScale.
Negative		Negative.
Sepia		Sepia.
ColorSelection		ColorSelection.
Sharpening		Sharpening.
Emboss		Emboss.
Sketch		Sketch.

Details*

Effect mode.

---

ControlForceApplyMode

Enumerator	Value	Description
Off	0	Off.
On	1	On.

Details*

Force Apply Metadata Settings.

---

ControlMode

Enumerator	Value	Description
Off	0	Off.
Auto		Auto.
UseSceneMode		Use Scene Mode
OffKeepState		no update of 2A state

Details*

Control mode.

---

ControlSceneMode

Enumerator	Value	Description
Action	2	Action.
Portrait	3	Portrait.
Landscape	4	Landscape.
Theatre	7	Theatre.
Sports	13	Sports.
Party	14	Party.
CandleLight	15	CandleLight.
Barcode	16	Barcode.
Medical	100	Medical.

Details*

Scene mode.

---

JpegThumbnailSize

Enumerator	Value	Description
Size_160x120	1	160x120.
Size_240x135	2	240x135.
Size_256x135	3	256x135.

Details*

Jpeg Thumbnail Size.

---

LensState

Current Lens status.

Enumerator	Value	Description
Stationary	0	Lens focal length is not changing.
Moving		Lens focal length is changing.

---

ScalerAvailableFormats

Enumerator	Value	Description
RAW16	0x20	Raw16.
RAW_OPAQUE	0x24	Raw opaque.
YV12	0x32315659	TV12.
YCrCb_420_SP	0x11	YCrCb 420 SP.
IMPLEMENTATION_DEFINED	0x22	Implementation defined.
YCbCr_420_888	0x23	YCrCb 420 888.
BLOB	0x21	BLOB.

Details*

Scaler available formats.

---

ScalerAvailableStreamConfigurations

Enumerator	Value	Description
OUTPUT	0	Output.
INPUT		Input.

Details*

Scaler available stream configuration.

---