Skip to content

Latest commit

 

History

History
92 lines (74 loc) · 6.18 KB

api-reference-v2.1.4.md

File metadata and controls

92 lines (74 loc) · 6.18 KB
Raw
layout title description keywords needAutoGenerateSidebar noTitleIndex needGenerateH3Content breadcrumbText permalink
default-layout
iOS API references - Dynamsoft Camera Enhancer
This is the documentation - iOS API references page of Dynamsoft Camera Enhancer.
Camera Enhancer, iOS API references
true
true
true
iOS API references
/programming/ios/api-reference-v2.1.4.html

iOS API references

Primary Class - CameraEnhancer

Initialization

Method Description
initWithView Initialize the camera enhancer with the DCECameraView.
initLicense Sets product key and activate the SDK.
getVersion Get the SDK version.
cameraView Bind a DCECameraView to the camera enhancer.

Basic Camera Control Methods

Method Description
getAllCameras Get all available cameras. This method returns a list of available camera IDs.
getCameraPosition Returns whether the front-facing camera or back-facing camera is selected.
selectCamera Select a camera from the camera list with the camera ID.
getSelectedCamera Get the camera ID of the current selected camera.
getCameraState Get the state of the currently selected camera.
open Turn on the current selected camera.
close Turn off the current selected camera.
pause Pause the current selected camera.
resume Resume the current selected camera.
turnOnTorch Turn on the torch.
turnOffTorch Turn off the torch.
getFrameRate Get the current frame rate.
setResolution Set the resolution to the input value (if the input value is available for the device).
getResolution Get the current resolution.
setZoom Set the zoom factor. Once setZoom is triggered and approved, the zoom factor of the actived camera will immediately become the input value.
getMaxZoomFactor Get the maximum available zoom factor.
setFocus Set the focus position (value range from 0.0f to 1.0f) and trigger a focus at the configured position.
setScanRegion Set the scan region with a RegionDefinition value. The frame will be cropped according to the scan region.
getScanRegion Get the scan region.
scanRegionVisible Set whether to display the scanRegion on the UI.
setFrameRate Deprecated. Set the frame rate to the input value (if the input value is available for the device).

Frame Acquiring Methods

Method Description
getFrameFromBuffer Get the latest frame from the buffer. The input boolean value determines whether the fetched frame will be removed from the buffer.
addListener Add a listener to the Camera Enhancer instance.
removeListener Remove a preciously added listener from the Camera Enhancer instance.

Enhanced Features

Method Description
enableFeatures Enable camera enhancer features by inputting EnumEnhancerFeatures values.
disableFeatures Disable camera enhancer features by inputting EnumEnhancerFeatures values.
isFeatureEnabled Check whether the input features are enabled.

Advanced Camera Control Methods

Method Description
updateAdvancedSettingsFromFile Update advanced parameter settings including filter, sensor and focus settings from a JSON file.
updateAdvancedSettingsFromString Update advanced parameter settings including filter, sensor and focus settings from a JSON string.

Auxiliary Classes

Interfaces

  • [DCEFrameListener]({{ site.ios-api-auxiliary }}protocol-dceframelistener.html)
  • [DCELicenseVerificationListener]({{ site.ios-api-auxiliary }}protocol-licenselistener.html)

Enumerations

  • [EnumDCEErrorCode]({{ site.dce-enums }}error-code.html?lang=objc,swift)
  • [EnumFrameQuality]({{ site.dce-enums }}video-frame-quality.html?lang=objc,swift)
  • [EnumCameraState]({{ site.dce-enums }}camera-state.html?lang=objc,swift)
  • [EnumEnhancerFeatures]({{ site.dce-enums }}enhanced-features.html?lang=objc,swift)
  • [EnumResolution]({{ site.dce-enums }}resolution.html?lang=objc,swift)