2 * Copyright 2007 ZXing authors
\r
4 * Licensed under the Apache License, Version 2.0 (the "License");
\r
5 * you may not use this file except in compliance with the License.
\r
6 * You may obtain a copy of the License at
\r
8 * http://www.apache.org/licenses/LICENSE-2.0
\r
10 * Unless required by applicable law or agreed to in writing, software
\r
11 * distributed under the License is distributed on an "AS IS" BASIS,
\r
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
13 * See the License for the specific language governing permissions and
\r
14 * limitations under the License.
\r
17 namespace com.google.zxing
\r
20 /// <summary> Implementations of this interface can decode an image of a barcode in some format into
\r
21 /// the String it encodes. For example, {@link com.google.zxing.qrcode.QRCodeReader} can
\r
22 /// decode a QR code. The decoder may optionally receive hints from the caller which may help
\r
23 /// it decode more quickly or accurately.
\r
25 /// See {@link com.google.zxing.MultiFormatReader}, which attempts to determine what barcode
\r
26 /// format is present within the image as well, and then decodes it accordingly.
\r
29 /// <author> Sean Owen
\r
31 /// <author> dswitkin@google.com (Daniel Switkin)
\r
33 /// <author>www.Redivivus.in (suraj.supekar@redivivus.in) - Ported from ZXING Java Source
\r
36 public interface Reader
\r
39 /// <summary> Locates and decodes a barcode in some format within an image.
\r
42 /// <param name="image">image of barcode to decode
\r
44 /// <returns> String which the barcode encodes
\r
46 /// <throws> ReaderException if the barcode cannot be located or decoded for any reason </throws>
\r
47 Result decode(BinaryBitmap image);
\r
49 /// <summary> Locates and decodes a barcode in some format within an image. This method also accepts
\r
50 /// hints, each possibly associated to some data, which may help the implementation decode.
\r
53 /// <param name="image">image of barcode to decode
\r
55 /// <param name="hints">passed as a {@link java.util.Hashtable} from {@link com.google.zxing.DecodeHintType}
\r
56 /// to arbitrary data. The
\r
57 /// meaning of the data depends upon the hint type. The implementation may or may not do
\r
58 /// anything with these hints.
\r
60 /// <returns> String which the barcode encodes
\r
62 /// <throws> ReaderException if the barcode cannot be located or decoded for any reason </throws>
\r
63 Result decode(BinaryBitmap image, System.Collections.Hashtable hints);
\r