Resource Base
Table of contents

iOS CameraEnhancer Class

CameraEnhancer is the class that provides multifunctional APIs on frame preprocessing and camera controlling.

Initialization Methods

Method Description
initLicenseFromDLS Initialize the Camera Enhancer from the license server with a license.

Frame preprocessing methods

Method Description
acquireListFrame Get the latest frame from the frame queue when this API is activated.
enableFastMode Set the value true/false to turn on/off DCE fast mode
enableSensorControl Set true/false to turn on/off DCE sensor control.
setSensorControlThreshold Make settings on sensor control threshold
enableFrameFilter Set true/false to turn on/off DCE frame filter.
setMaxFrameRate Set max frame rate

Regular camera methods

Method Description
updateCameraSettingFromJson Update camera filter and focus settings from Json
updateCameraSettingFromFile Update camera filter and focus settings from file
getVersion Check current DCE version
getCameraCurrentState Get camera current state
getCameraDesiredState Get camera desired state
setCameraDesiredState Set Camera on/off
pauseCamera Pause Camera
resumeCamera Resume Camera
startScanning Start scanning
stopScanning Stop scanning
addCameraListener Add camera listener (on preview original, filtered or fast frames)
getTorchCurrentState Get torch current state
getTorchDesiredState Get torch desired state
setTorchDesiredState Set torch state
addTorchListener Add torch listener
getCameraPosition Get current camera position
switchCameraPosition Switch camera position front/back
getResolution Get current resolution setting
setResolution Set resolution
getResolutionList Get all available resolutions

Focus & zoom methods

Method Description
setAutoFocusPosition Set auto focus position (Change the default auto focus position).
setManualFocusPosition Set manual focus position (This focus position only takes effect once for each time the API is called).
setFocalLength Set focal length between 0 to 10 to enable fixed focal length mode. In fixed focal length mode, all focus parameters can’t be changed until this mode is quit. To quit fixed focal length mode, please set focal length equals to -1.
enableDCEAutoFocus Set true/false to turn on/off DCE auto focus.
enableDefaultAutoFocus Set true/false to turn on/off default auto focus.
enableRegularAutoFocus If this is true, camera will auto focus for every 3 seconds.
setRegularAutoFocusParam Set the focus interval and termination time for the regular autofocus.
enableAutoFocusOnSharpnessChange If this is enabled, camera will autofocus when clarity change is detected.
enableAutoZoom Set enableAutoZoom value true to enable auto zoom mode.
setZoomFactor Set zoom factor

This page is compatible for:

Version 1.0

Is this page helpful?

YesYes NoNo

In this article:

version 1.0.3

  • Latest version
  • Version 4.x
    • Version 4.0.2
    • Version 4.0.1
    • Version 4.0.0
  • Version 3.x
    • Version 3.0.3
    • Version 3.0.2
    • Version 3.0.1
    • Version 3.0.0
  • Version 2.x
    • Version 2.3.21
    • Version 2.3.20
    • Version 2.3.12
    • Version 2.3.11
    • Version 2.3.10
    • Version 2.3.5
    • Version 2.3.4
    • Version 2.3.3
    • Version 2.3.2
    • Version 2.3.1
    • Version 2.3.0
    • Version 2.1.4
    • Version 2.1.3
    • Version 2.1.1
    • Version 2.0.0
Change +