BaseScanActivity (LibPdf417Mobi API)

java.lang.Object
- android.content.Context
- - android.content.ContextWrapper
  - - android.view.ContextThemeWrapper
    - - android.app.Activity
      - com.microblink.activity.BaseScanActivity

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2, android.view.KeyEvent.Callback, android.view.LayoutInflater.Factory, android.view.LayoutInflater.Factory2, android.view.View.OnCreateContextMenuListener, android.view.Window.Callback, AutofocusListener, MetadataListener, CameraEventsListener, OnActivityFlipListener, OnSizeChangedListener, OrientationAllowedListener, ScanResultListener

Direct Known Subclasses:

Pdf417ScanActivity
```
public abstract class BaseScanActivity
extends android.app.Activity
implements MetadataListener, OrientationAllowedListener, OnSizeChangedListener, CameraEventsListener, ScanResultListener, OnActivityFlipListener
```
Created by dodo on 15/10/14.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`EXTRAS_ALLOW_PINCH_TO_ZOOM` Whether pinch to zoom will be allowed (default is false)
`static java.lang.String`	`EXTRAS_BEEP_RESOURCE` Resource ID of sound which is to be played after finishing the scan procedure
`static java.lang.String`	`EXTRAS_CAMERA_ASPECT_MODE` Aspect mode of camera to be used (fill screen by cropping frame or fit by letterboxing
`static java.lang.String`	`EXTRAS_CAMERA_TYPE` Type of camera to be used (back facing, front facing, default)
`static java.lang.String`	`EXTRAS_CAMERA_VIDEO_PRESET` Request usage of maximum possible camera resolution for performing a scan.
`static java.lang.String`	`EXTRAS_HELP_INTENT` Help activity called when help should be shown
`static java.lang.String`	`EXTRAS_IMAGE_LISTENER` Define an `ImageListener` that will obtain images that are being processed.
`static java.lang.String`	`EXTRAS_IMAGE_METADATA_SETTINGS` Define a `MetadataSettings.ImageMetadataSettings` that will define which images will be sent to `ImageListener` set via `EXTRAS_IMAGE_LISTENER` extra.
`static java.lang.String`	`EXTRAS_LICENSE_KEY` Key for setting the license key
`static java.lang.String`	`EXTRAS_LICENSEE` Key for setting the license owner
`static java.lang.String`	`EXTRAS_OPTIMIZE_CAMERA_FOR_NEAR_SCANNING` Flag which indicates mb should optimize camera parameters for near object scanning.
`static java.lang.String`	`EXTRAS_RECOGNITION_RESULTS` Recognition results after recognition
`static java.lang.String`	`EXTRAS_RECOGNITION_SETTINGS` Key for setting the settings object used to initialize recognizer
`static java.lang.String`	`EXTRAS_ROI` Key for setting region of interest that will be scanned
`static java.lang.String`	`EXTRAS_ROTATE_ROI` Key for defining whether region of interest will be rotated with user interface
`static java.lang.String`	`EXTRAS_SET_FLAG_SECURE` Request setting of FLAG_SECURE on activity window which indicates that the display has a secure video output and supports compositing secure surfaces.
`static java.lang.String`	`EXTRAS_SHOW_FOCUS_RECTANGLE` Whether focus area rectangle will be shown
`static java.lang.String`	`EXTRAS_SPLASH_SCREEN_LAYOUT_RESOURCE` Defines the ID of the layout resource that will be used as camera splash screen displayed while camera is being initialized.
`static java.lang.String`	`EXTRAS_USE_LEGACY_CAMERA_API` Force using legacy Camera API even on Lollipop devices that support new Camera2 API.
`protected android.widget.Button`	`mBackButton` This is a back button
`protected android.widget.TextView`	`mDebugStatus` This text field contains debug status messages
`protected android.os.Handler`	`mHandler`
`protected android.widget.Button`	`mHelpButton` This is a help button
`protected android.content.Intent`	`mHelpIntent` Intent which shows the help activity
`protected ImageListener`	`mImageListener`
`protected android.view.ViewGroup`	`mLayout`
`protected MetadataSettings`	`mMetadataSettings`
`protected PointSetView`	`mPointSetView`
`protected QuadViewManager`	`mQuadViewManager` Actual viewfinder that draws animations
`protected RecognitionSettings`	`mRecognitionSettings`
`protected SimpleRectangleView`	`mRectView`
`protected boolean`	`mShowFocusRectangle`
`protected android.widget.TextView`	`mStatusTextView` This is a text field that contains status messages
`protected android.widget.Button`	`mTorchButton` This is a torch control button

Fields inherited from class android.app.Activity
DEFAULT_KEYS_DIALER, DEFAULT_KEYS_DISABLE, DEFAULT_KEYS_SEARCH_GLOBAL, DEFAULT_KEYS_SEARCH_LOCAL, DEFAULT_KEYS_SHORTCUT, FOCUSED_STATE_SET, RESULT_CANCELED, RESULT_FIRST_USER, RESULT_OK

Fields inherited from class android.content.Context
ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, APP_OPS_SERVICE, APPWIDGET_SERVICE, AUDIO_SERVICE, BATTERY_SERVICE, BIND_ABOVE_CLIENT, BIND_ADJUST_WITH_ACTIVITY, BIND_ALLOW_OOM_MANAGEMENT, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_EXTERNAL_SERVICE, BIND_IMPORTANT, BIND_NOT_FOREGROUND, BIND_WAIVE_PRIORITY, BLUETOOTH_SERVICE, CAMERA_SERVICE, CAPTIONING_SERVICE, CARRIER_CONFIG_SERVICE, CLIPBOARD_SERVICE, CONNECTIVITY_SERVICE, CONSUMER_IR_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, DEVICE_POLICY_SERVICE, DISPLAY_SERVICE, DOWNLOAD_SERVICE, DROPBOX_SERVICE, FINGERPRINT_SERVICE, HARDWARE_PROPERTIES_SERVICE, INPUT_METHOD_SERVICE, INPUT_SERVICE, JOB_SCHEDULER_SERVICE, KEYGUARD_SERVICE, LAUNCHER_APPS_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MEDIA_PROJECTION_SERVICE, MEDIA_ROUTER_SERVICE, MEDIA_SESSION_SERVICE, MIDI_SERVICE, MODE_APPEND, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_MULTI_PROCESS, MODE_NO_LOCALIZED_COLLATORS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NETWORK_STATS_SERVICE, NFC_SERVICE, NOTIFICATION_SERVICE, NSD_SERVICE, POWER_SERVICE, PRINT_SERVICE, RESTRICTIONS_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, SHORTCUT_SERVICE, STORAGE_SERVICE, SYSTEM_HEALTH_SERVICE, TELECOM_SERVICE, TELEPHONY_SERVICE, TELEPHONY_SUBSCRIPTION_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, TV_INPUT_SERVICE, UI_MODE_SERVICE, USAGE_STATS_SERVICE, USB_SERVICE, USER_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WINDOW_SERVICE

Fields inherited from interface android.content.ComponentCallbacks2
TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors
Constructor and Description

BaseScanActivity()

Constructors
Constructor and Description
`BaseScanActivity()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`addChildViews(RecognizerView recognizerView)`
`protected void`	`addChildViews(RecognizerView recognizerView, int viewfinderId)` adds fixed and rotatable views to given mbView
`protected PointSetView`	`createPointSetView(RecognizerView recognizerView)`
`protected QuadViewManager`	`createQuadView(RecognizerView recognizerView)`
`protected RecognizerView`	`createRecognizerView(android.os.Bundle intentExtras)`
`protected void`	`displayDetectionStatus(DetectionStatus detectionStatus)`
`protected void`	`displayMessageImmediately(java.lang.CharSequence text)`
`protected void`	`finishAndWaitForAnimation()`
`protected Orientation`	`getDefaultOrientation()` Method returns the default status messages orientation for given settings.
`protected RecognizerView`	`getRecognizerView()`
`protected void`	`initDebugStatus()`
`boolean`	`isFinishing()`
`boolean`	`isOrientationAllowed(Orientation orientation)` Called in onOrientationChange.
`void`	`onActivityFlip()` Called when activity is flipped.
`void`	`onAutofocusFailed()` This method will be called when camera focusing has failed.
`void`	`onAutofocusStarted(android.graphics.Rect[] areas)` This method will be called when camera focusing has started.
`void`	`onAutofocusStopped(android.graphics.Rect[] areas)` This method will be called when camera focusing has stopped.
`void`	`onCameraPermissionDenied()` Called on Android 6.0 and newer when runtime camera permission was not given to the app.
`void`	`onCameraPreviewStarted()` Called just after camera preview has successfully started and no exceptions occurred.
`void`	`onCameraPreviewStopped()` Called inside pause method of CameraView just haver camera preview has been stopped.
`void`	`onConfigurationChanged(android.content.res.Configuration newConfig)`
`protected abstract void`	`onConfigureRecognizerView(RecognizerView recognizerView, android.os.Bundle intentExtras)`
`protected void`	`onCreate(android.os.Bundle savedInstanceState)`
`protected void`	`onDestroy()`
`protected void`	`onDetectorResultAvailable(DetectorResult detectorResult)`
`void`	`onError(java.lang.Throwable exc)` Called when recognition results with exception.
`void`	`onMetadataAvailable(Metadata metadata)`
`protected void`	`onPause()`
`void`	`onRequestPermissionsResult(int requestCode, java.lang.String[] permissions, int[] grantResults)`
`protected void`	`onResume()`
`void`	`onScanningDone(RecognitionResults results)` This method is called when recognition is done.
`void`	`onSizeChanged(int width, int height)` Called when CameraView changes the size of itself and its children.
`protected void`	`onStart()`
`protected void`	`onStop()`
`protected void`	`postDisplayMessage(java.lang.CharSequence text)`
`protected void`	`setHelpButtonEnabled(boolean enabled)`
`protected void`	`soundNotification()` plays beep

Methods inherited from class android.app.Activity
addContentView, closeContextMenu, closeOptionsMenu, createPendingResult, dismissDialog, dismissKeyboardShortcutsHelper, dispatchGenericMotionEvent, dispatchKeyEvent, dispatchKeyShortcutEvent, dispatchPopulateAccessibilityEvent, dispatchTouchEvent, dispatchTrackballEvent, dump, enterPictureInPictureMode, findViewById, finish, finishActivity, finishActivityFromChild, finishAffinity, finishAfterTransition, finishAndRemoveTask, finishFromChild, getActionBar, getApplication, getCallingActivity, getCallingPackage, getChangingConfigurations, getComponentName, getContentScene, getContentTransitionManager, getCurrentFocus, getFragmentManager, getIntent, getLastNonConfigurationInstance, getLayoutInflater, getLoaderManager, getLocalClassName, getMediaController, getMenuInflater, getParent, getParentActivityIntent, getPreferences, getReferrer, getRequestedOrientation, getSearchEvent, getSystemService, getTaskId, getTitle, getTitleColor, getVoiceInteractor, getVolumeControlStream, getWindow, getWindowManager, hasWindowFocus, invalidateOptionsMenu, isChangingConfigurations, isChild, isDestroyed, isImmersive, isInMultiWindowMode, isInPictureInPictureMode, isLocalVoiceInteractionSupported, isTaskRoot, isVoiceInteraction, isVoiceInteractionRoot, managedQuery, moveTaskToBack, navigateUpTo, navigateUpToFromChild, onActionModeFinished, onActionModeStarted, onActivityReenter, onActivityResult, onApplyThemeResource, onAttachedToWindow, onAttachFragment, onBackPressed, onChildTitleChanged, onContentChanged, onContextItemSelected, onContextMenuClosed, onCreate, onCreateContextMenu, onCreateDescription, onCreateDialog, onCreateDialog, onCreateNavigateUpTaskStack, onCreateOptionsMenu, onCreatePanelMenu, onCreatePanelView, onCreateThumbnail, onCreateView, onCreateView, onDetachedFromWindow, onEnterAnimationComplete, onGenericMotionEvent, onKeyDown, onKeyLongPress, onKeyMultiple, onKeyShortcut, onKeyUp, onLocalVoiceInteractionStarted, onLocalVoiceInteractionStopped, onLowMemory, onMenuItemSelected, onMenuOpened, onMultiWindowModeChanged, onNavigateUp, onNavigateUpFromChild, onNewIntent, onOptionsItemSelected, onOptionsMenuClosed, onPanelClosed, onPictureInPictureModeChanged, onPostCreate, onPostCreate, onPostResume, onPrepareDialog, onPrepareDialog, onPrepareNavigateUpTaskStack, onPrepareOptionsMenu, onPreparePanel, onProvideAssistContent, onProvideAssistData, onProvideKeyboardShortcuts, onProvideReferrer, onRestart, onRestoreInstanceState, onRestoreInstanceState, onRetainNonConfigurationInstance, onSaveInstanceState, onSaveInstanceState, onSearchRequested, onSearchRequested, onStateNotSaved, onTitleChanged, onTouchEvent, onTrackballEvent, onTrimMemory, onUserInteraction, onUserLeaveHint, onVisibleBehindCanceled, onWindowAttributesChanged, onWindowFocusChanged, onWindowStartingActionMode, onWindowStartingActionMode, openContextMenu, openOptionsMenu, overridePendingTransition, postponeEnterTransition, recreate, registerForContextMenu, releaseInstance, removeDialog, reportFullyDrawn, requestDragAndDropPermissions, requestPermissions, requestShowKeyboardShortcuts, requestVisibleBehind, requestWindowFeature, runOnUiThread, setActionBar, setContentTransitionManager, setContentView, setContentView, setContentView, setDefaultKeyMode, setEnterSharedElementCallback, setExitSharedElementCallback, setFeatureDrawable, setFeatureDrawableAlpha, setFeatureDrawableResource, setFeatureDrawableUri, setFinishOnTouchOutside, setImmersive, setIntent, setMediaController, setProgress, setProgressBarIndeterminate, setProgressBarIndeterminateVisibility, setProgressBarVisibility, setRequestedOrientation, setResult, setResult, setSecondaryProgress, setTaskDescription, setTheme, setTitle, setTitle, setTitleColor, setVisible, setVolumeControlStream, setVrModeEnabled, shouldShowRequestPermissionRationale, shouldUpRecreateTask, showAssist, showDialog, showDialog, showLockTaskEscapeMessage, startActionMode, startActionMode, startActivities, startActivities, startActivity, startActivity, startActivityForResult, startActivityForResult, startActivityFromChild, startActivityFromChild, startActivityFromFragment, startActivityFromFragment, startActivityIfNeeded, startActivityIfNeeded, startIntentSender, startIntentSender, startIntentSenderForResult, startIntentSenderForResult, startIntentSenderFromChild, startIntentSenderFromChild, startLocalVoiceInteraction, startLockTask, startManagingCursor, startNextMatchingActivity, startNextMatchingActivity, startPostponedEnterTransition, startSearch, stopLocalVoiceInteraction, stopLockTask, stopManagingCursor, takeKeyEvents, triggerSearch, unregisterForContextMenu

Methods inherited from class android.view.ContextThemeWrapper
applyOverrideConfiguration, attachBaseContext, getAssets, getResources, getTheme

Methods inherited from class android.content.ContextWrapper
bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkSelfPermission, checkUriPermission, checkUriPermission, clearWallpaper, createConfigurationContext, createDeviceProtectedStorageContext, createDisplayContext, createPackageContext, databaseList, deleteDatabase, deleteFile, deleteSharedPreferences, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getBaseContext, getCacheDir, getClassLoader, getCodeCacheDir, getContentResolver, getDatabasePath, getDataDir, getDir, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getFileStreamPath, getMainLooper, getNoBackupFilesDir, getObbDir, getObbDirs, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getSharedPreferences, getSystemServiceName, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isDeviceProtectedStorage, isRestricted, moveDatabaseFrom, moveSharedPreferencesFrom, openFileInput, openFileOutput, openOrCreateDatabase, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, removeStickyBroadcast, removeStickyBroadcastAsUser, revokeUriPermission, sendBroadcast, sendBroadcast, sendBroadcastAsUser, sendBroadcastAsUser, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcastAsUser, sendStickyBroadcast, sendStickyBroadcastAsUser, sendStickyOrderedBroadcast, sendStickyOrderedBroadcastAsUser, setWallpaper, setWallpaper, startInstrumentation, startService, stopService, unbindService, unregisterReceiver

Methods inherited from class android.content.Context
getColor, getColorStateList, getDrawable, getString, getString, getSystemService, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, registerComponentCallbacks, unregisterComponentCallbacks

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXTRAS_CAMERA_TYPE
```
public static final java.lang.String EXTRAS_CAMERA_TYPE
```
    Type of camera to be used (back facing, front facing, default)
    
    See Also:
    
    Constant Field Values
  - EXTRAS_CAMERA_ASPECT_MODE
```
public static final java.lang.String EXTRAS_CAMERA_ASPECT_MODE
```
    Aspect mode of camera to be used (fill screen by cropping frame or fit by letterboxing
    
    See Also:
    
    Constant Field Values
  - EXTRAS_HELP_INTENT
```
public static final java.lang.String EXTRAS_HELP_INTENT
```
    Help activity called when help should be shown
    
    See Also:
    
    Constant Field Values
  - EXTRAS_LICENSE_KEY
```
public static final java.lang.String EXTRAS_LICENSE_KEY
```
    Key for setting the license key
    
    See Also:
    
    Constant Field Values
  - EXTRAS_LICENSEE
```
public static final java.lang.String EXTRAS_LICENSEE
```
    Key for setting the license owner
    
    See Also:
    
    Constant Field Values
  - EXTRAS_RECOGNITION_SETTINGS
```
public static final java.lang.String EXTRAS_RECOGNITION_SETTINGS
```
    Key for setting the settings object used to initialize recognizer
    
    See Also:
    
    Constant Field Values
  - EXTRAS_ROI
```
public static final java.lang.String EXTRAS_ROI
```
    Key for setting region of interest that will be scanned
    
    See Also:
    
    Constant Field Values
  - EXTRAS_ROTATE_ROI
```
public static final java.lang.String EXTRAS_ROTATE_ROI
```
    Key for defining whether region of interest will be rotated with user interface
    
    See Also:
    
    Constant Field Values
  - EXTRAS_RECOGNITION_RESULTS
```
public static final java.lang.String EXTRAS_RECOGNITION_RESULTS
```
    Recognition results after recognition
    
    See Also:
    
    Constant Field Values
  - EXTRAS_SHOW_FOCUS_RECTANGLE
```
public static final java.lang.String EXTRAS_SHOW_FOCUS_RECTANGLE
```
    Whether focus area rectangle will be shown
    
    See Also:
    
    Constant Field Values
  - EXTRAS_ALLOW_PINCH_TO_ZOOM
```
public static final java.lang.String EXTRAS_ALLOW_PINCH_TO_ZOOM
```
    Whether pinch to zoom will be allowed (default is false)
    
    See Also:
    
    Constant Field Values
  - EXTRAS_BEEP_RESOURCE
```
public static final java.lang.String EXTRAS_BEEP_RESOURCE
```
    Resource ID of sound which is to be played after finishing the scan procedure
    
    See Also:
    
    Constant Field Values
  - EXTRAS_SPLASH_SCREEN_LAYOUT_RESOURCE
```
public static final java.lang.String EXTRAS_SPLASH_SCREEN_LAYOUT_RESOURCE
```
    Defines the ID of the layout resource that will be used as camera splash screen displayed while camera is being initialized. If not set, default splash screen will be used.
    
    See Also:
    
    Constant Field Values
  - EXTRAS_OPTIMIZE_CAMERA_FOR_NEAR_SCANNING
```
public static final java.lang.String EXTRAS_OPTIMIZE_CAMERA_FOR_NEAR_SCANNING
```
    Flag which indicates mb should optimize camera parameters for near object scanning. When camera parameters are optimized for near object scanning, macro focus mode will be preferred over autofocus mode. Thus, camera will have easier time focusing on to near objects, but might have harder time focusing on far objects. If you expect that most of your scans will be performed by holding the device very near the object, turn on that parameter. By default, this parameter is set to false, except in cases when from other settings it can be safely concluded that it is better to turn it on.
    
    See Also:
    
    Constant Field Values
  - EXTRAS_IMAGE_LISTENER
```
public static final java.lang.String EXTRAS_IMAGE_LISTENER
```
    Define an ImageListener that will obtain images that are being processed. Make sure that your ImageListener implementation correctly implements Parcelable interface with static CREATOR field. Without this, you might encounter a runtime error.
    
    See Also:
    
    Constant Field Values
  - EXTRAS_IMAGE_METADATA_SETTINGS
```
public static final java.lang.String EXTRAS_IMAGE_METADATA_SETTINGS
```
    Define a MetadataSettings.ImageMetadataSettings that will define which images will be sent to ImageListener set via EXTRAS_IMAGE_LISTENER extra. If not set, ImageListener set via EXTRAS_IMAGE_LISTENER will receive all possible images.
    
    See Also:
    
    Constant Field Values
  - EXTRAS_CAMERA_VIDEO_PRESET
```
public static final java.lang.String EXTRAS_CAMERA_VIDEO_PRESET
```
    Request usage of maximum possible camera resolution for performing a scan. Note that using maximum possible resolution might result in poor performance.
    Request video resolution preset to be used when choosing camera resolution for performing a scan. Note that using maximum possible resolution might result in poor performance and using lowest possible resolution (480p) will result in low scan quality.
    
    See Also:
    
    Constant Field Values
  - EXTRAS_USE_LEGACY_CAMERA_API
```
public static final java.lang.String EXTRAS_USE_LEGACY_CAMERA_API
```
    Force using legacy Camera API even on Lollipop devices that support new Camera2 API. Use this only if you have problems with camera management on Lollipop devices.
    
    See Also:
    
    Constant Field Values
  - EXTRAS_SET_FLAG_SECURE
```
public static final java.lang.String EXTRAS_SET_FLAG_SECURE
```
    Request setting of FLAG_SECURE on activity window which indicates that the display has a secure video output and supports compositing secure surfaces. Use this to prevent taking screenshots of activity window content and to prevent content from being viewed on non-secure displays.
    
    See Also:
    
    Constant Field Values
  - mHelpIntent
```
protected android.content.Intent mHelpIntent
```
    Intent which shows the help activity
  - mLayout
```
protected android.view.ViewGroup mLayout
```
  - mHelpButton
```
protected android.widget.Button mHelpButton
```
    This is a help button
  - mBackButton
```
protected android.widget.Button mBackButton
```
    This is a back button
  - mTorchButton
```
protected android.widget.Button mTorchButton
```
    This is a torch control button
  - mStatusTextView
```
protected android.widget.TextView mStatusTextView
```
    This is a text field that contains status messages
  - mDebugStatus
```
protected android.widget.TextView mDebugStatus
```
    This text field contains debug status messages
  - mQuadViewManager
```
protected QuadViewManager mQuadViewManager
```
    Actual viewfinder that draws animations
  - mPointSetView
```
protected PointSetView mPointSetView
```
  - mHandler
```
protected android.os.Handler mHandler
```
  - mRectView
```
protected SimpleRectangleView mRectView
```
  - mShowFocusRectangle
```
protected boolean mShowFocusRectangle
```
  - mRecognitionSettings
```
protected RecognitionSettings mRecognitionSettings
```
  - mImageListener
```
protected ImageListener mImageListener
```
  - mMetadataSettings
```
protected MetadataSettings mMetadataSettings
```
- Constructor Detail
  - BaseScanActivity
```
public BaseScanActivity()
```
- Method Detail
  - onCreate
```
protected final void onCreate(android.os.Bundle savedInstanceState)
```
    Overrides:
    
    onCreate in class android.app.Activity
  - initDebugStatus
```
protected void initDebugStatus()
```
  - soundNotification
```
protected void soundNotification()
```
    plays beep
  - onStart
```
protected final void onStart()
```
    Overrides:
    
    onStart in class android.app.Activity
  - onRequestPermissionsResult
```
public void onRequestPermissionsResult(int requestCode,
                                       java.lang.String[] permissions,
                                       int[] grantResults)
```
    Overrides:
    
    onRequestPermissionsResult in class android.app.Activity
  - onResume
```
protected final void onResume()
```
    Overrides:
    
    onResume in class android.app.Activity
  - onPause
```
protected final void onPause()
```
    Overrides:
    
    onPause in class android.app.Activity
  - onStop
```
protected final void onStop()
```
    Overrides:
    
    onStop in class android.app.Activity
  - onConfigurationChanged
```
public void onConfigurationChanged(android.content.res.Configuration newConfig)
```
    Specified by:
    
    onConfigurationChanged in interface android.content.ComponentCallbacks
    
    Overrides:
    
    onConfigurationChanged in class android.app.Activity
  - onActivityFlip
```
public void onActivityFlip()
```
    Description copied from interface: OnActivityFlipListener
    
    Called when activity is flipped. This can happen if your activity is in sensor or user orientation mode and landscape to reverse landscape or portrait to reverse portrait or vice versa orientation change has occurred. Normally, Android will not give you any notification when this orientation change occurs, so SDK automatically detects that and with this listener informs you of such event.
    
    Specified by:
    
    onActivityFlip in interface OnActivityFlipListener
  - onDestroy
```
protected final void onDestroy()
```
    Overrides:
    
    onDestroy in class android.app.Activity
  - createQuadView
```
protected QuadViewManager createQuadView(RecognizerView recognizerView)
```
  - createPointSetView
```
protected PointSetView createPointSetView(RecognizerView recognizerView)
```
  - addChildViews
```
protected void addChildViews(RecognizerView recognizerView,
                             int viewfinderId)
```
    adds fixed and rotatable views to given mbView
    
    Parameters:
    
    recognizerView -
  - addChildViews
```
protected abstract void addChildViews(RecognizerView recognizerView)
```
  - postDisplayMessage
```
protected void postDisplayMessage(java.lang.CharSequence text)
```
  - displayMessageImmediately
```
protected void displayMessageImmediately(java.lang.CharSequence text)
```
  - finishAndWaitForAnimation
```
protected void finishAndWaitForAnimation()
```
  - isFinishing
```
public boolean isFinishing()
```
    Overrides:
    
    isFinishing in class android.app.Activity
  - isOrientationAllowed
```
public boolean isOrientationAllowed(Orientation orientation)
```
    Description copied from interface: OrientationAllowedListener
    
    Called in onOrientationChange. Use it to determine if given orientation is allowed.
    
    Specified by:
    
    isOrientationAllowed in interface OrientationAllowedListener
    
    Parameters:
    
    orientation - Orientation of the device.
    
    Returns:
    
    true if orientation is allowed, otherwise false
  - setHelpButtonEnabled
```
protected void setHelpButtonEnabled(boolean enabled)
```
  - displayDetectionStatus
```
protected void displayDetectionStatus(DetectionStatus detectionStatus)
```
  - onMetadataAvailable
```
public void onMetadataAvailable(Metadata metadata)
```
    Specified by:
    
    onMetadataAvailable in interface MetadataListener
  - onDetectorResultAvailable
```
protected void onDetectorResultAvailable(DetectorResult detectorResult)
```
  - onAutofocusFailed
```
public void onAutofocusFailed()
```
    Description copied from interface: AutofocusListener
    
    This method will be called when camera focusing has failed. Camera manager usually tries different focusing strategies and this method is called when all those strategies fail to indicate that either object on which camera is being focused is too close or ambient light conditions are poor.
    
    Specified by:
    
    onAutofocusFailed in interface AutofocusListener
  - onAutofocusStopped
```
public void onAutofocusStopped(android.graphics.Rect[] areas)
```
    Description copied from interface: AutofocusListener
    
    This method will be called when camera focusing has stopped. You can utilize this method to remove focusing animation from UI.
    
    Specified by:
    
    onAutofocusStopped in interface AutofocusListener
    
    Parameters:
    
    areas - Areas where focus is being measured. Null on devices that do not support fine-grained camera control
  - onAutofocusStarted
```
public void onAutofocusStarted(android.graphics.Rect[] areas)
```
    Description copied from interface: AutofocusListener
    
    This method will be called when camera focusing has started. You can utilize this method to draw focusing animation on UI.
    
    Specified by:
    
    onAutofocusStarted in interface AutofocusListener
    
    Parameters:
    
    areas - Areas where focus is being measured. Null on devices that do not support fine-grained camera control
  - onCameraPermissionDenied
```
public void onCameraPermissionDenied()
```
    Description copied from interface: CameraEventsListener
    
    Called on Android 6.0 and newer when runtime camera permission was not given to the app. You should implement this callback by requesting camera permission from user.
    
    Specified by:
    
    onCameraPermissionDenied in interface CameraEventsListener
  - onSizeChanged
```
public void onSizeChanged(int width,
                          int height)
```
    Description copied from interface: OnSizeChangedListener
    
    Called when CameraView changes the size of itself and its children.
    
    Specified by:
    
    onSizeChanged in interface OnSizeChangedListener
    
    Parameters:
    
    width - New width of the view.
    
    height - New height of the view.
  - onCameraPreviewStarted
```
public void onCameraPreviewStarted()
```
    Description copied from interface: CameraEventsListener
    
    Called just after camera preview has successfully started and no exceptions occurred. When this method is called, it means that from now on, frames will arrive and preview will be shown.
    
    Specified by:
    
    onCameraPreviewStarted in interface CameraEventsListener
  - onCameraPreviewStopped
```
public void onCameraPreviewStopped()
```
    Description copied from interface: CameraEventsListener
    
    Called inside pause method of CameraView just haver camera preview has been stopped. After this method is called, frames will no longer arrive nor will be shown.
    
    Specified by:
    
    onCameraPreviewStopped in interface CameraEventsListener
  - onError
```
public void onError(java.lang.Throwable exc)
```
    Description copied from interface: CameraEventsListener
    
    Called when recognition results with exception. Known exceptions that can occur are following: * com.microblink.hardware.camera.CameraResolutionTooSmallException is thrown when largest possible camera preview resolution is not enough for making a successful scan * java.lang.UnsatisfiedLinkError is thrown when native library was not successfully loaded thus making scans impossible * com.microblink.recognition.RecognizerError is thrown when initialization or reinitialization of native recognizer fails * com.microblink.recognition.FeatureNotSupportedException is thrown when scanning cannot be performed. The reason why scanning cannot be perfomed can be obtained by calling getReason() method of thrown exception. * java.lang.Throwable is thrown in all other cases (for example when camera is not ready because it is used by other apps or some unknown error has occurred)
    
    Specified by:
    
    onError in interface CameraEventsListener
    
    Parameters:
    
    exc - Exception that occurred during recognition.
  - getRecognizerView
```
protected final RecognizerView getRecognizerView()
```
  - getDefaultOrientation
```
protected Orientation getDefaultOrientation()
```
    Method returns the default status messages orientation for given settings. Default orientation is determined from enabled recognizers.
    
    Returns:
    
    default orientation of the status messages
  - createRecognizerView
```
protected RecognizerView createRecognizerView(android.os.Bundle intentExtras)
```
  - onScanningDone
```
public void onScanningDone(RecognitionResults results)
```
    Description copied from interface: ScanResultListener
    
    This method is called when recognition is done.
    
    Specified by:
    
    onScanningDone in interface ScanResultListener
    
    Parameters:
    
    results - Recognition results.
  - onConfigureRecognizerView
```
protected abstract void onConfigureRecognizerView(RecognizerView recognizerView,
                                                  android.os.Bundle intentExtras)
```

Class BaseScanActivity

Field Summary

Fields inherited from class android.app.Activity

Fields inherited from class android.content.Context

Fields inherited from interface android.content.ComponentCallbacks2

Constructor Summary

Method Summary

Methods inherited from class android.app.Activity

Methods inherited from class android.view.ContextThemeWrapper

Methods inherited from class android.content.ContextWrapper

Methods inherited from class android.content.Context

Methods inherited from class java.lang.Object

Field Detail

EXTRAS_CAMERA_TYPE

EXTRAS_CAMERA_ASPECT_MODE

EXTRAS_HELP_INTENT

EXTRAS_LICENSE_KEY

EXTRAS_LICENSEE

EXTRAS_RECOGNITION_SETTINGS

EXTRAS_ROI

EXTRAS_ROTATE_ROI

EXTRAS_RECOGNITION_RESULTS

EXTRAS_SHOW_FOCUS_RECTANGLE

EXTRAS_ALLOW_PINCH_TO_ZOOM

EXTRAS_BEEP_RESOURCE

EXTRAS_SPLASH_SCREEN_LAYOUT_RESOURCE

EXTRAS_OPTIMIZE_CAMERA_FOR_NEAR_SCANNING

EXTRAS_IMAGE_LISTENER

EXTRAS_IMAGE_METADATA_SETTINGS

EXTRAS_CAMERA_VIDEO_PRESET

EXTRAS_USE_LEGACY_CAMERA_API

EXTRAS_SET_FLAG_SECURE

mHelpIntent

mLayout

mHelpButton

mBackButton

mTorchButton

mStatusTextView

mDebugStatus

mQuadViewManager

mPointSetView

mHandler

mRectView

mShowFocusRectangle

mRecognitionSettings

mImageListener

mMetadataSettings

Constructor Detail

BaseScanActivity

Method Detail

onCreate

initDebugStatus

soundNotification

onStart

onRequestPermissionsResult

onResume

onPause

onStop

onConfigurationChanged

onActivityFlip

onDestroy

createQuadView

createPointSetView

addChildViews

addChildViews

postDisplayMessage

displayMessageImmediately

finishAndWaitForAnimation

isFinishing

isOrientationAllowed

setHelpButtonEnabled

displayDetectionStatus

onMetadataAvailable

onDetectorResultAvailable

onAutofocusFailed

onAutofocusStopped

onAutofocusStarted

onCameraPermissionDenied

onSizeChanged

onCameraPreviewStarted