Other Constants

Option key that instructs the reader to attach the frame that the detection was performed on to the read result. The default value is discard all. Frames that are passed as part of the read result will only be valid inside of the result callback block. A delay on the queue that result callbacks are being dispatched to could result in a high amount of memory being consumed as read results wait for processing. Use the frames with results options to mitigate memory usage issues and only return images when necessary. For detectors that require multiple sample buffers, such as audio detectors, the retained sample buffer will be only the most recent sample buffer used to finalize the detection.

Discard all sample buffers after processing. Read results will always contain a nil value for the sample buffer property.

Retain all sample buffers after processing. Read results will always contain a value for the sample buffer property.

Retain all sample buffers after processing when a result is detected in the sample buffer. Read results will contain a value for the sample buffer property only when a detection result is found.

Retain all sample buffers after processing when a result is detected in the sample buffer. Read results will contain a value for the sample buffer property only when a new detection result is found.

The domain for any errors returned from a reader

Option key for setting the inverted read interval rate as an NSNumber. Some symbologies, such as the barcode symbologies, need to be configured to detect white-on-black codes in addition to black-on-white codes. Inverted codes will be read at an interval of 1/value, where 0 will configure applicable symbologies to never detect inverted symbols.

Option key for setting a detection type. Refer to the DMSImageDetectionType constants for possible options.

Option key for configuring if the detector is allowed to skip frames for performance reasons. It’s recommended to pass true for this value unless a developer has an overriding reason not to, like implementing their own frame skipping or reading from a source other than a video stream. Generally an image reader does not need to read every frame at 30 fps or higher to get a reliable detection.

Option key for configuring the read distances of tranditional barcodes such as 1D and QR codes. Reading at further distances is more expensive. Use DMSReadDistance for available options. The value for this key is an NSNumber object containing an integer value.

Option key for configuring the minimum detectable length of a ITF barcode. Default value is 10. This value must be even, must be at least 8, and cannot be more than 24. Attempting to set an unsupported value will result in an exception. The value for this key is an NSNumber object containing an integer value.

Option key for enabling plastics reading mode which will search for Digimarc Barcodes on plastic substrates. This reader option is off by default. The value for this key is a Bool.

Option key for setting Illuminate Service configuration. The value for this key is an IlluminateConfiguration object.

Do a detection on an image that will attempt to balance speed and efficiency with the number of places to look in the frame. This is the recommended detection type for live video. Results may not be consistent with the same input.

@b Beta. Detection type for exhaustively searching an image. This may be an extremely expensive operation based on the image size, but the results will always be complete and consistent. Recommended for images that are not part of a video stream.

@b Beta. Detection type for exhaustively searching an image by it’s width and height, but not by distance. Calibrated for images captured 4-6 inches away from a mobile device camera. More expensive than quick detection, but still suitable for most mobile devices. This detection type should be used for diagnostic applications on camera feeds. Because it is calibrated for a specific capture distance, this detection type may not be suitable for still image content.

The typical best case for a detector. Currently always defaults to quick detection. This may change in future versions as more detection types are added. Using the default detection type is generally the best option for developers, but if you are absolutely sure a specific detection type will always be best, you should use that detection type and not rely on the value of this default.

The UPCA formatted value of the payload. Available if the payload’s contents are compatible with the UPCA specification. Value is a string.

The UPCE formatted value of the payload. Available if the payload’s contents are compatible with the UPCE specification. Value is a string.

The EAN13 formatted value of the payload. Available if the payload’s contents are compatible with the EAN13 specification. Value is a string.

The EAN8 formatted value of the payload. Available if the payload’s contents are compatible with the EAN8 specification. Value is a string.

The GTIN14 formatted value of the payload. Available if the payload’s contents are compatible with the GTIN14 specification. Value is a string.

Contains the raw text value of the QR code. Available if the symbology is a QR code. Value is a string.

Contains the raw text value of the Code 39 code. Available if the symbology is a Code 39 code. Value is a string.

Contains the raw text value of the Code 128 code. Available if the symbology is a Code 128 code. Value is a string.

Contains the GS1 AI string. Available if the payload can be represented as a GS1 string. This data may be altered from the actual value to conform with the GS1 specification. Value is a string.

Contains the CPM path of the Digimarc audio payload. Available if the symbology is audio Digimarc. Value is a string.

Contains the CPM path of the Digimarc image payload. Available if the symbology is image Digimarc. Value is a string.

Contains the raw value of the payload. Applies to payload types that are unstructured, such as QR codes, Code39, or Code128. Value is a string.

Digimarc Watermark for Print identifier. Available if the payload if a Digimarc watermark associated with a print service. Value is a hex identifier encoded as a NSString.

Digimarc Watermark for Recycling identifier. Available if the payload if a Digimarc watermark associated with a recycling service. Value is a hex identifier encoded as a string.

Digimarc Watermark for Audio identifier. Available if the payload if a Digimarc watermark associated with an audio service. Value is a hex identifier encoded as a string.

Digimarc Secure Watermark identifier. Available if the payload if a Digimarc secure watermark associated with an image service.

Key for the SGTIN96 standard value. The standard value is in the format [Company Prefix].[Indicator Digit].[Item Reference].[Serial Number] . Value is a string.

Key for the SGTIN96 company prefix. Value is a string.

Key for the SGTIN96 serial number. Value is a string.

Key for the SGTIN96 item reference. Value is a string.

Key for the SGTIN96 indicator digit. Value is a string.

Key for the SGTIN96 filter value. Value is a string.

Contains the GS1 formatted AI string. Available if the payload can be represented as a GS1 string. This data may be altered from the actual value to conform with the GS1 specification. Value is a string.

The price of the item in local currency. Amount payable for variable measure trade. Value is a NSDecimalNumber. Float and Double may not have enough precision to correctly represent this value. String conversion should be done by passing this value directly to a Number Formatter as an NSDecimalNumber type.

The weight of the item in pounds. Value is a NSDecimalNumber. Float and Double may not have enough precision to correctly represent this value. String conversion should be done by passing this value directly to a Number Formatter as an NSDecimalNumber type.

The weight of the item in kilograms. Value is a NSDecimalNumber. Float and Double may not have enough precision to correctly represent this value. String conversion should be done by passing this value directly to a Number Formatter as an NSDecimalNumber type.

The count of items. Value is an integer.

The sell by date. Value is a Date.

Extra data contained in a Simple Product ID 96. Value is a string.

The representation contains a variable measure value from within a GTIN 14 value. Thse values are identified by their prefixes, GS1 Variable Measure Numbers (VMNs). However, the value returned will not contain this prefix. Value is a string.

Global Individual Asset Identifier. Value is a string.

Global Individual Asset Identifier Company Prefix Value is a string.

Global Individual Asset Identifier Asset ID. Value is a string.

Contains the raw text value of the ITF code. Available if the symbology is an ITF 14 or ITF Variable Length code. Value is a string..

Option key for disabling analytics. Digimarc will normally collect some anonymous statistics such as device and operating system information for diagnostics. If you are configuring multiple readers, and want to disable data collection for all of them, provide this option for each reader. Usage of the Resolver class to communicate with Digimarc’s backend will implicitly result in data disclosure, regardless of this option. See our privacy documentation for more information. Default value is true. The value for this key is an NSNumber object containing an boolean value.

The key for the value that returns a bitmask representing the symbologies that could not be processed due to the error.