1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
ZBarSymbol Class Reference
==========================
.. class:: ZBarSymbol
:Inherits from: :class:`NSObject`
A symbol wraps all of the information the library has about a decoded
barcode. Use the available properties to retrieve the barcode data, the
symbology (type of barcode), location and more.
This class is a simple wrapper around a :type:`zbar_symbol_t` C object
(q.v.)
Properties
----------
.. member:: zbar_symbol_type_t type
The type of symbology that was decoded. (read-only)
.. member:: NSString *typeName
The canonical name used by the library to represent the symbology.
(read-only)
.. member:: NSUInteger configMask
Bitmask of symbology config settings used during decode.
.. member:: NSUInteger modifierMask
Bitmask of symbology characteristics detected during decode. See
:type:`zbar_modifier_t` for the currently defined modifier bits.
.. member:: NSString *data
The raw decoded barcode data. (read-only)
.. member:: int quality
A relative metric indicating rough confidence in the decoded value.
Larger values are better than smaller values. (read-only)
.. member:: zbar_orientation_t orientation
The general, axis-aligned orientation of the symbol, or
ZBAR_ORIENT_UNKNOWN if unknown. (read-only)
.. member:: ZBarSymbolSet *components
The components of a composite symbol. (read-only)
.. member:: const zbar_symbol_t *zbarSymbol
Retrieve the underlying C object instance. (read-only)
.. member:: CGRect bounds
Calculate a rough bounding box for the symbol. (read-only)
.. note::
Coordinates are relative to the image *data*, which may not match a
displayed UIImage. Make sure to account for the UIImage orientation
when using these values.
Class Methods
-------------
.. _`nameForType:`:
.. describe:: + (NSString*) nameForType:(zbar_symbol_type_t)type
Retrieve the canonical name for a symbology used by the library, given
its enumerated value.
:type: The :type:`zbar_symbol_type_t` enumerated symbology value.
:Returns: A short string name for the symbology.
Instance Methods
----------------
.. _`initWithSymbol:`:
.. describe:: - (id) initWithSymbol:(const zbar_symbol_t*)symbol
Initialize a symbol wrapper, given the C object to wrap.
:symbol: The C object to wrap.
:Returns: The initialized symbol, or nil if an error occurred.
Constants
---------
.. type:: zbar_symbol_type_t
Symbology identifiers.
ZBAR_NONE
No symbol was decoded.
ZBAR_PARTIAL
Intermediate status.
ZBAR_EAN8
EAN-8
ZBAR_UPCE
UPC-E
ZBAR_ISBN10
ISBN-10, converted from EAN-13
ZBAR_UPCA
UPC-A
ZBAR_EAN13
EAN-13
ZBAR_ISBN13
ISBN-13, converted from EAN-13
ZBAR_I25
Interleaved 2 of 5
ZBAR_DATABAR
GS1 DataBar (RSS)
ZBAR_DATABAR_EXP
GS1 DataBar Expanded
ZBAR_CODABAR
Codabar
ZBAR_CODE39
Code 39 (3 of 9)
ZBAR_QRCODE
QR Code
ZBAR_CODE128
Code 128
.. type:: zbar_orientation_t
The coarse orientation of a symbol.
.. note::
Orientation is relative to the image *data*, which may not match a
displayed UIImage. Make sure to account for the UIImage orientation
when using these values.
ZBAR_ORIENT_UNKNOWN
Unable to determine orientation.
ZBAR_ORIENT_UP
Upright, read left to right
ZBAR_ORIENT_RIGHT
Sideways, read top to bottom
ZBAR_ORIENT_DOWN
Upside-down, read right to left
ZBAR_ORIENT_LEFT
Sideways, read bottom to top
.. type:: zbar_modifier_t
Decoder symbology modifier flags.
.. note::
These are bit indices, use eg, (1 << ZBAR_MOD_GS1) to test the
modifierMask property.
ZBAR_MOD_GS1
Barcode tagged as GS1 (EAN.UCC) reserved (eg, FNC1 before first data
character). Data may be parsed as a sequence of GS1 AIs.
ZBAR_MOD_AIM
Barcode tagged as AIM reserved.
|
