layout | title | description | keywords | needAutoGenerateSidebar | breadcrumbText | noTitleIndex | permalink |
---|---|---|---|---|---|---|---|
default-layout |
Filter Methods - Dynamsoft Camera Enhancer Android API references |
This is the documentation - Android API references - Filter Methods page of Dynamsoft Camera Enhancer. |
Camera Enhancer, Android API references, Filter |
true |
Android Filter Methods |
true |
/programming/android/primary-api/preprocess-v1.0.3.html |
Method | Description |
---|---|
AcquireListFrame |
Fetch a frame from the video buffer. |
enableFastMode |
Set true/false to turn on/off DCE fast mode. |
getEnabledFastModeStatus |
Get the current status of fast mode (on/off). |
enableFrameFilter |
Set true/false to turn on/off DCE frame filter. |
getEnabledFrameFilterStatus |
Get the status (on/off) of DCE frame filter mode. |
setMaxFrameRate |
Set max frame rate. |
enableSensorControl |
Set true/false to turn on/off DCE sensor control. |
getEnabledSensorControlStatus |
Get the status (on/off) of DCE sensor control mode. |
setSensorControlThreshold |
Enable user to change sensor sensitivity (default value is 50). |
Fetch a single buffered frame from the video buffer.
AcquireListFrame(boolean);
Parameters
true
: If the video buffer is empty, the method will wait for the next added frame.
false
: If the video buffer is empty, the method will return an empty value.
Return Value
DCEFrame
: This method returns the buffered frame data. The frame data includes the image data, width, height, strides and other frame information.
Code Snippet
Java:
mCameraEnhancer.AcquireListFrame();
Kotlin:
mCameraEnhancer!!.AcquireListFrame
This API is designed for users to set up DCE fast mode. DCE fast mode will cut frames into small images that contain barcode areas to improve decoding efficiency. It is recommended to be enabled when decoding single barcodes.
enableFastMode(boolean)
Parameters
true
: Enable the fast-mode.
false
: Disable the fast-mode.
Code Snippet
Java:
mCameraEnhancer.enableFastMode(true);
Kotlin:
mCameraEnhancer!!.enableFastMode(true)
Get the status of the fast mode.
getEnabledFastModeStatus()
Return Value
true
: The fast-mode is enabled.
false
: The fast-mode is disabled.
Code Snippet
Java:
boolean x = mCameraEnhancer.getEnabledFastModeStatus();
Kotlin:
var x:boolean? = mCameraEnhancer!!.enabledFastModeStatus
Use enableFrameFilter
to turn on/off frame filter.
enableFrameFilter(boolean)
Parameters
true
: Enable the frame filter.
false
: Disable the frame filter.
Code Snippet
Java:
mCameraEnhancer.enableFrameFilter(true);
Kotlin:
mCameraEnhancer!!.enableFrameFilter(true)
Get the frame filter status.
getEnabledFrameFilterStatus()
Return Value
true
: The frame filter is enabled.
false
: The frame filter is disabled.
Code Snippet
Java:
boolean x = mCameraEnhancer.getEnabledFrameFilterStatus();
Kotlin:
var x:boolean? = mCameraEnhancer!!.enabledFrameFilterStatus
Set max frame rate.
setMaxFrameRate(int)
Parameters
int
: A int value that stands for the max frame rate.
Code Snippet
Java:
mCameraEnhancer.setMaxFrameRate(24);
Kotlin:
mCameraEnhancer!!.setMaxFrameRate(24)
Use enableSensorControl
to turn on/off sensor control mode.
enableSensorControl(boolean)
Parameters
true
: Enable the sensor filter.
false
: Disable the sensor filter.
Code Snippet
Java:
mCameraEnhancer.enableSensorControl(true);
Kotlin:
mCameraEnhancer!!.enableSensorControl(true)
Get the status of sensor control mode.
getEnabledSensorControlStatus()
Return Value
true
: The sensor filter is enabled.
false
: The sensor filter is disabled.
Code Snippet
Java:
boolean x = mCameraEnhancer.getEnabledSensorControlStatus();
Kotlin:
var x:boolean? = mCameraEnhancer!!.enabledSensorControlStatus
This API is designed for developers to apply different sensor sensitivity settings on different devices. The default value is 50.
setSensorControlThreshold(int)
Parameters
int
: A int value that stands for the sensor filter threshold.
Code Snippet
Java:
mCameraEnhancer.setSensorControlThreshold(55);
Kotlin:
mCameraEnhancer!!.setSensorControlThreshold(55)