67 lines
2.6 KiB
Objective-C
67 lines
2.6 KiB
Objective-C
/*
|
|
* Copyright 2012 ZXing authors
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#import "ZXBarcodeFormat.h"
|
|
#import "ZXResultMetadataType.h"
|
|
|
|
@class ZXByteArray;
|
|
|
|
/**
|
|
* Encapsulates the result of decoding a barcode within an image.
|
|
*/
|
|
@interface ZXResult : NSObject
|
|
|
|
/**
|
|
* @return raw text encoded by the barcode
|
|
*/
|
|
@property (nonatomic, copy, readonly) NSString *text;
|
|
|
|
/**
|
|
* @return raw bytes encoded by the barcode, if applicable, otherwise nil
|
|
*/
|
|
@property (nonatomic, strong, readonly) ZXByteArray *rawBytes;
|
|
|
|
/**
|
|
* @return points related to the barcode in the image. These are typically points
|
|
* identifying finder patterns or the corners of the barcode. The exact meaning is
|
|
* specific to the type of barcode that was decoded.
|
|
*/
|
|
@property (nonatomic, strong, readonly) NSMutableArray *resultPoints;
|
|
|
|
/**
|
|
* @return ZXBarcodeFormat representing the format of the barcode that was decoded
|
|
*/
|
|
@property (nonatomic, assign, readonly) ZXBarcodeFormat barcodeFormat;
|
|
|
|
/**
|
|
* @return NSDictionary mapping ZXResultMetadataType keys to values. May be
|
|
* nil. This contains optional metadata about what was detected about the barcode,
|
|
* like orientation.
|
|
*/
|
|
@property (nonatomic, strong, readonly) NSMutableDictionary *resultMetadata;
|
|
|
|
@property (nonatomic, assign, readonly) long timestamp;
|
|
|
|
- (id)initWithText:(NSString *)text rawBytes:(ZXByteArray *)rawBytes resultPoints:(NSArray *)resultPoints format:(ZXBarcodeFormat)format;
|
|
- (id)initWithText:(NSString *)text rawBytes:(ZXByteArray *)rawBytes resultPoints:(NSArray *)resultPoints format:(ZXBarcodeFormat)format timestamp:(long)timestamp;
|
|
+ (id)resultWithText:(NSString *)text rawBytes:(ZXByteArray *)rawBytes resultPoints:(NSArray *)resultPoints format:(ZXBarcodeFormat)format;
|
|
+ (id)resultWithText:(NSString *)text rawBytes:(ZXByteArray *)rawBytes resultPoints:(NSArray *)resultPoints format:(ZXBarcodeFormat)format timestamp:(long)timestamp;
|
|
- (void)putMetadata:(ZXResultMetadataType)type value:(id)value;
|
|
- (void)putAllMetadata:(NSMutableDictionary *)metadata;
|
|
- (void)addResultPoints:(NSArray *)newPoints;
|
|
|
|
@end
|