Platforms to show: All Mac Windows Linux Cross-Platform
ICScannerDeviceMBS class
Super class: ICDeviceMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
class | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
ICScannerDeviceMBS is a concrete subclass of ICDeviceMBS class. ICDeviceBrowserMBS creates instances of this class. In this release, an instance of ICScannerDeviceMBS class is intended to be used by the IKScannerDeviceViewMBS object. The IKScannerDeviceView class encapsulates the complexities of setting scan parameters, performing scans and saving the result. The developer should consider using IKScannerDeviceViewMBS instead of building their own views using the ICScannerDeviceMBS object.
Subclass of the ICDeviceMBS class.
This is an abstract class. You can't create an instance, but you can get one from various plugin functions.
- 7 properties
- property documentName as String
- property documentUTI as String
- property downloadsDirectory as String
- property downloadsFolder as FolderItem
- property maxMemoryBandSize as UInt64
- property selectedFunctionalUnit as ICScannerFunctionalUnitMBS
- property transferMode as Integer
- 6 methods
- method availableFunctionalUnitTypes as Integer()
- method cancelScan
- method Constructor Private
- method requestOverviewScan
- method requestScan
- method requestSelectFunctionalUnit(type as Integer)
- 3 shared methods
- shared method ICScannerStatusRequestsOverviewScan as string
- shared method ICScannerStatusWarmingUp as string
- shared method ICScannerStatusWarmUpDone as string
- 2 constants
Transfer Modes
Constant | Value | Description |
---|---|---|
ICScannerTransferModeFileBased | 0 |
Save the scan as a file. |
ICScannerTransferModeMemoryBased | 1 |
Transfer the scan as data. |
Super class ICDeviceMBS
- 35 properties
- property AutolaunchApplicationPath as String
- property BonjourServiceType as String
- property BskonjourServiceName as String
- property ButtonPressed as String
- property canDeleteAllFiles as Boolean
- property canDeleteOneFile as Boolean
- property canEject as Boolean
- property canReceiveFile as Boolean
- property canSyncClock as Boolean
- property canTakePicture as Boolean
- property fwGUID as Int64
- property Handle as Integer
- property HasConfigurableWiFiInterface as Boolean
- property HasOpenSession as Boolean
- property Icon as Variant
- property IconPath as String
- property IPAddress as String
- property IsRemote as Boolean
- property IsShared as Boolean
- property LocationDescription as String
- property ModuleExecutableArchitecture as Integer
- property ModulePath as String
- property ModuleVersion as String
- property Name as String
- property PersistentIDString as String
- property ProductKind as String
- property SerialNumberString as String
- property SystemSymbolName as String
- property TransportType as String
- property type as Integer
- property usbLocationID as Integer
- property usbProductID as Integer
- property usbVendorID as Integer
- property UserData as Dictionary
- property UUIDString as String
- 7 methods
- method capabilities as Variant()
- method Constructor Private
- method requestCloseSession
- method requestEjectOrDisconnect
- method requestOpenSession
- method requestSendMessage(messageCode as UInt32, data as MemoryBlock, maxReturnedDataSize as UInt64)
- method requestYield
- 19 shared methods
- shared method ICButtonTypeCopy as string
- shared method ICButtonTypeMail as string
- shared method ICButtonTypePrint as string
- shared method ICButtonTypeScan as string
- shared method ICButtonTypeTransfer as string
- shared method ICButtonTypeWeb as string
- shared method ICDeviceCanEjectOrDisconnect as string
- shared method ICDeviceLocationDescriptionBluetooth as string
- shared method ICDeviceLocationDescriptionFireWire as string
- shared method ICDeviceLocationDescriptionMassStorage as string
- shared method ICDeviceLocationDescriptionUSB as string
- shared method ICLocalizedStatusNotificationKey as string
- shared method ICStatusCodeKey as string
- shared method ICStatusNotificationKey as string
- shared method ICTransportTypeBluetooth as string
- shared method ICTransportTypeFireWire as string
- shared method ICTransportTypeMassStorage as string
- shared method ICTransportTypeTCPIP as string
- shared method ICTransportTypeUSB as string
- 13 constants
Device Types
Constant | Value | Description |
---|---|---|
ICDeviceLocationTypeBluetooth | &h00000800 |
Device found as a paired Bluetooth device. |
ICDeviceLocationTypeBonjour | &h00000400 |
Device found over the network by searching for Bonjour services supported by Image Capture. |
ICDeviceLocationTypeLocal | &h00000100 |
Device found directly attached to the Macintosh via its USB or FireWire port. |
ICDeviceLocationTypeShared | &h00000200 |
Device found over the network by searching for devices shared by other Macintosh hosts. |
Image Capture Device Location Type Mask
Constant | Value | Description |
---|---|---|
ICDeviceLocationTypeMaskBluetooth | &h00000800 |
Mask to detect paired Bluetooth device. |
ICDeviceLocationTypeMaskBonjour | &h00000400 |
Mask to detect a network device that publishes a Bonjour service. |
ICDeviceLocationTypeMaskLocal | &h00000100 |
Mask to detect a local (e.g., USB or FireWire) device. |
ICDeviceLocationTypeMaskRemote | &h0000FE00 |
Mask to detect a remote (shared, Bonjour, Bluetooth) device. |
ICDeviceLocationTypeMaskShared | &h00000200 |
Mask to detect a device by another Macintosh host. |
Image Capture Device Types
Constant | Value | Description |
---|---|---|
ICDeviceTypeCamera | &h00000001 |
Camera device. |
ICDeviceTypeScanner | &h00000002 |
Scanner device. |
Image Capture Device Type Mask
Constant | Value | Description |
---|---|---|
ICDeviceTypeMaskCamera | &h00000001 |
Mask to detect a camera device. |
ICDeviceTypeMaskScanner | &h00000002 |
Mask to detect a scanner device. |
This class has no sub classes.
Some properties using for this class:
- IKScannerDeviceViewMBS.scannerDevice as ICScannerDeviceMBS
Some events using this class:
- ImageCaptureEventsMBS.scannerDeviceDidBecomeAvailable(scanner as ICScannerDeviceMBS)
- ImageCaptureEventsMBS.scannerDeviceDidCompleteOverviewScanWithError(scanner as ICScannerDeviceMBS, error as NSErrorMBS)
- ImageCaptureEventsMBS.scannerDeviceDidCompleteScanWithError(scanner as ICScannerDeviceMBS, error as NSErrorMBS)
- ImageCaptureEventsMBS.scannerDeviceDidScanToBandData(scanner as ICScannerDeviceMBS, Data as ICScannerBandDataMBS)
- ImageCaptureEventsMBS.scannerDeviceDidScanToURL(scanner as ICScannerDeviceMBS, URL as string, file as folderitem, data as MemoryBlock)
- ImageCaptureEventsMBS.scannerDeviceDidSelectFunctionalUnit(scanner as ICScannerDeviceMBS, functionalUnit as Variant, Error as NSErrorMBS)
Some examples using this class:
The items on this page are in the following plugins: MBS AVFoundation Plugin.
ICScannerBandDataMBS - ICScannerFeatureBooleanMBS