Cognex Mobile Barcode SDK SDK for supporting communication with Cognex Barcode Reader devices

Classes | Enumerations
CDMDataManSystem.h File Reference
`#import <Foundation/Foundation.h>`
`#import <ExternalAccessory/ExternalAccessory.h>`
`#import <cmbSDK/CDMDataManSystemDelegate.h>`
`#import <CoreBluetooth/CoreBluetooth.h>`

Go to the source code of this file.

## Classes
class | CDMDataManSystem
| Represents a remote DataMan system. More...

## Enumerations
enum | CDMImageSize { kCDMImageSizeFull , kCDMImageSizeQuarter , kCDMImageSizeSixteenth , kCDMImageSizeSixtyFourth }
| Image size. More...
enum | CDMImageQuality { kCDMImageQualityLow = 10 , kCDMImageQualityMedium = 50 , kCDMImageQualityHigh = 90 }
| Image quality used when getting live image or process monitor images. More...
enum | CDMImageFormat { kCDMImageFormatBitmap = 0 , kCDMImageFormatJpeg = 1 }
| Indicates the image format type for live displays or process monitor images. More...
enum | CDMResultTypes { kCDMResultTypeNone = 0 , kCDMResultTypeReadString = 1 , kCDMResultTypeReadXml = 2 , kCDMResultTypeXmlStatistics = 4 , kCDMResultTypeImage = 8 , kCDMResultTypeImageGraphics = 16 , kCDMResultTypeTrainingResults = 32 , kCDMResultTypeCodeQualityData = 64 , kCDMResultTypeXmlContent = 128 }
| Specifies the result types, that the application can receive. More...
enum | CDMConnectionState { kCDMConnectionStateDisconnected = 0 , kCDMConnectionStateConnecting = 1 , kCDMConnectionStateConnected = 2 , kCDMConnectionStateDisconnecting = 3 }
| Specifies the connection states, that the DataManSystem can have. More...
enum | DataManDeviceClass : NSUInteger { DataManDeviceClass_MX , DataManDeviceClass_Network , DataManDeviceClass_PhoneCamera , DataManDeviceClass_BT_L2CAP }
| Specifies the device types of a CDMDataManSystem instance. More...
enum | CDMCameraMode { kCDMCameraModeNoAimer , kCDMCameraModePassiveAimer , kCDMCameraModeFrontCamera }
| Specifies the preview/illumination mode when using the Mobile device camera. More...
enum | CDMPreviewOption { kCDMPreviewOptionDefaults = 0 , kCDMPreviewOptionNoZoomBtn = 1 , kCDMPreviewOptionNoIllumBtn = 2 , kCDMPreviewOptionHwTrigger = 4 , kCDMPreviewOptionPaused = 8 , kCDMPreviewOptionAlwaysShow = 16 , kCDMPreviewOptionHighResolution = 32 , kCDMPreviewOptionHighFrameRate = 64 , kCDMPreviewOptionShowCloseBtn = 128 , kCDMPreviewOptionKeepPreviewInPausedState = 256 }
| Controls the preview/scanning options when using the Mobile device camera. More...

## Enumeration Type Documentation

## ◆ CDMCameraMode

enum CDMCameraMode

Specifies the preview/illumination mode when using the Mobile device camera.

Enumerator
kCDMCameraModeNoAimer | Use camera with no aimer. Preview is on, illumination is available.
kCDMCameraModePassiveAimer | Use camera with a basic aimer (e.g., StingRay). Preview is off, illumination is not available.
kCDMCameraModeFrontCamera | Use mobile device front camera. Preview is on, illumination is not available.

## ◆ CDMConnectionState

enum CDMConnectionState

Specifies the connection states, that the DataManSystem can have.

Enumerator
kCDMConnectionStateDisconnected |
kCDMConnectionStateConnecting |
kCDMConnectionStateConnected |
kCDMConnectionStateDisconnecting |

## ◆ CDMImageFormat

enum CDMImageFormat

Indicates the image format type for live displays or process monitor images.

Enumerator
kCDMImageFormatBitmap | Bitmap format.
kCDMImageFormatJpeg | Jpeg format.

## ◆ CDMImageQuality

enum CDMImageQuality

Image quality used when getting live image or process monitor images.

Enumerator
kCDMImageQualityLow | Low image quality for jpeg format.
kCDMImageQualityMedium | Medium image quality for jpeg format.
kCDMImageQualityHigh | High image quality for jpeg format.

## ◆ CDMImageSize

enum CDMImageSize

Image size.

Enumerator
kCDMImageSizeFull | Full sized image.
kCDMImageSizeQuarter | Image scaled down by 1/4.
kCDMImageSizeSixteenth | Image scaled down by 1/16.
kCDMImageSizeSixtyFourth | Image scaled down by 1/64.

## ◆ CDMPreviewOption

enum CDMPreviewOption

Controls the preview/scanning options when using the Mobile device camera.

Preview defaults are set by the CDMCameraMode but can be overridden. Multiple options can be OR'd together.

Enumerator
kCDMPreviewOptionDefaults | Use defaults (no overrides).
kCDMPreviewOptionNoZoomBtn | Disable zoom feature (removes zoom button from preview).
kCDMPreviewOptionNoIllumBtn | Disable illumination (removes illumination button from preview).
kCDMPreviewOptionHwTrigger | Enables the simulated hardware trigger (the volume down button).
kCDMPreviewOptionPaused | When scanning starts, the preview is displayed but decoding is paused until a trigger (either the on screen button or the volume down button, if enabled) is pressed.
kCDMPreviewOptionAlwaysShow | Force the preview to be displayed, even if off by default (e.g., when using kCDMCameraModePassiveAimer).
kCDMPreviewOptionHighResolution | Use higher resolution if the device supports it. Default is 1280x720, with this param 1920x1080 will be used.
kCDMPreviewOptionHighFrameRate | Use higher framerate if the device supports it. Default is 30 FPS, with this param 60 FPS will be used.
kCDMPreviewOptionShowCloseBtn | Show close button in partial view.
kCDMPreviewOptionKeepPreviewInPausedState | Keep the preview in paused state after read.

## ◆ CDMResultTypes

enum CDMResultTypes

Specifies the result types, that the application can receive.

All other result types are ignored.

Enumerator
kCDMResultTypeNone | No results of any kind are requested from the reader.
kCDMResultTypeReadString | Represents a simple read result string.
kCDMResultTypeReadXml | Represents a read result in xml format.
kCDMResultTypeXmlStatistics | Represents read statistics in xml format.
kCDMResultTypeImage | Represents a read image.
kCDMResultTypeImageGraphics | Represent an image graphics xml.
kCDMResultTypeTrainingResults | Represents training results in xml format.
kCDMResultTypeCodeQualityData | Represents code quality information in xml format.
kCDMResultTypeXmlContent | Represents code content information in xml format.

## ◆ DataManDeviceClass

enum DataManDeviceClass : NSUInteger

Specifies the device types of a CDMDataManSystem instance.

Enumerator
DataManDeviceClass_MX |
DataManDeviceClass_Network |
DataManDeviceClass_PhoneCamera |
DataManDeviceClass_BT_L2CAP |