io.scanbot.sdk.ui.camera

Class ScanbotCameraXView

io.scanbot.sdk.ui.camera.ScanbotCameraXView

All Implemented Interfaces:

FinderViewAttributeHandler, IScanbotCameraView, UiZoomDelegate

public class ScanbotCameraXView
implements IScanbotCameraView, UiZoomDelegate, FinderViewAttributeHandler

Wrapper view for CameraX

Field Detail

Companion

public static io.scanbot.sdk.ui.camera.ScanbotCameraXView.Companion Companion

Constructor Detail

ScanbotCameraXView

public ScanbotCameraXView(@NotNull
                          android.content.Context context,
                          @NotNull
                          android.util.AttributeSet attrs)

Wrapper view for CameraX

Method Detail

getSupportedPreviewSizes

@NotNull
public android.util.Size[] getSupportedPreviewSizes()

setSupportedPreviewSizes

public void setSupportedPreviewSizes(@NotNull
                                     android.util.Size[] p)

getSupportedPictureSizes

@NotNull
public android.util.Size[] getSupportedPictureSizes()

setSupportedPictureSizes

public void setSupportedPictureSizes(@NotNull
                                     android.util.Size[] p)

getLifecycleOwner

@Nullable
public androidx.lifecycle.LifecycleOwner getLifecycleOwner()

setLifecycleOwner

public void setLifecycleOwner(@Nullable
                              androidx.lifecycle.LifecycleOwner p)

getDelayAfterFocusCompleteMs

public long getDelayAfterFocusCompleteMs()

Delay that camera will took before snap on auto focus complete called from camera core in ms. For some devices this callback could call even before real auto focus completed, so we need to take some delay before snapping. Usually you can set 500ms. By default it is set to 20ms.

setDelayAfterFocusCompleteMs

public void setDelayAfterFocusCompleteMs(long p)

Delay that camera will took before snap on auto focus complete called from camera core in ms. For some devices this callback could call even before real auto focus completed, so we need to take some delay before snapping. Usually you can set 500ms. By default it is set to 20ms.

onAttachedToWindow

protected void onAttachedToWindow()

onDetachedFromWindow

protected void onDetachedFromWindow()

getAttachedFrameHandler

@Nullable
public <T extends FrameHandler> T getAttachedFrameHandler(@NotNull
                                                                    java.lang.Class<T> clazz)

Check whether there is same class of interface FrameHandler attached to the view return object of the same class if exists otherwise null

See Also:

interface FrameHandler, null

addFrameHandler

public void addFrameHandler(@NotNull
                            FrameHandler frameHandler)

Used to add frame handler that will be called on each next frame

removeFrameHandler

public void removeFrameHandler(@NotNull
                               FrameHandler frameHandler)

Unregisters interface FrameHandler.

Parameters:

frameHandler - handler to unregister. If it was not registered before, nothing happens.

See Also:

interface FrameHandler

setPreviewMode

public void setPreviewMode(@NotNull
                           CameraPreviewMode previewMode)

Set the camera preview mode. By default - CameraPreviewMode.FILL_IN.

Parameters:

previewMode -

• camera preview mode

takePicture

public void takePicture(boolean acquireFocus)

Takes picture.

Parameters:

acquireFocus - {@code true} to perform auto-focus before shooting. {@code false} to shoot as fast as possible using current camera state.

addPictureCallback

public void addPictureCallback(@NotNull
                               BasePictureCallback pictureCallback)

Adds callback which will be notified when picture will be taken. Callbacks are invoked on a worker thread, so you can safely perform "heavy" operations here.

Parameters:

pictureCallback - callback to register. Must not be null. If this callbackwas already added, nothing happens.

See Also:

class PictureCallback

removePictureCallback

public void removePictureCallback(@NotNull
                                  BasePictureCallback pictureCallback)

Removes callback, so it won't receive any further notifications.

Parameters:

pictureCallback - callback to unregister. If it was not registered before, nothinghappens.

setCameraOpenCallback

public void setCameraOpenCallback(@NotNull
                                  CameraOpenCallback cameraOpenCallback)

Callback which will be invoked when camera will be opened

Parameters:

cameraOpenCallback - callback

addCameraStateCallback

public void addCameraStateCallback(@NotNull
                                   CameraStateCallback cameraStateCallback)

Adds callback which will be notified about camera state changes. Callbacks are invoked on a main thread.

Parameters:

cameraStateCallback - callback to register. Must not be null. If this callbackwas already added, nothing happens.

removeCameraStateCallback

public void removeCameraStateCallback(@NotNull
                                      CameraStateCallback cameraStateCallback)

Removes callback, so it won't receive any further notifications.

Parameters:

cameraStateCallback - callback to unregister. If it was not registered before, nothinghappens.

addTakePictureCallback

public void addTakePictureCallback(@NotNull
                                   CameraTakePictureCallback cameraTakePictureCallback)

Adds callback which will be notified about take picture operation process. Callbacks are invoked on a main thread.

Parameters:

cameraTakePictureCallback - callback to register. Must not be null. If this callbackwas already added, nothing happens.

removeTakePictureCallback

public void removeTakePictureCallback(@NotNull
                                      CameraTakePictureCallback cameraTakePictureCallback)

Removes callback, so it won't receive any further notifications.

Parameters:

cameraTakePictureCallback - callback to unregister. If it was not registered before, nothinghappens.

setAutoFocusOnTouch

public void setAutoFocusOnTouch(boolean autoFocusOnTouch)

Parameters:

autoFocusOnTouch - if true - auto focus on touch will be enabled, false - otherwise.By default this feature is enabled.

autoFocus

public void autoFocus()

Performs auto-focus.

If there is no auto-focus capabilities on this device, does nothing.

If view is paused, this call is ignored.

continuousFocus

public void continuousFocus()

Cancels auto-focus and performs continuous-focus. Should be executed from the main thread and when camera is opened

If there is no continuous-focus capabilities on this device, does auto-focus.

If view is paused, this call is ignored.

useFlash

public void useFlash(boolean useFlash)

Enables or disables camera flash.

If there is no flash on this device, does nothing.

If view is paused, this call is ignored.

Parameters:

useFlash - true to enable flash. false to disable flash.

lockToPortrait

public void lockToPortrait(boolean lockPicture)

Locks camera in portrait mode

Parameters:

lockPicture - if true - taken picture will ba locked to the portrait orientation,false - picture orientation depends on the device sensor.

lockToLandscape

public void lockToLandscape(boolean lockPicture)

Locks camera in landscape mode

Parameters:

lockPicture - if true - taken picture will ba locked to the landscape orientation,false - picture orientation depends on the device sensor.

unlockOrientation

public void unlockOrientation()

Unlocks camera orientation

usePinchToZoom

public void usePinchToZoom(boolean usePinchToZoom)

Enables/disables Pinch-to-Zoom camera functionality

Parameters:

usePinchToZoom - true if Pinch-to-Zoom should be enabled, false - otherwise

setOpticalZoomLevel

public void setOpticalZoomLevel(float zoomLevel)

Sets current zoom by a linear zoom value ranging from 0f to 1.0f. Zoom Level 0f represents the minimum zoom while Zoom Level 1.0f represents the maximum zoom. Default value is 0f.

Parameters:

zoomLevel - Target zoom level

setOpticalZoomRange

public void setOpticalZoomRange(@NotNull
                                ZoomRange zoomRange)

Set custom zoom range. Default value is ZoomRange0f,1f.

Parameters:

zoomRange - Target zoom range

See Also:

ZoomRange0f,1f

setCameraModule

public void setCameraModule(@NotNull
                            CameraModule cameraModule)

Defines a camera module. By default is CameraModule.BACK.

Parameters:

cameraModule - enum CameraModule to use.

setPictureSize

public void setPictureSize(@NotNull
                           android.util.Size pictureSize)

Set camera picture size

Parameters:

pictureSize -

setPreviewSize

public void setPreviewSize(@NotNull
                           android.util.Size previewSize)

Set camera preview size

Parameters:

previewSize -

dispatchDraw

protected void dispatchDraw(@NotNull
                            android.graphics.Canvas canvas)

setUiZoomLevel

public void setUiZoomLevel(float zoomLevel)

Passes the zoom value to the dependent view

Parameters:

zoomLevel - the new scale of the UI

getFinderViewId

public int getFinderViewId()

Default is R.id.finder_overlay