com.microblink.view.recognition

Class RecognizerView

java.lang.Object

android.view.View

android.view.ViewGroup

com.microblink.view.BaseCameraView

com.microblink.view.CameraViewGroup

com.microblink.view.recognition.RecognizerView

All Implemented Interfaces:

android.graphics.drawable.Drawable.Callback, android.view.accessibility.AccessibilityEventSource, android.view.KeyEvent.Callback, android.view.ViewManager, android.view.ViewParent

public class RecognizerView
extends CameraViewGroup

Created by dodo on 06/10/14.

Nested Class Summary

Nested classes/interfaces inherited from class com.microblink.view.CameraViewGroup

CameraViewGroup.CameraViewGroupOrientationChangeListener, CameraViewGroup.LayoutParams

Nested classes/interfaces inherited from class com.microblink.view.BaseCameraView

BaseCameraView.BaseCameraListener, BaseCameraView.BaseCameraViewEventsListener, BaseCameraView.BaseOrientationChangeListener, BaseCameraView.CameraViewState

Nested classes/interfaces inherited from class android.view.ViewGroup

android.view.ViewGroup.MarginLayoutParams, android.view.ViewGroup.OnHierarchyChangeListener

Nested classes/interfaces inherited from class android.view.View

android.view.View.AccessibilityDelegate, android.view.View.BaseSavedState, android.view.View.DragShadowBuilder, android.view.View.MeasureSpec, android.view.View.OnApplyWindowInsetsListener, android.view.View.OnAttachStateChangeListener, android.view.View.OnClickListener, android.view.View.OnContextClickListener, android.view.View.OnCreateContextMenuListener, android.view.View.OnDragListener, android.view.View.OnFocusChangeListener, android.view.View.OnGenericMotionListener, android.view.View.OnHoverListener, android.view.View.OnKeyListener, android.view.View.OnLayoutChangeListener, android.view.View.OnLongClickListener, android.view.View.OnScrollChangeListener, android.view.View.OnSystemUiVisibilityChangeListener, android.view.View.OnTouchListener

Field Summary

Fields

Modifier and Type	Field and Description
protected RecognitionSettings	mRecognitionSettings Settings object

Fields inherited from class com.microblink.view.BaseCameraView

mAspectMode, mCameraEventsListener, mCameraSurfaceView, mCameraViewState, mConfigurationOrientation, mDeviceManager, mErrorState, mHostScreenOrientation, mInitialOrientation, mIsRequestedOrientationSensor, mIsRequestedOrientationUser, mOnActivityFlipListener, mRotateMeteringAreas, mSlaveOrientationChangeListener

Fields inherited from class android.view.ViewGroup

CLIP_TO_PADDING_MASK, FOCUS_AFTER_DESCENDANTS, FOCUS_BEFORE_DESCENDANTS, FOCUS_BLOCK_DESCENDANTS, LAYOUT_MODE_CLIP_BOUNDS, LAYOUT_MODE_OPTICAL_BOUNDS, PERSISTENT_ALL_CACHES, PERSISTENT_ANIMATION_CACHE, PERSISTENT_NO_CACHE, PERSISTENT_SCROLLING_CACHE

Fields inherited from class android.view.View

ACCESSIBILITY_LIVE_REGION_ASSERTIVE, ACCESSIBILITY_LIVE_REGION_NONE, ACCESSIBILITY_LIVE_REGION_POLITE, ALPHA, DRAG_FLAG_GLOBAL, DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION, DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION, DRAG_FLAG_GLOBAL_URI_READ, DRAG_FLAG_GLOBAL_URI_WRITE, DRAG_FLAG_OPAQUE, DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_HIGH, DRAWING_CACHE_QUALITY_LOW, EMPTY_STATE_SET, ENABLED_FOCUSED_SELECTED_STATE_SET, ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_FOCUSED_STATE_SET, ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, ENABLED_SELECTED_STATE_SET, ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_STATE_SET, ENABLED_WINDOW_FOCUSED_STATE_SET, FIND_VIEWS_WITH_CONTENT_DESCRIPTION, FIND_VIEWS_WITH_TEXT, FOCUS_BACKWARD, FOCUS_DOWN, FOCUS_FORWARD, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_UP, FOCUSABLES_ALL, FOCUSABLES_TOUCH_MODE, FOCUSED_SELECTED_STATE_SET, FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, FOCUSED_STATE_SET, FOCUSED_WINDOW_FOCUSED_STATE_SET, GONE, HAPTIC_FEEDBACK_ENABLED, IMPORTANT_FOR_ACCESSIBILITY_AUTO, IMPORTANT_FOR_ACCESSIBILITY_NO, IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, IMPORTANT_FOR_ACCESSIBILITY_YES, INVISIBLE, KEEP_SCREEN_ON, LAYER_TYPE_HARDWARE, LAYER_TYPE_NONE, LAYER_TYPE_SOFTWARE, LAYOUT_DIRECTION_INHERIT, LAYOUT_DIRECTION_LOCALE, LAYOUT_DIRECTION_LTR, LAYOUT_DIRECTION_RTL, MEASURED_HEIGHT_STATE_SHIFT, MEASURED_SIZE_MASK, MEASURED_STATE_MASK, MEASURED_STATE_TOO_SMALL, NO_ID, OVER_SCROLL_ALWAYS, OVER_SCROLL_IF_CONTENT_SCROLLS, OVER_SCROLL_NEVER, PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET, PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_SELECTED_STATE_SET, PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_STATE_SET, PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_SELECTED_STATE_SET, PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_STATE_SET, PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_SELECTED_STATE_SET, PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_STATE_SET, PRESSED_WINDOW_FOCUSED_STATE_SET, ROTATION, ROTATION_X, ROTATION_Y, SCALE_X, SCALE_Y, SCREEN_STATE_OFF, SCREEN_STATE_ON, SCROLL_AXIS_HORIZONTAL, SCROLL_AXIS_NONE, SCROLL_AXIS_VERTICAL, SCROLL_INDICATOR_BOTTOM, SCROLL_INDICATOR_END, SCROLL_INDICATOR_LEFT, SCROLL_INDICATOR_RIGHT, SCROLL_INDICATOR_START, SCROLL_INDICATOR_TOP, SCROLLBAR_POSITION_DEFAULT, SCROLLBAR_POSITION_LEFT, SCROLLBAR_POSITION_RIGHT, SCROLLBARS_INSIDE_INSET, SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_OUTSIDE_INSET, SCROLLBARS_OUTSIDE_OVERLAY, SELECTED_STATE_SET, SELECTED_WINDOW_FOCUSED_STATE_SET, SOUND_EFFECTS_ENABLED, STATUS_BAR_HIDDEN, STATUS_BAR_VISIBLE, SYSTEM_UI_FLAG_FULLSCREEN, SYSTEM_UI_FLAG_HIDE_NAVIGATION, SYSTEM_UI_FLAG_IMMERSIVE, SYSTEM_UI_FLAG_IMMERSIVE_STICKY, SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN, SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION, SYSTEM_UI_FLAG_LAYOUT_STABLE, SYSTEM_UI_FLAG_LIGHT_STATUS_BAR, SYSTEM_UI_FLAG_LOW_PROFILE, SYSTEM_UI_FLAG_VISIBLE, SYSTEM_UI_LAYOUT_FLAGS, TEXT_ALIGNMENT_CENTER, TEXT_ALIGNMENT_GRAVITY, TEXT_ALIGNMENT_INHERIT, TEXT_ALIGNMENT_TEXT_END, TEXT_ALIGNMENT_TEXT_START, TEXT_ALIGNMENT_VIEW_END, TEXT_ALIGNMENT_VIEW_START, TEXT_DIRECTION_ANY_RTL, TEXT_DIRECTION_FIRST_STRONG, TEXT_DIRECTION_FIRST_STRONG_LTR, TEXT_DIRECTION_FIRST_STRONG_RTL, TEXT_DIRECTION_INHERIT, TEXT_DIRECTION_LOCALE, TEXT_DIRECTION_LTR, TEXT_DIRECTION_RTL, TRANSLATION_X, TRANSLATION_Y, TRANSLATION_Z, VIEW_LOG_TAG, VISIBLE, WINDOW_FOCUSED_STATE_SET, X, Y, Z

Constructor Summary

Constructors

Constructor and Description
RecognizerView(android.content.Context context)
RecognizerView(android.content.Context context, android.util.AttributeSet attrSet)

Method Summary

Modifier and Type	Method and Description
protected void	changeConfigurationInternal(android.content.res.Configuration newConfig)
void	create() This method must be called from activity's onCreate.
protected CameraListener	createCameraListener() ABSTRACT METHODS
protected OrientationChangeListener	createOrientationChangeListener()
void	destroy() This method must be called from activity's onDestroy.
static java.lang.String	getNativeLibraryVersionString() Methods returns the version string of native library, if it has been loaded.
RecognitionSettings	getRecognitionSettings() Returns the currently active generic settings that affect all recognizers and whole recognition process.
Rectangle	getScanningRegion() Returns the current scanning region or null if entire image is scanned.
ScanResultListener	getScanResultListener() Returns the listener that will obtain the results of the scanning.
boolean	isScanningPaused() Returns true if scanning is paused or if scanning still has not yet started.
protected void	onActivityFlip() Called when activity is flipped - this event is not raised by OS so we have custom detection of that state.
protected void	onCameraPreviewStarted()
protected void	onCameraPreviewStopped()
void	pause() This method must be called from activity's onPause.
void	pauseScanning() Pauses the scanning loop.
protected void	prepareCameraSettings(CameraSettings settings) Called inside onCreate method before creating camera manager.
void	reconfigureRecognizers(RecognitionSettings recognitionSettings) Use this method to reconfigure available recognizers.
protected boolean	requireAutofocusFeature() If autofocus feature is required, please return true from this method.
void	resetRecognitionState() Resets the recognizer state, i.e.
void	resume() This method must be called from activity's onResume.
void	resumeScanning(boolean resetState) This method resumes scanning loop that was paused by calling pauseScanning().
void	setLicenseKey(java.lang.String licenseKey) Set license key and unlock the library.
void	setLicenseKey(java.lang.String licenseKey, java.lang.String licensee) Set license key and unlock the library.
void	setMetadataListener(MetadataListener metadataListener, MetadataSettings metadataSettings) Sets the listener that will obtain metadata that is being processed.
void	setRecognitionSettings(RecognitionSettings recognitionSettings) Sets the generic settings that affect all recognizers and whole recognition process.
void	setScanningRegion(Rectangle scanningRegion, boolean rotateRegionWithDevice) Define scanning region as a rectangle.
void	setScanResultListener(ScanResultListener scanResultListener) Sets the listener that will obtain the results of the scanning.
boolean	shouldRotateScanningRegion() Returns true if scanning region should be rotated with device.
protected boolean	shouldStartCamera()
void	start() This method must be called from activity's onStart.
void	stop() This method must be called from activity's onStop.

Methods inherited from class com.microblink.view.CameraViewGroup

addChildView, addChildView, addView, addView, addView, addView, addView, checkLayoutParams, dispatchTouchEvent, generateDefaultLayoutParams, generateLayoutParams, getRotationAnimationDuration, setAnimateRotation, setInitialOrientation, setRotationAnimationDuration, shouldAnimateRotation

Methods inherited from class com.microblink.view.BaseCameraView

areCameraPixelsLandscapeLeft, calculateHostScreenOrientation, changeConfiguration, createCameraViewEventsListener, focusCamera, getActivityOrientation, getAspectMode, getCameraEventsListener, getCameraFactorySettings, getCameraPreviewHeight, getCameraPreviewWidth, getCameraViewState, getConfigurationOrientation, getCurrentOrientation, getHostActivity, getHostScreenOrientation, getInitialOrientation, getOpenedCameraType, getOrientationChangeListener, getVisiblePart, getZoomLevel, isAutofocusSupported, isCameraActive, isCameraFocused, isCameraTorchSupported, isDeviceShaking, isHostActivityOrientationOnSensor, isOrientationAllowed, isPinchToZoomAllowed, isRequestedOrientationSensor, isRequestedOrientationUser, isTapToFocusAllowed, onCreateCameraManager, onLayout, onMeasure, runOnUIThread, setAspectMode, setCameraEventsListener, setCameraType, setForceUseLegacyCamera, setMeteringAreas, setMeteringAreasToCamera, setOnActivityFlipListener, setOnSizeChangedListener, setOptimizeCameraForNearScan, setOrientationAllowedListener, setOrientationChangeListener, setPhotoMode, setPinchToZoomAllowed, setRequestAutofocusOnShakingStopInContinousAutofocusMode, setShakeListener, setTapToFocusAllowed, setTorchState, setUseTextureViewForCameraDisplay, setVideoResolutionPreset, setZoomLevel

Methods inherited from class android.view.ViewGroup

addChildrenForAccessibility, addFocusables, addStatesFromChildren, addTouchables, addViewInLayout, addViewInLayout, attachLayoutAnimationParameters, attachViewToParent, bringChildToFront, canAnimate, childDrawableStateChanged, childHasTransientStateChanged, cleanupLayoutState, clearChildFocus, clearDisappearingChildren, clearFocus, debug, detachAllViewsFromParent, detachViewFromParent, detachViewFromParent, detachViewsFromParent, dispatchApplyWindowInsets, dispatchConfigurationChanged, dispatchDisplayHint, dispatchDragEvent, dispatchDraw, dispatchDrawableHotspotChanged, dispatchFreezeSelfOnly, dispatchGenericFocusedEvent, dispatchGenericPointerEvent, dispatchHoverEvent, dispatchKeyEvent, dispatchKeyEventPreIme, dispatchKeyShortcutEvent, dispatchProvideStructure, dispatchRestoreInstanceState, dispatchSaveInstanceState, dispatchSetActivated, dispatchSetPressed, dispatchSetSelected, dispatchSystemUiVisibilityChanged, dispatchThawSelfOnly, dispatchTrackballEvent, dispatchUnhandledMove, dispatchVisibilityChanged, dispatchWindowFocusChanged, dispatchWindowSystemUiVisiblityChanged, dispatchWindowVisibilityChanged, drawableStateChanged, drawChild, endViewTransition, findFocus, findViewsWithText, focusableViewAvailable, focusSearch, gatherTransparentRegion, generateLayoutParams, getAccessibilityClassName, getChildAt, getChildCount, getChildDrawingOrder, getChildMeasureSpec, getChildStaticTransformation, getChildVisibleRect, getClipChildren, getClipToPadding, getDescendantFocusability, getFocusedChild, getLayoutAnimation, getLayoutAnimationListener, getLayoutMode, getLayoutTransition, getNestedScrollAxes, getOverlay, getPersistentDrawingCache, getTouchscreenBlocksFocus, hasFocus, hasFocusable, hasTransientState, indexOfChild, invalidateChild, invalidateChildInParent, isAlwaysDrawnWithCacheEnabled, isAnimationCacheEnabled, isChildrenDrawingOrderEnabled, isChildrenDrawnWithCacheEnabled, isMotionEventSplittingEnabled, isTransitionGroup, jumpDrawablesToCurrentState, layout, measureChild, measureChildren, measureChildWithMargins, notifySubtreeAccessibilityStateChanged, offsetDescendantRectToMyCoords, offsetRectIntoDescendantCoords, onAttachedToWindow, onCreateDrawableState, onDetachedFromWindow, onInterceptHoverEvent, onInterceptTouchEvent, onNestedFling, onNestedPreFling, onNestedPrePerformAccessibilityAction, onNestedPreScroll, onNestedScroll, onNestedScrollAccepted, onRequestFocusInDescendants, onRequestSendAccessibilityEvent, onResolvePointerIcon, onStartNestedScroll, onStopNestedScroll, onViewAdded, onViewRemoved, recomputeViewAttributes, removeAllViews, removeAllViewsInLayout, removeDetachedView, removeView, removeViewAt, removeViewInLayout, removeViews, removeViewsInLayout, requestChildFocus, requestChildRectangleOnScreen, requestDisallowInterceptTouchEvent, requestFocus, requestSendAccessibilityEvent, requestTransparentRegion, scheduleLayoutAnimation, setAddStatesFromChildren, setAlwaysDrawnWithCacheEnabled, setAnimationCacheEnabled, setChildrenDrawingCacheEnabled, setChildrenDrawingOrderEnabled, setChildrenDrawnWithCacheEnabled, setClipChildren, setClipToPadding, setDescendantFocusability, setLayoutAnimation, setLayoutAnimationListener, setLayoutMode, setLayoutTransition, setMotionEventSplittingEnabled, setOnHierarchyChangeListener, setPersistentDrawingCache, setStaticTransformationsEnabled, setTouchscreenBlocksFocus, setTransitionGroup, shouldDelayChildPressedState, showContextMenuForChild, showContextMenuForChild, startActionModeForChild, startActionModeForChild, startLayoutAnimation, startViewTransition, updateViewLayout

Methods inherited from class android.view.View

addFocusables, addOnAttachStateChangeListener, addOnLayoutChangeListener, animate, announceForAccessibility, awakenScrollBars, awakenScrollBars, awakenScrollBars, bringToFront, buildDrawingCache, buildDrawingCache, buildLayer, callOnClick, cancelDragAndDrop, cancelLongPress, cancelPendingInputEvents, canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, canScrollHorizontally, canScrollVertically, checkInputConnectionProxy, clearAnimation, combineMeasuredStates, computeHorizontalScrollExtent, computeHorizontalScrollOffset, computeHorizontalScrollRange, computeScroll, computeSystemWindowInsets, computeVerticalScrollExtent, computeVerticalScrollOffset, computeVerticalScrollRange, createAccessibilityNodeInfo, createContextMenu, destroyDrawingCache, dispatchFinishTemporaryDetach, dispatchGenericMotionEvent, dispatchNestedFling, dispatchNestedPreFling, dispatchNestedPrePerformAccessibilityAction, dispatchNestedPreScroll, dispatchNestedScroll, dispatchPopulateAccessibilityEvent, dispatchStartTemporaryDetach, draw, drawableHotspotChanged, findViewById, findViewWithTag, fitSystemWindows, focusSearch, forceHasOverlappingRendering, forceLayout, generateViewId, getAccessibilityLiveRegion, getAccessibilityNodeProvider, getAccessibilityTraversalAfter, getAccessibilityTraversalBefore, getAlpha, getAnimation, getApplicationWindowToken, getBackground, getBackgroundTintList, getBackgroundTintMode, getBaseline, getBottom, getBottomFadingEdgeStrength, getBottomPaddingOffset, getCameraDistance, getClipBounds, getClipBounds, getClipToOutline, getContentDescription, getContext, getContextMenuInfo, getDefaultSize, getDisplay, getDrawableState, getDrawingCache, getDrawingCache, getDrawingCacheBackgroundColor, getDrawingCacheQuality, getDrawingRect, getDrawingTime, getElevation, getFilterTouchesWhenObscured, getFitsSystemWindows, getFocusables, getFocusedRect, getForeground, getForegroundGravity, getForegroundTintList, getForegroundTintMode, getGlobalVisibleRect, getGlobalVisibleRect, getHandler, getHasOverlappingRendering, getHeight, getHitRect, getHorizontalFadingEdgeLength, getHorizontalScrollbarHeight, getId, getImportantForAccessibility, getKeepScreenOn, getKeyDispatcherState, getLabelFor, getLayerType, getLayoutDirection, getLayoutParams, getLeft, getLeftFadingEdgeStrength, getLeftPaddingOffset, getLocalVisibleRect, getLocationInWindow, getLocationOnScreen, getMatrix, getMeasuredHeight, getMeasuredHeightAndState, getMeasuredState, getMeasuredWidth, getMeasuredWidthAndState, getMinimumHeight, getMinimumWidth, getNextFocusDownId, getNextFocusForwardId, getNextFocusLeftId, getNextFocusRightId, getNextFocusUpId, getOnFocusChangeListener, getOutlineProvider, getOverScrollMode, getPaddingBottom, getPaddingEnd, getPaddingLeft, getPaddingRight, getPaddingStart, getPaddingTop, getParent, getParentForAccessibility, getPivotX, getPivotY, getPointerIcon, getResources, getRevealOnFocusHint, getRight, getRightFadingEdgeStrength, getRightPaddingOffset, getRootView, getRootWindowInsets, getRotation, getRotationX, getRotationY, getScaleX, getScaleY, getScrollBarDefaultDelayBeforeFade, getScrollBarFadeDuration, getScrollBarSize, getScrollBarStyle, getScrollIndicators, getScrollX, getScrollY, getSolidColor, getStateListAnimator, getSuggestedMinimumHeight, getSuggestedMinimumWidth, getSystemUiVisibility, getTag, getTag, getTextAlignment, getTextDirection, getTop, getTopFadingEdgeStrength, getTopPaddingOffset, getTouchables, getTouchDelegate, getTransitionName, getTranslationX, getTranslationY, getTranslationZ, getVerticalFadingEdgeLength, getVerticalScrollbarPosition, getVerticalScrollbarWidth, getViewTreeObserver, getVisibility, getWidth, getWindowAttachCount, getWindowId, getWindowSystemUiVisibility, getWindowToken, getWindowVisibility, getWindowVisibleDisplayFrame, getX, getY, getZ, hasNestedScrollingParent, hasOnClickListeners, hasOverlappingRendering, hasWindowFocus, inflate, invalidate, invalidate, invalidate, invalidateDrawable, invalidateOutline, isAccessibilityFocused, isActivated, isAttachedToWindow, isClickable, isContextClickable, isDirty, isDrawingCacheEnabled, isDuplicateParentStateEnabled, isEnabled, isFocusable, isFocusableInTouchMode, isFocused, isHapticFeedbackEnabled, isHardwareAccelerated, isHorizontalFadingEdgeEnabled, isHorizontalScrollBarEnabled, isHovered, isImportantForAccessibility, isInEditMode, isInLayout, isInTouchMode, isLaidOut, isLayoutDirectionResolved, isLayoutRequested, isLongClickable, isNestedScrollingEnabled, isOpaque, isPaddingOffsetRequired, isPaddingRelative, isPressed, isSaveEnabled, isSaveFromParentEnabled, isScrollbarFadingEnabled, isScrollContainer, isSelected, isShown, isSoundEffectsEnabled, isTemporarilyDetached, isTextAlignmentResolved, isTextDirectionResolved, isVerticalFadingEdgeEnabled, isVerticalScrollBarEnabled, measure, mergeDrawableStates, offsetLeftAndRight, offsetTopAndBottom, onAnimationEnd, onAnimationStart, onApplyWindowInsets, onCancelPendingInputEvents, onCheckIsTextEditor, onConfigurationChanged, onCreateContextMenu, onCreateInputConnection, onDisplayHint, onDragEvent, onDraw, onDrawForeground, onDrawScrollBars, onFilterTouchEventForSecurity, onFinishInflate, onFinishTemporaryDetach, onFocusChanged, onGenericMotionEvent, onHoverChanged, onHoverEvent, onInitializeAccessibilityEvent, onInitializeAccessibilityNodeInfo, onKeyDown, onKeyLongPress, onKeyMultiple, onKeyPreIme, onKeyShortcut, onKeyUp, onOverScrolled, onPopulateAccessibilityEvent, onProvideStructure, onProvideVirtualStructure, onRestoreInstanceState, onRtlPropertiesChanged, onSaveInstanceState, onScreenStateChanged, onScrollChanged, onSetAlpha, onSizeChanged, onStartTemporaryDetach, onTouchEvent, onTrackballEvent, onVisibilityAggregated, onVisibilityChanged, onWindowFocusChanged, onWindowSystemUiVisibilityChanged, onWindowVisibilityChanged, overScrollBy, performAccessibilityAction, performClick, performContextClick, performContextClick, performHapticFeedback, performHapticFeedback, performLongClick, performLongClick, playSoundEffect, post, postDelayed, postInvalidate, postInvalidate, postInvalidateDelayed, postInvalidateDelayed, postInvalidateOnAnimation, postInvalidateOnAnimation, postOnAnimation, postOnAnimationDelayed, refreshDrawableState, removeCallbacks, removeOnAttachStateChangeListener, removeOnLayoutChangeListener, requestApplyInsets, requestFitSystemWindows, requestFocus, requestFocus, requestFocusFromTouch, requestLayout, requestRectangleOnScreen, requestRectangleOnScreen, requestUnbufferedDispatch, resolveSize, resolveSizeAndState, restoreHierarchyState, saveHierarchyState, scheduleDrawable, scrollBy, scrollTo, sendAccessibilityEvent, sendAccessibilityEventUnchecked, setAccessibilityDelegate, setAccessibilityLiveRegion, setAccessibilityTraversalAfter, setAccessibilityTraversalBefore, setActivated, setAlpha, setAnimation, setBackground, setBackgroundColor, setBackgroundDrawable, setBackgroundResource, setBackgroundTintList, setBackgroundTintMode, setBottom, setCameraDistance, setClickable, setClipBounds, setClipToOutline, setContentDescription, setContextClickable, setDrawingCacheBackgroundColor, setDrawingCacheEnabled, setDrawingCacheQuality, setDuplicateParentStateEnabled, setElevation, setEnabled, setFadingEdgeLength, setFilterTouchesWhenObscured, setFitsSystemWindows, setFocusable, setFocusableInTouchMode, setForeground, setForegroundGravity, setForegroundTintList, setForegroundTintMode, setHapticFeedbackEnabled, setHasTransientState, setHorizontalFadingEdgeEnabled, setHorizontalScrollBarEnabled, setHovered, setId, setImportantForAccessibility, setKeepScreenOn, setLabelFor, setLayerPaint, setLayerType, setLayoutDirection, setLayoutParams, setLeft, setLongClickable, setMeasuredDimension, setMinimumHeight, setMinimumWidth, setNestedScrollingEnabled, setNextFocusDownId, setNextFocusForwardId, setNextFocusLeftId, setNextFocusRightId, setNextFocusUpId, setOnApplyWindowInsetsListener, setOnClickListener, setOnContextClickListener, setOnCreateContextMenuListener, setOnDragListener, setOnFocusChangeListener, setOnGenericMotionListener, setOnHoverListener, setOnKeyListener, setOnLongClickListener, setOnScrollChangeListener, setOnSystemUiVisibilityChangeListener, setOnTouchListener, setOutlineProvider, setOverScrollMode, setPadding, setPaddingRelative, setPivotX, setPivotY, setPointerIcon, setPressed, setRevealOnFocusHint, setRight, setRotation, setRotationX, setRotationY, setSaveEnabled, setSaveFromParentEnabled, setScaleX, setScaleY, setScrollBarDefaultDelayBeforeFade, setScrollBarFadeDuration, setScrollbarFadingEnabled, setScrollBarSize, setScrollBarStyle, setScrollContainer, setScrollIndicators, setScrollIndicators, setScrollX, setScrollY, setSelected, setSoundEffectsEnabled, setStateListAnimator, setSystemUiVisibility, setTag, setTag, setTextAlignment, setTextDirection, setTop, setTouchDelegate, setTransitionName, setTranslationX, setTranslationY, setTranslationZ, setVerticalFadingEdgeEnabled, setVerticalScrollBarEnabled, setVerticalScrollbarPosition, setVisibility, setWillNotCacheDrawing, setWillNotDraw, setX, setY, setZ, showContextMenu, showContextMenu, startActionMode, startActionMode, startAnimation, startDrag, startDragAndDrop, startNestedScroll, stopNestedScroll, toString, unscheduleDrawable, unscheduleDrawable, updateDragShadow, verifyDrawable, willNotCacheDrawing, willNotDraw

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface android.view.ViewParent

canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, createContextMenu, getLayoutDirection, getParent, getParentForAccessibility, getTextAlignment, getTextDirection, isLayoutDirectionResolved, isLayoutRequested, isTextAlignmentResolved, isTextDirectionResolved, requestFitSystemWindows, requestLayout

Field Detail

mRecognitionSettings

protected RecognitionSettings mRecognitionSettings

Settings object

Constructor Detail

RecognizerView

@UiThread
public RecognizerView(android.content.Context context,
                                android.util.AttributeSet attrSet)

RecognizerView

@UiThread
public RecognizerView(android.content.Context context)

Method Detail

create

@UiThread
public void create()

This method must be called from activity's onCreate. If not called, recognition will not work.

Overrides:

create in class CameraViewGroup

Throws:

java.lang.UnsatisfiedLinkError - if native library could not be loaded

java.lang.NullPointerException - if scan result listener or camera events listener is not set

java.lang.IllegalStateException - if recognizer settings array is null or empty

prepareCameraSettings

protected final void prepareCameraSettings(CameraSettings settings)

Description copied from class: BaseCameraView

Called inside onCreate method before creating camera manager. Use this method to create camera settings that are used on each startPreview event.

Overrides:

prepareCameraSettings in class BaseCameraView

start

@UiThread
public final void start()

This method must be called from activity's onStart. If not called, recognition will not work.

Overrides:

start in class BaseCameraView

stop

@UiThread
public final void stop()

This method must be called from activity's onStop. If not called, recognition will not work.

Overrides:

stop in class BaseCameraView

resume

@UiThread
public final void resume()

This method must be called from activity's onResume. If not called, recognition will not work.

Overrides:

resume in class BaseCameraView

resumeScanning

@UiThread
public final void resumeScanning(boolean resetState)

This method resumes scanning loop that was paused by calling pauseScanning(). If resetState is 'true', resetRecognitionState() will be called. If resetState is 'false', recognition state will not be reset, so scanning after resume may use old scan data to boost quality. pauseScanning() and resumeScanning(boolean) are counting calls. This means that if you called pauseScanning() twice, you will also have to call resumeScanning(boolean) twice to actually resume scanning.

Parameters:

resetState - should internal state be reset when resuming scanning

pauseScanning

@UiThread
public final void pauseScanning()

Pauses the scanning loop. But keeps camera active. You can resume scanning by calling resumeScanning(boolean). pauseScanning() and resumeScanning(boolean) are counting calls. This means that if you called pauseScanning() twice, you will also have to call resumeScanning(boolean) to actually resume scanning.

pause

@UiThread
public final void pause()

This method must be called from activity's onPause. If not called, recognition will not work. This method pauses the camera.

Overrides:

pause in class BaseCameraView

onCameraPreviewStopped

protected void onCameraPreviewStopped()

Overrides:

onCameraPreviewStopped in class BaseCameraView

destroy

@UiThread
public final void destroy()

This method must be called from activity's onDestroy. If not called, recognition will not work.

Overrides:

destroy in class BaseCameraView

shouldStartCamera

protected final boolean shouldStartCamera()

Overrides:

shouldStartCamera in class BaseCameraView

onCameraPreviewStarted

protected void onCameraPreviewStarted()

Overrides:

onCameraPreviewStarted in class BaseCameraView

resetRecognitionState

@UiThread
public final void resetRecognitionState()

Resets the recognizer state, i.e. deletes the cached data from multiple recognitions.

isScanningPaused

public boolean isScanningPaused()

Returns true if scanning is paused or if scanning still has not yet started.

Returns:

true if scanning is paused or if scanning still has not yet started.

reconfigureRecognizers

@UiThread
public void reconfigureRecognizers(RecognitionSettings recognitionSettings)

Use this method to reconfigure available recognizers. Unlike setRecognitionSettings, this method can be called when recognizers are active.

Parameters:

recognitionSettings - New recognition settings that will be applied.

requireAutofocusFeature

protected boolean requireAutofocusFeature()

Description copied from class: BaseCameraView

If autofocus feature is required, please return true from this method. If autofocus feature is not required, return false. If autofocus is required and device does not support autofocus, error will be raised and application will not start. If autofocus is not required, application will work even on devices without autofocus.

Specified by:

requireAutofocusFeature in class BaseCameraView

Returns:

True if autofocus is required, otherwise false.

onActivityFlip

protected void onActivityFlip()

Description copied from class: BaseCameraView

Called when activity is flipped - this event is not raised by OS so we have custom detection of that state.

Specified by:

onActivityFlip in class BaseCameraView

createCameraListener

protected final CameraListener createCameraListener()

Description copied from class: BaseCameraView

ABSTRACT METHODS

Specified by:

createCameraListener in class BaseCameraView

createOrientationChangeListener

protected final OrientationChangeListener createOrientationChangeListener()

Overrides:

createOrientationChangeListener in class CameraViewGroup

setLicenseKey

@UiThread
public final void setLicenseKey(@NonNull
                                          java.lang.String licenseKey)
                                   throws InvalidLicenceKeyException

Set license key and unlock the library. Application package will be used to validate license key. This method must be called before calling create to have effect.

Parameters:

licenseKey - license key for unlocking the library

Throws:

InvalidLicenceKeyException - if license key is not valid

setLicenseKey

@UiThread
public final void setLicenseKey(@NonNull
                                          java.lang.String licenseKey,
                                          java.lang.String licensee)
                                   throws InvalidLicenceKeyException

Set license key and unlock the library. Also define licensee that will be used to validate license key. This method must be called before calling create to have effect.

Parameters:

licenseKey - license key for unlocking the library

licensee - licensee

Throws:

InvalidLicenceKeyException - if license key is not valid

setScanningRegion

@UiThread
public final void setScanningRegion(Rectangle scanningRegion,
                                              boolean rotateRegionWithDevice)

Define scanning region as a rectangle. Also define whether scanning region will rotate when device orientation changes.

first parameter of rectangle is x-coordinate represented as percentage of view width, second parameter is y-coordinate represented as percentage of view height, third parameter is region width represented as percentage of view width and fourth parameter is region height represented as percentage of view height

View width and height are defined in current context, i.e. they depend on screen orientation. If you allow your ROI view to be rotated, then in portrait view width will be smaller than height, whilst in landscape orientation width will be larger than height. This complies with view designer preview. If you choose not to rotate your ROI view, then your ROI view will be laid out either in portrait or landscape, depending on setting for your camera activity in AndroidManifest.xml

Note that scanning region only reflects to native code - it does not have any impact on user interface. You are required to create a matching user interface that will visualize the same scanning region you set here.

Parameters:

scanningRegion - Rectangle to define a scanning region or null to scan entire image.

rotateRegionWithDevice - If set to true, scanning region will be rotate when device changes orientation.

changeConfigurationInternal

protected void changeConfigurationInternal(android.content.res.Configuration newConfig)

Overrides:

changeConfigurationInternal in class CameraViewGroup

shouldRotateScanningRegion

public boolean shouldRotateScanningRegion()

Returns true if scanning region should be rotated with device.

Returns:

true if scanning region should be rotated with device.

getScanningRegion

public Rectangle getScanningRegion()

Returns the current scanning region or null if entire image is scanned.

Returns:

the current scanning region or null if entire image is scanned.

getNativeLibraryVersionString

public static java.lang.String getNativeLibraryVersionString()

Methods returns the version string of native library, if it has been loaded. If native library is not loaded, method returns string "native library not loaded".

Returns:

version string of native library

getRecognitionSettings

public RecognitionSettings getRecognitionSettings()

Returns the currently active generic settings that affect all recognizers and whole recognition process.

Returns:

the currently active generic settings that affect all recognizers and whole recognition process.

setRecognitionSettings

@UiThread
public void setRecognitionSettings(RecognitionSettings recognitionSettings)

Sets the generic settings that affect all recognizers and whole recognition process. This method must be called before calling create to have effect.

Parameters:

recognitionSettings - generic settings that affect all recognizers and whole recognition process.

setScanResultListener

@UiThread
public void setScanResultListener(@NonNull
                                            ScanResultListener scanResultListener)

Sets the listener that will obtain the results of the scanning. If you do not set this listener, scanner will not be able to work. This method must be called before calling create to have effect.

Parameters:

scanResultListener - listener that will obtain result of the scanning

setMetadataListener

@UiThread
public void setMetadataListener(MetadataListener metadataListener,
                                          MetadataSettings metadataSettings)

Sets the listener that will obtain metadata that is being processed. This method must be called before calling create to have effect.

Parameters:

metadataListener - listener that will obtain metadata that is being processed

getScanResultListener

public ScanResultListener getScanResultListener()

Returns the listener that will obtain the results of the scanning.

Returns:

the listener that will obtain the results of the scanning.