public class

ScannerFragment

extends Fragment
implements TextureView.SurfaceTextureListener

java.lang.Object
↳	android.app.Fragment
	↳	com.vuzix.sdk.barcode.ScannerFragment

Class Overview

ScannerFragment is an easy way to add barcode scanning functionality to your app. To use, follow these steps:

Obtain CAMERA permissions. ScannerFragment makes no attempt to request permissions on its own. Failure to obtain CAMERA permissions will cause scanning to fail.
Instantiate an instance of ScannerFragment.
Register a listener to receive barcode scanning results.
Use FragmentManager to add the fragment to your activity. For best results, add fragment should be added within a 16x9 container.

Summary

Nested Classes
interface	ScannerFragment.Listener	Interface for those who want to be notified when a barcode is identified.
interface	ScannerFragment.Listener2

Constants
String	ARG_BARCODE2_TYPES	A string array argument for specifying barcode types to scan for.
String	ARG_BARCODE_TYPES	This constant is deprecated. As of Scanner 2
String	ARG_LICENSE_KEY	This constant is deprecated. As of Scanner 2
String	ARG_SCANNING_RECT	A parcelable argument for specifying the scanning rect.
String	ARG_ZOOM_IN_MODE	A boolean argument for barcode run in zoom mode.

[Expand]

Inherited Constants

From interface android.content.ComponentCallbacks2

Public Constructors
	ScannerFragment()

Public Methods
void	onCreate(Bundle savedInstanceState)
View	onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
void	onStart()
void	onStop()
void	onSurfaceTextureAvailable(SurfaceTexture surface, int width, int height)
boolean	onSurfaceTextureDestroyed(SurfaceTexture surface)
void	onSurfaceTextureSizeChanged(SurfaceTexture surface, int width, int height)
void	onSurfaceTextureUpdated(SurfaceTexture surface)
void	setListener(ScannerFragment.Listener listener) This method is deprecated. As of Scanner 2
void	setListener2(ScannerFragment.Listener2 listener) Register a callback to be invoked when a barcode is located or an error occurs.

[Expand]

Inherited Methods

From class android.app.Fragment

void	dump(String arg0, FileDescriptor arg1, PrintWriter arg2, String[] arg3)
final boolean	equals(Object arg0)
final Activity	getActivity()
boolean	getAllowEnterTransitionOverlap()
boolean	getAllowReturnTransitionOverlap()
final Bundle	getArguments()
final FragmentManager	getChildFragmentManager()
Context	getContext()
Transition	getEnterTransition()
Transition	getExitTransition()
final FragmentManager	getFragmentManager()
final Object	getHost()
final int	getId()
final LayoutInflater	getLayoutInflater()
LoaderManager	getLoaderManager()
final Fragment	getParentFragment()
Transition	getReenterTransition()
final Resources	getResources()
final boolean	getRetainInstance()
Transition	getReturnTransition()
Transition	getSharedElementEnterTransition()
Transition	getSharedElementReturnTransition()
final String	getString(int arg0, Object... arg1)
final String	getString(int arg0)
final String	getTag()
final Fragment	getTargetFragment()
final int	getTargetRequestCode()
final CharSequence	getText(int arg0)
boolean	getUserVisibleHint()
View	getView()
final int	hashCode()
static Fragment	instantiate(Context arg0, String arg1)
static Fragment	instantiate(Context arg0, String arg1, Bundle arg2)
final boolean	isAdded()
final boolean	isDetached()
final boolean	isHidden()
final boolean	isInLayout()
final boolean	isRemoving()
final boolean	isResumed()
final boolean	isStateSaved()
final boolean	isVisible()
void	onActivityCreated(Bundle arg0)
void	onActivityResult(int arg0, int arg1, Intent arg2)
void	onAttach(Activity arg0)
void	onAttach(Context arg0)
void	onAttachFragment(Fragment arg0)
void	onConfigurationChanged(Configuration arg0)
boolean	onContextItemSelected(MenuItem arg0)
void	onCreate(Bundle arg0)
Animator	onCreateAnimator(int arg0, boolean arg1, int arg2)
void	onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)
void	onCreateOptionsMenu(Menu arg0, MenuInflater arg1)
View	onCreateView(LayoutInflater arg0, ViewGroup arg1, Bundle arg2)
void	onDestroy()
void	onDestroyOptionsMenu()
void	onDestroyView()
void	onDetach()
LayoutInflater	onGetLayoutInflater(Bundle arg0)
void	onHiddenChanged(boolean arg0)
void	onInflate(AttributeSet arg0, Bundle arg1)
void	onInflate(Activity arg0, AttributeSet arg1, Bundle arg2)
void	onInflate(Context arg0, AttributeSet arg1, Bundle arg2)
void	onLowMemory()
void	onMultiWindowModeChanged(boolean arg0)
void	onMultiWindowModeChanged(boolean arg0, Configuration arg1)
boolean	onOptionsItemSelected(MenuItem arg0)
void	onOptionsMenuClosed(Menu arg0)
void	onPause()
void	onPictureInPictureModeChanged(boolean arg0, Configuration arg1)
void	onPictureInPictureModeChanged(boolean arg0)
void	onPrepareOptionsMenu(Menu arg0)
void	onRequestPermissionsResult(int arg0, String[] arg1, int[] arg2)
void	onResume()
void	onSaveInstanceState(Bundle arg0)
void	onStart()
void	onStop()
void	onTrimMemory(int arg0)
void	onViewCreated(View arg0, Bundle arg1)
void	onViewStateRestored(Bundle arg0)
void	postponeEnterTransition()
void	registerForContextMenu(View arg0)
final void	requestPermissions(String[] arg0, int arg1)
void	setAllowEnterTransitionOverlap(boolean arg0)
void	setAllowReturnTransitionOverlap(boolean arg0)
void	setArguments(Bundle arg0)
void	setEnterSharedElementCallback(SharedElementCallback arg0)
void	setEnterTransition(Transition arg0)
void	setExitSharedElementCallback(SharedElementCallback arg0)
void	setExitTransition(Transition arg0)
void	setHasOptionsMenu(boolean arg0)
void	setInitialSavedState(Fragment.SavedState arg0)
void	setMenuVisibility(boolean arg0)
void	setReenterTransition(Transition arg0)
void	setRetainInstance(boolean arg0)
void	setReturnTransition(Transition arg0)
void	setSharedElementEnterTransition(Transition arg0)
void	setSharedElementReturnTransition(Transition arg0)
void	setTargetFragment(Fragment arg0, int arg1)
void	setUserVisibleHint(boolean arg0)
boolean	shouldShowRequestPermissionRationale(String arg0)
void	startActivity(Intent arg0)
void	startActivity(Intent arg0, Bundle arg1)
void	startActivityForResult(Intent arg0, int arg1)
void	startActivityForResult(Intent arg0, int arg1, Bundle arg2)
void	startActivityForResultAsUser(Intent arg0, int arg1, Bundle arg2, UserHandle arg3)
void	startIntentSenderForResult(IntentSender arg0, int arg1, Intent arg2, int arg3, int arg4, int arg5, Bundle arg6)
void	startPostponedEnterTransition()
String	toString()
void	unregisterForContextMenu(View arg0)

From class java.lang.Object

From interface android.content.ComponentCallbacks2

From interface android.view.View.OnCreateContextMenuListener

From interface android.view.TextureView.SurfaceTextureListener

From interface android.content.ComponentCallbacks

Constants

public static final String ARG_BARCODE2_TYPES

A string array argument for specifying barcode types to scan for. Each string should be the name() of a BarcodeType2. For example:

arguments.putStringArray(ScannerFragment.ARG_BARCODE2_TYPES, new String[] {BarcodeType2.QR.name(), BarcodeType2.QR_MICRO.name()});

Constant Value: "barcode2_types"

public static final String ARG_BARCODE_TYPES

This constant is deprecated.
As of Scanner 2

A string array argument for specifying barcode types to scan for. Each string should be the name() of a BarcodeType. For example:

arguments.putStringArray(ScannerFragment.ARG_BARCODE_TYPES, new String[] {BarcodeType.QR.name(), BarcodeType.QR_MICRO.name()});

Constant Value: "barcode_types"

public static final String ARG_LICENSE_KEY

This constant is deprecated.
As of Scanner 2

A string argument for specifying a custom license key.

Constant Value: "license_key"

public static final String ARG_SCANNING_RECT

A parcelable argument for specifying the scanning rect. For example:

arguments.putParcelable(ScannerFragment.ARG_SCANNING_RECT, new ScanningRect(.5f, .5f));

Constant Value: "scanning_rect"

public static final String ARG_ZOOM_IN_MODE

A boolean argument for barcode run in zoom mode. For example:

arguments.putBoolean(ScannerFragment.ARG_ZOOM_MODE, true);

Constant Value: "zoom_in_mode"

Public Constructors

public ScannerFragment ()

Public Methods

public void onCreate (Bundle savedInstanceState)

Parameters
`savedInstanceState`	`Bundle`

public View onCreateView (LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

Parameters
`inflater`	`LayoutInflater`
`container`	`ViewGroup`
`savedInstanceState`	`Bundle`

Returns
`View`

public void onStart ()

public void onStop ()

public void onSurfaceTextureAvailable (SurfaceTexture surface, int width, int height)

Parameters
`surface`	`SurfaceTexture`
`width`	`int`
`height`	`int`

public boolean onSurfaceTextureDestroyed (SurfaceTexture surface)

Parameters
`surface`	`SurfaceTexture`

Returns
`boolean`

public void onSurfaceTextureSizeChanged (SurfaceTexture surface, int width, int height)

Parameters
`surface`	`SurfaceTexture`
`width`	`int`
`height`	`int`

public void onSurfaceTextureUpdated (SurfaceTexture surface)

Parameters
`surface`	`SurfaceTexture`

public void setListener (ScannerFragment.Listener listener)

This method is deprecated.
As of Scanner 2

Register a callback to be invoked when a barcode is located or an error occurs. To remove yourself as a listener, set the listener to null.

Parameters
`listener`	`ScannerFragment.Listener`: a ScannerFragment.Listener

public void setListener2 (ScannerFragment.Listener2 listener)