Platforms to show: All Mac Windows Linux Cross-Platform
Back to ImageCaptureObjectMBS class.
ImageCaptureObjectMBS.CloseSession
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS MacOSX Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Lasterror is set.
For a scanner device use the ScannerCloseSession.
ImageCaptureObjectMBS.Constructor
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS MacOSX Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
See also:
ImageCaptureObjectMBS.Constructor(handle 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 |
See also:
ImageCaptureObjectMBS.CopyData(startByte as int64, requestedSize as int64) 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 |
startByte: Starting byte offset of the data in the file object.
requestedSize: Requested data size in bytes.
If you want to get all bytes of an object, pass startByte = 0 and requestedSize = filesize.
Lasterror is set.
ImageCaptureObjectMBS.CopyThumbnail(format 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 |
This is the recommended way to get the thumbnail of an object.
Use the constants for the format: kICAThumbnailFormatJPEG, kICAThumbnailFormatTIFF or kICAThumbnailFormatPNG
Lasterror is set.
Some examples using this method:
ImageCaptureObjectMBS.DownloadFile(dir as folderitem, flags as Integer, MacType as string, MacCreator as string, angle as Double) as folderitem
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS MacOSX Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
This API is a convenient way to download a file to disk. To receive the image data in memory use CopyObjectData.
Constants for flags:
kDeleteAfterDownload | = 1 | Delete file after a successful download. |
kCreateCustomIcon | = 2 | Create a custom icon for Finder. |
kAddMetaDataToFinderComment | = 4 | Add basic metadata to finder comment field. |
kAdjustCreationDate | = 8 | Set creation date of the downloaded file same as the creation date for the file as reported by the device. |
kSetFileTypeAndCreator | = &h10 | Set 4-char file type and creator code. |
kEmbedColorSyncProfile | = &h20 | Embed ColorSync profile to the image if one was not already embedded. |
kRotateImage | = &h40 | Rotate the image. |
kDontEmbedColorSyncProfile | = &h80 | Do not embed ColorSync profile to the image. |
Lasterror is set.
ImageCaptureObjectMBS.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 ImageCaptureObjectMBS object you use for this call, should point to a camera or scanner device.
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. |
Returns an array of Strings for the imported images if the kICADownloadAndReturnPathArray flag is not specified. Otherwise returns an array of Strings holding the paths of the images that are downloaded.
See also:
ImageCaptureObjectMBS.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 ImageCaptureObjectMBS object you use for this call, should point to a camera or scanner device.
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. |
Returns an array of Strings for the imported images if the kICADownloadAndReturnPathArray flag is not specified. Otherwise returns an array of Strings holding the paths of the images that are downloaded.
See also:
ImageCaptureObjectMBS.OpenSession(device 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 |
Lasterror is set.
For a scanner device use the ScannerOpenSession method.
ImageCaptureObjectMBS.PropertyDictionary 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 |
Lasterror is set.
Some examples using this method:
ImageCaptureObjectMBS.PropertyDictionaryText 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 |
Lasterror is set.
This is for debugging and may be removed soon.
The format of the text is the plist file format.
ImageCaptureObjectMBS.ScannerCloseSession
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS MacOSX Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Lasterror is set.
For a camera device use the CloseSession method.
ImageCaptureObjectMBS.ScannerGetParameters 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 |
Use this method to get information about the scanner such as resolution, scanning area, etc.
Lasterror is set.
ImageCaptureObjectMBS.ScannerInitialize
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Image Capture | MBS MacOSX Plugin | 10.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Lasterror is set.
ImageCaptureObjectMBS.ScannerOpenSession(device 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 |
Lasterror is set.
For a camera device use the OpenSession method.
ImageCaptureObjectMBS.ScannerSetParameters(dic 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 |
Use this method to specify scan parameters that will be used when a scan is initiated via ScannerStart.
Lasterror is set.
ImageCaptureObjectMBS.ScannerStart
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 start a scan based on the parameters that were specified in a previous ScannerSetParameters call.
Lasterror is set.
ImageCaptureObjectMBS.ScannerStatus 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 |
Lasterror is set.
ImageCaptureObjectMBS.SendMessageMemory(messageType as string, startByte as UInt32, data as memoryblock, dataType as string) as UInt32
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 API to send a message to a device object. All devices do not respond to all the messages defined above.
messageType: A message type. e.g., kICAMessageCameraCaptureNewImage.
startByte: Offset in dataPtr from where data access for read/write should occur.
data: The data to send.
dataType: Data type.
Lasterror is set.
Retruns the result from this message.
ImageCaptureObjectMBS.SendMessageString(messageType as string, startByte as UInt32, data as string, dataType as string) as UInt32
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 API to send a message to a device object. All devices do not respond to all the messages defined above.
messageType: A message type. e.g., kICAMessageCameraCaptureNewImage.
startByte: Offset in dataPtr from where data access for read/write should occur.
data: The data to send.
dataType: Data type.
Lasterror is set.
Retruns the result from this message.
ImageCaptureObjectMBS.UploadFile(file as folderitem, flags 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 |
The device choses an appropriate destination location for the uploaded image and sends a kICANotificationTypeObjectAdded notification.
Lasterror is set.
Flag values that can be used in UploadFile:
kICAUploadFileAsIs | Use this constant to upload a file as is. |
kICAUploadFileScaleToFit | Use this constant to upload a file after scaling to fit a specified bounding rect. |
The items on this page are in the following plugins: MBS MacOSX Plugin.
