Online Documentation - Statistics - FAQ - Plugin Parts (All, Dependencies) - Class hierarchy
New in Version 22.2 22.3 22.4 22.5 23.0 23.1 23.2 23.3 23.4 23.5 24.0 24.1
The list of the topics, classes, interfaces, controls, modules, global methods by category, global methods by name, screenshots, licenses and examples.
Platforms to show: All Mac Windows Linux Cross-Platform
Back to ImageCaptureMBS class.
ImageCaptureMBS.DeviceList as ImageCaptureObjectMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS MacOSX Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns nil on any error.
Lasterror is set.
ImageCaptureMBS.ImportImage(flags as Integer) as string()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS MacOSX Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Use this method to allow the user to work a camera or a scanner.
The behavior:
(a) if no device is connected, a panel saying that there's no device connected is displayed,
(b) if a single device is connected, an appropriate user interface to access that device will be displayed,
(c) if several devices are connected, a device selector panel will be displayed.
filetypes: Optional an array of file extension strings such as "jpg", "tif", etc., that are of interest to the calling application. If no array is provided, all files are displayed.
Flag values that can be used in ImportImage:
kICAAllowMultipleImages | = 1 | Use this constant to allow users to select multiple images in the Import Image dialog. |
kICADownloadAndReturnPathArray | = 2 | Use this constant to download the images to a temporary location and return an array of paths to the downloaded images. |
See also:
ImageCaptureMBS.ImportImage(flags as Integer, filetypes() as string) as string()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS MacOSX Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Use this method to allow the user to work a camera or a scanner.
The behavior:
(a) if no device is connected, a panel saying that there's no device connected is displayed,
(b) if a single device is connected, an appropriate user interface to access that device will be displayed,
(c) if several devices are connected, a device selector panel will be displayed.
filetypes: Optional an array of file extension strings such as "jpg", "tif", etc., that are of interest to the calling application. If no array is provided, all files are displayed.
Flag values that can be used in ImportImage:
kICAAllowMultipleImages | = 1 | Use this constant to allow users to select multiple images in the Import Image dialog. |
kICADownloadAndReturnPathArray | = 2 | Use this constant to download the images to a temporary location and return an array of paths to the downloaded images. |
See also:
ImageCaptureMBS.LoadDeviceModule(params as dictionary)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS MacOSX Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Typically, connecting a FireWire or an USB device will automatically load an appropriate device module. This API is needed only for loading a device module manually for devices that do not use a hot-plug interface, such as Bluetooth, SCSI, or TCP/IP.
Legal Key-Value pairs for populating paramDictionary:
Key | Value | Comment |
kICADeviceModulePathKey | String | Path to the device module bundle that needs to be launched. |
kICATransportTypeKey | String | Should be one of the six predifined transport types. |
kICABluetoothAddressKey | String | Bluetooth device address string formatted as "00-11-22-33-44-55". |
kICAUSBLocationIDKey | Number (integer) | 32 bit USB location ID. |
kICAFireWireGUIDKey | Number (Int64) | 64 bit FireWire GUID. |
kICAIOServicePathKey | String | IO service path to the device obtained from the IO registry. |
kICAIPAddressKey | String | IP address of the device. This can be a host address ("camera.apple.com"), ipv4 address ('192.168.123.10") or ipv6 address ("3ff3:0000:0000:0000:0123:4567:89ab:cdef") |
kICAIPPortKey | Number (integer) | IP port number of the device. |
kICAIPNameKey | String | Human readable device name. |
kICAIPGUIDKey | String | 16 byte GUID string of the device formatted as "01234567-89ab-cdef-0123-456789abcdef". |
kICATWAINDSPathKey | String | Path to TWAIN DS bundle. |
ImageCaptureMBS.RegisterForEventNotification(objectOfInterest as ImageCaptureObjectMBS, eventsOfInterest() as string, options as dictionary)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS MacOSX Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
ImageCaptureMBS.SendNotification(notificationDictionary as dictionary) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS MacOSX Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns the reply code.
Lasterror is set.
ImageCaptureMBS.SendNotificationAndWaitForReply(notificationDictionary as dictionary) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS MacOSX Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Returns the reply code.
Lasterror is set.
ImageCaptureMBS.ShowDeviceBrowser
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS MacOSX Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The device browser user interface allows the user to do the following:
ImageCaptureMBS.UnloadDeviceModule(deviceObject as ImageCaptureObjectMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS MacOSX Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The device module providing this object will be unloaded, if this is the last device object provided by the device module.
Lasterror is set.
The items on this page are in the following plugins: MBS MacOSX Plugin.