<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Reader (ZXing 3.5.1 API)</title> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="Reader (ZXing 3.5.1 API)"; } } catch(err) { } //--> var methods = {"i0":6,"i1":6,"i2":6}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/Reader.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../com/google/zxing/PlanarYUVLuminanceSource.html" title="class in com.google.zxing"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../com/google/zxing/ReaderException.html" title="class in com.google.zxing"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?com/google/zxing/Reader.html" target="_top">Frames</a></li> <li><a href="Reader.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">com.google.zxing</div> <h2 title="Interface Reader" class="title">Interface Reader</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Known Implementing Classes:</dt> <dd><a href="../../../com/google/zxing/oned/rss/AbstractRSSReader.html" title="class in com.google.zxing.oned.rss">AbstractRSSReader</a>, <a href="../../../com/google/zxing/aztec/AztecReader.html" title="class in com.google.zxing.aztec">AztecReader</a>, <a href="../../../com/google/zxing/multi/ByQuadrantReader.html" title="class in com.google.zxing.multi">ByQuadrantReader</a>, <a href="../../../com/google/zxing/oned/CodaBarReader.html" title="class in com.google.zxing.oned">CodaBarReader</a>, <a href="../../../com/google/zxing/oned/Code128Reader.html" title="class in com.google.zxing.oned">Code128Reader</a>, <a href="../../../com/google/zxing/oned/Code39Reader.html" title="class in com.google.zxing.oned">Code39Reader</a>, <a href="../../../com/google/zxing/oned/Code93Reader.html" title="class in com.google.zxing.oned">Code93Reader</a>, <a href="../../../com/google/zxing/datamatrix/DataMatrixReader.html" title="class in com.google.zxing.datamatrix">DataMatrixReader</a>, <a href="../../../com/google/zxing/oned/EAN13Reader.html" title="class in com.google.zxing.oned">EAN13Reader</a>, <a href="../../../com/google/zxing/oned/EAN8Reader.html" title="class in com.google.zxing.oned">EAN8Reader</a>, <a href="../../../com/google/zxing/oned/ITFReader.html" title="class in com.google.zxing.oned">ITFReader</a>, <a href="../../../com/google/zxing/maxicode/MaxiCodeReader.html" title="class in com.google.zxing.maxicode">MaxiCodeReader</a>, <a href="../../../com/google/zxing/oned/MultiFormatOneDReader.html" title="class in com.google.zxing.oned">MultiFormatOneDReader</a>, <a href="../../../com/google/zxing/MultiFormatReader.html" title="class in com.google.zxing">MultiFormatReader</a>, <a href="../../../com/google/zxing/oned/MultiFormatUPCEANReader.html" title="class in com.google.zxing.oned">MultiFormatUPCEANReader</a>, <a href="../../../com/google/zxing/oned/OneDReader.html" title="class in com.google.zxing.oned">OneDReader</a>, <a href="../../../com/google/zxing/pdf417/PDF417Reader.html" title="class in com.google.zxing.pdf417">PDF417Reader</a>, <a href="../../../com/google/zxing/multi/qrcode/QRCodeMultiReader.html" title="class in com.google.zxing.multi.qrcode">QRCodeMultiReader</a>, <a href="../../../com/google/zxing/qrcode/QRCodeReader.html" title="class in com.google.zxing.qrcode">QRCodeReader</a>, <a href="../../../com/google/zxing/oned/rss/RSS14Reader.html" title="class in com.google.zxing.oned.rss">RSS14Reader</a>, <a href="../../../com/google/zxing/oned/rss/expanded/RSSExpandedReader.html" title="class in com.google.zxing.oned.rss.expanded">RSSExpandedReader</a>, <a href="../../../com/google/zxing/oned/UPCAReader.html" title="class in com.google.zxing.oned">UPCAReader</a>, <a href="../../../com/google/zxing/oned/UPCEANReader.html" title="class in com.google.zxing.oned">UPCEANReader</a>, <a href="../../../com/google/zxing/oned/UPCEReader.html" title="class in com.google.zxing.oned">UPCEReader</a></dd> </dl> <hr> <br> <pre>public interface <span class="typeNameLabel">Reader</span></pre> <div class="block">Implementations of this interface can decode an image of a barcode in some format into the String it encodes. For example, <a href="../../../com/google/zxing/qrcode/QRCodeReader.html" title="class in com.google.zxing.qrcode"><code>QRCodeReader</code></a> can decode a QR code. The decoder may optionally receive hints from the caller which may help it decode more quickly or accurately. See <a href="../../../com/google/zxing/MultiFormatReader.html" title="class in com.google.zxing"><code>MultiFormatReader</code></a>, which attempts to determine what barcode format is present within the image as well, and then decodes it accordingly.</div> <dl> <dt><span class="simpleTagLabel">Author:</span></dt> <dd>Sean Owen, dswitkin@google.com (Daniel Switkin)</dd> </dl> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../../com/google/zxing/Result.html" title="class in com.google.zxing">Result</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/zxing/Reader.html#decode-com.google.zxing.BinaryBitmap-">decode</a></span>(<a href="../../../com/google/zxing/BinaryBitmap.html" title="class in com.google.zxing">BinaryBitmap</a> image)</code> <div class="block">Locates and decodes a barcode in some format within an image.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../../../com/google/zxing/Result.html" title="class in com.google.zxing">Result</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/zxing/Reader.html#decode-com.google.zxing.BinaryBitmap-java.util.Map-">decode</a></span>(<a href="../../../com/google/zxing/BinaryBitmap.html" title="class in com.google.zxing">BinaryBitmap</a> image, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../com/google/zxing/DecodeHintType.html" title="enum in com.google.zxing">DecodeHintType</a>,?> hints)</code> <div class="block">Locates and decodes a barcode in some format within an image.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/zxing/Reader.html#reset--">reset</a></span>()</code> <div class="block">Resets any internal state the implementation has after a decode, to prepare it for reuse.</div> </td> </tr> </table> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="decode-com.google.zxing.BinaryBitmap-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decode</h4> <pre><a href="../../../com/google/zxing/Result.html" title="class in com.google.zxing">Result</a> decode(<a href="../../../com/google/zxing/BinaryBitmap.html" title="class in com.google.zxing">BinaryBitmap</a> image) throws <a href="../../../com/google/zxing/NotFoundException.html" title="class in com.google.zxing">NotFoundException</a>, <a href="../../../com/google/zxing/ChecksumException.html" title="class in com.google.zxing">ChecksumException</a>, <a href="../../../com/google/zxing/FormatException.html" title="class in com.google.zxing">FormatException</a></pre> <div class="block">Locates and decodes a barcode in some format within an image.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>image</code> - image of barcode to decode</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>String which the barcode encodes</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../com/google/zxing/NotFoundException.html" title="class in com.google.zxing">NotFoundException</a></code> - if no potential barcode is found</dd> <dd><code><a href="../../../com/google/zxing/ChecksumException.html" title="class in com.google.zxing">ChecksumException</a></code> - if a potential barcode is found but does not pass its checksum</dd> <dd><code><a href="../../../com/google/zxing/FormatException.html" title="class in com.google.zxing">FormatException</a></code> - if a potential barcode is found but format is invalid</dd> </dl> </li> </ul> <a name="decode-com.google.zxing.BinaryBitmap-java.util.Map-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decode</h4> <pre><a href="../../../com/google/zxing/Result.html" title="class in com.google.zxing">Result</a> decode(<a href="../../../com/google/zxing/BinaryBitmap.html" title="class in com.google.zxing">BinaryBitmap</a> image, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../com/google/zxing/DecodeHintType.html" title="enum in com.google.zxing">DecodeHintType</a>,?> hints) throws <a href="../../../com/google/zxing/NotFoundException.html" title="class in com.google.zxing">NotFoundException</a>, <a href="../../../com/google/zxing/ChecksumException.html" title="class in com.google.zxing">ChecksumException</a>, <a href="../../../com/google/zxing/FormatException.html" title="class in com.google.zxing">FormatException</a></pre> <div class="block">Locates and decodes a barcode in some format within an image. This method also accepts hints, each possibly associated to some data, which may help the implementation decode.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>image</code> - image of barcode to decode</dd> <dd><code>hints</code> - passed as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> from <a href="../../../com/google/zxing/DecodeHintType.html" title="enum in com.google.zxing"><code>DecodeHintType</code></a> to arbitrary data. The meaning of the data depends upon the hint type. The implementation may or may not do anything with these hints.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>String which the barcode encodes</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../com/google/zxing/NotFoundException.html" title="class in com.google.zxing">NotFoundException</a></code> - if no potential barcode is found</dd> <dd><code><a href="../../../com/google/zxing/ChecksumException.html" title="class in com.google.zxing">ChecksumException</a></code> - if a potential barcode is found but does not pass its checksum</dd> <dd><code><a href="../../../com/google/zxing/FormatException.html" title="class in com.google.zxing">FormatException</a></code> - if a potential barcode is found but format is invalid</dd> </dl> </li> </ul> <a name="reset--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>reset</h4> <pre>void reset()</pre> <div class="block">Resets any internal state the implementation has after a decode, to prepare it for reuse.</div> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/Reader.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../com/google/zxing/PlanarYUVLuminanceSource.html" title="class in com.google.zxing"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../com/google/zxing/ReaderException.html" title="class in com.google.zxing"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?com/google/zxing/Reader.html" target="_top">Frames</a></li> <li><a href="Reader.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small>Copyright © 2007–2022. All rights reserved.</small></p> </body> </html>