Android API references
Primary Class - CameraEnhancer
Initialization
| Method | Description |
|---|---|
CameraEnhancer |
Initialize the CameraEnhancer object. |
initLicense |
Sets product key and activate the SDK. |
getVersion |
Get the SDK version. |
Basic Camera Control Methods
| Method | Description |
|---|---|
getAllCameras |
Get all available cameras. This method returns a list of available camera IDs. |
selectCamera(EnumCameraPosition) |
Select whether to use front-facing camera or back-facing camera. |
getCameraPosition |
Returns whether the front-facing camera or back-facing camera is selected. |
selectCamera(String) |
Select a camera from the camera list with the camera ID. |
getSelectedCamera |
Get the camera ID of the current selected camera. |
getCameraPosition |
Returns whether the device uses a front-facing or rear-facing 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. |
getResolutionList |
Get all available resolutions. |
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 focus once at the configured position. |
setFocus(subsequentFocusMode) |
Trigger a focus at the targeting point and set the subsequent focus mode after focused. |
setScanRegion |
Set the scan region with a RegionDefinition value. The frame will be cropped according to the scan region. |
getScanRegion |
Get the scan region. |
setScanRegionVisible |
Set whether to display the scanRegion on the UI. |
getScanRegionVisible |
Get whether the scanRegion will be displayed on the UI. |
setCameraStateListener |
Add a DCECameraStateListener to receive notification when the camera state changes. |
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. |
takePhoto |
Take a photo from the camera and save the image in the memory. |
Enhanced Features
| Method | Description |
|---|---|
enableFeatures |
Enable DCE features with Enumeration value. |
disableFeatures |
Disable DCE features with Enumeration value. |
isFeatureEnabled |
Returns a boolean value that means whether the feature(s) you input is (are) enabled. |
Camera UI Methods
| Method | Description |
|---|---|
setCameraView |
Sets camera video streaming UI. Read more from DCECameraView. |
getCameraView |
Gets camera video streaming UI. Read more from DCECameraView. |
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. |
Yes
No