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 ImageCaptureEventsMBS class.
ImageCaptureEventsMBS.cameraDeviceDidAddItem(camera as ICCameraDeviceMBS, item as ICCameraItemMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
The object may be an instance of ICCameraFolder or ICCameraFile class.
ImageCaptureEventsMBS.cameraDeviceDidAddItems(camera as ICCameraDeviceMBS, items() as ICCameraItemMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
Instead of receive one event per object, an array of objects is sent.
The objects may be instances of ICCameraFolder or ICCameraFile class.
ImageCaptureEventsMBS.cameraDeviceDidBecomeReadyWithCompleteContentCatalog(camera as ICCameraDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
A session must be opened on the device in order to enumerate its content and make it ready to receive requests.
ImageCaptureEventsMBS.cameraDeviceDidChangeCapability(camera as ICCameraDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
This usually happens when the device module takes control or yields control of the device.
ImageCaptureEventsMBS.cameraDeviceDidCompleteDeleteFilesWithError(camera as ICCameraDeviceMBS, error as NSErrorMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
This event is sent after the camera device completes a delete operation initiated by sending a requestDeleteFiles event to that device.
ImageCaptureEventsMBS.cameraDeviceDidDownloadFile(file as ICCameraFileMBS, error as NSErrorMBS, options as Dictionary, device as ICCameraDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.cameraDeviceDidEnableAccessRestriction(camera as ICCameraDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 20.4 | ✅ Yes | ❌ No | ❌ No | ❌ No |
For macOS 10.15 or newer.
ImageCaptureEventsMBS.cameraDeviceDidReadData(data as Memoryblock, file as ICCameraFileMBS, error as NSErrorMBS, device as ICCameraDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.cameraDeviceDidReceiveDownloadProgressForFile(file as ICCameraFileMBS, downloadedBytes as UInt64, maxBytes as UInt64)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.cameraDeviceDidReceiveMetadataForItem(camera as ICCameraDeviceMBS, item as ICCameraItemMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.cameraDeviceDidReceivePTPEvent(camera as ICCameraDeviceMBS, eventData as MemoryBlock)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.cameraDeviceDidReceiveThumbnailForItem(camera as ICCameraDeviceMBS, item as ICCameraItemMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.cameraDeviceDidRemoveAccessRestriction(camera as ICCameraDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 20.4 | ✅ Yes | ❌ No | ❌ No | ❌ No |
For macOS 10.15 or newer.
ImageCaptureEventsMBS.cameraDeviceDidRemoveItem(camera as ICCameraDeviceMBS, item as ICCameraItemMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
The object may be an instance of ICCameraFolder or ICCameraFile class.
ImageCaptureEventsMBS.cameraDeviceDidRemoveItems(camera as ICCameraDeviceMBS, items() as ICCameraItemMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
The objects may be instances of ICCameraFolder or ICCameraFile class. This method supercedes cameraDeviceDidRemoveItem method described above.
ImageCaptureEventsMBS.cameraDeviceDidRenameItems(camera as ICCameraDeviceMBS, items() as ICCameraItemMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
The objects may be instances of ICCameraFolder or ICCameraFile class.
ImageCaptureEventsMBS.cameraDeviceDidSendPTPCommand(command as Memoryblock, data as Memoryblock, response as MemoryBlock, error as NSErrorMBS, device as ICCameraDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.cameraDeviceDidUploadFile(fileURL as string, file as FolderItem, error as NSErrorMBS, device as ICCameraDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.cameraDeviceViewDidDownloadFile(cameraDeviceView as IKCameraDeviceViewMBS, CameraFile as ICCameraFileMBS, URL as string, File as folderItem, data as MemoryBlock, error as NSErrorMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
Based on the IKCameraDeviceViewDisplayMode the downloaded file will be saved on disk using the 'url', or returned in memory as Memoryblock.
ImageCaptureEventsMBS.cameraDeviceViewDidEncounterError(cameraDeviceView as IKCameraDeviceViewMBS, error as NSErrorMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.cameraDeviceViewSelectionDidChange(cameraDeviceView as IKCameraDeviceViewMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.deviceBrowserDeviceDidChangeName(browser as ICDeviceBrowserMBS, device as ICDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
This happens if the device module overrides the default name of the device reported by the device's transport layer, or if the name of the filesystem volume mounted by the device is changed by the user.
ImageCaptureEventsMBS.deviceBrowserDeviceDidChangeSharingState(browser as ICDeviceBrowserMBS, device as ICDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
Any Image Capture client application can choose to share the device over the network using the sharing or webSharing facility in Image Capture.
ImageCaptureEventsMBS.deviceBrowserDidAddDevice(browser as ICDeviceBrowserMBS, device as ICDeviceMBS, moreComing as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
If several devices are found during the initial search, then this event is sent once for each device with the value of 'moreComing' set to true in each event except the last one.
ImageCaptureEventsMBS.deviceBrowserDidEnumerateLocalDevices(browser as ICDeviceBrowserMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
Detecting locally connected devices (USB and FireWire devices) is faster than detecting devices connected using a network protocol. An Image Capture client application may use this event to update its user interface to let the user know that it has completed looking for locally connected devices and then start looking for network devices.
ImageCaptureEventsMBS.deviceBrowserDidRemoveDevice(browser as ICDeviceBrowserMBS, device as ICDeviceMBS, moreGoing as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
If several devices are removed at the same time, then this event is sent once for each device with the value of 'moreGoing' set to true in each event except the last one.
ImageCaptureEventsMBS.deviceBrowserRequestsSelectDevice(browser as ICDeviceBrowserMBS, device as ICDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
In Mac OS X 10.6, this event is sent when a button is pressed on a device and the current application is the target for that button press. In the case of the button-press event, if a session is open on the device, this event will not be sent, instead the deviceDidReceiveButtonPress event is sent.
ImageCaptureEventsMBS.deviceBrowserViewDidEncounterError(deviceBrowserView as IKDeviceBrowserViewMBS, error as NSErrorMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.deviceBrowserViewSelectionDidChange(deviceBrowserView as IKDeviceBrowserViewMBS, device as ICDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
The device may be a ICCameraDeviceMBS or a ICScannerDeviceMBS.
ImageCaptureEventsMBS.deviceDidBecomeReady(device as ICDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
A camera device is ready, when it is ready to receive requests. A scanner device is ready when its functional units are found and the default functional unit is selected for use and is ready to receive requests. The device will become ready to receive requests only after a session is opened.
ImageCaptureEventsMBS.deviceDidChangeName(device as ICDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
This happens if the device module overrides the default name of the device reported by the device's transport layer, or if the name of the filesystem volume mounted by the device is changed by the user.
ImageCaptureEventsMBS.deviceDidChangeSharingState(device as ICDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
Any Image Capture client application can choose to share the device over the network using the sharing or webSharing facility in Image Capture.
ImageCaptureEventsMBS.deviceDidCloseSessionWithError(device as ICDeviceMBS, error as NSErrorMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
This event completes the process initiated by the message "requestCloseSession" sent to the device object. This event is also sent if the device module in control of the device ceases to control the device.
ImageCaptureEventsMBS.deviceDidEncounterError(device as ICDeviceMBS, error as NSErrorMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.deviceDidOpenSessionWithError(device as ICDeviceMBS, error as NSErrorMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
This event completes the process initiated by the requestOpenSession sent to the device object.
ImageCaptureEventsMBS.deviceDidReceiveButtonPress(device as ICDeviceMBS, buttonType as String)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
This event is sent only if a session is open on the device. The value of 'buttonType' argument is one of the ICButtonType* values defined above.
ImageCaptureEventsMBS.deviceDidReceiveCustomNotification(device as ICDeviceMBS, notification as Dictionary, data as Memoryblock)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
This event is sent only if a session is open on the device.
ImageCaptureEventsMBS.deviceDidReceiveStatusInformation(device as ICDeviceMBS, status as Dictionary)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
In Mac OS X 10.6 this event is not called for camera devices. This may change in the future releases of Mac OS X.
The 'status' dictionary contains two keys, ICStatusNotificationKey and ICLocalizedStatusNotificationKey, which are defined above. If type of 'device' is ICDeviceTypeScanner, the value of ICStatusNotificationKey will be one of the values defined in ICScannerDevice.h (e.g., ICScannerStatusWarmingUp, ICScannerStatusWarmUpDone, or ICScannerStatusRequestsOverviewScan); the value of ICLocalizedStatusNotificationKey will be a localized status information string suitable for displaying to the user.
ImageCaptureEventsMBS.deviceDidRemove(device as ICDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.deviceDidSendMessage(messageCode as UInt32, data as Memoryblock, error as NSErrorMBS, device as ICDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.scannerDeviceDidBecomeAvailable(scanner as ICScannerDeviceMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
Scanners require exclusive access, only one client can open a session on a scanner. The scanner is available if it does not have a session opened by another client. Attempting to open a session on a scanner that already has an open session for another client will result in an error. A client that wants to open a session on a scanner as soon as it is available should implement this method and send "requestOpenSession" message to scanner object from that method.
ImageCaptureEventsMBS.scannerDeviceDidCompleteOverviewScanWithError(scanner as ICScannerDeviceMBS, error as NSErrorMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.scannerDeviceDidCompleteScanWithError(scanner as ICScannerDeviceMBS, error as NSErrorMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.scannerDeviceDidScanToBandData(scanner as ICScannerDeviceMBS, Data as ICScannerBandDataMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
In memory transfer mode, this will send a band of size that has been selected by the client via the maxMemoryBandSize property.
ImageCaptureEventsMBS.scannerDeviceDidScanToURL(scanner as ICScannerDeviceMBS, URL as string, file as folderitem, data as MemoryBlock)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
If selectedFunctionalUnit is a document feeder, then this event will be sent once for each scanned page.
This event is sent when the scanner device receives the requested scan. If selectedFunctionalUnit is a document feeder, then this event will be sent once for each scanned page.
ImageCaptureEventsMBS.scannerDeviceDidSelectFunctionalUnit(scanner as ICScannerDeviceMBS, functionalUnit as Variant, Error as NSErrorMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
A functional unit is selected immediately after the scanner device is instantiated and in response to requestSelectFunctionalUnit method.
ImageCaptureEventsMBS.scannerDeviceViewDidEncounterError(scannerDeviceView as IKScannerDeviceViewMBS, error as NSErrorMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
ImageCaptureEventsMBS.scannerDeviceViewDidScanToBandData(scannerDeviceView as IKScannerDeviceViewMBS, data as ICScannerBandDataMBS, scanInfo as Dictionary, error as NSErrorMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
The 'data' parameter describes the scanned image data. Note that rotation/cropping/image adjustments are not applied yet. The 'scanInfo' parameter contains additional information (rotation angle, ...) that should be applied once the scan is completed.
Only called if transfermode is ICScannerTransferModeMemoryBased.
ImageCaptureEventsMBS.scannerDeviceViewDidScanToURL(scannerDeviceView as IKScannerDeviceViewMBS, url as String, file as FolderItem, fileData as MemoryBlock, error as NSErrorMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Image Capture | MBS AVFoundation Plugin | 14.3 | ✅ Yes | ❌ No | ❌ No | ❌ No |
Based on the IKScannerDeviceViewTransferMode the downloaded file will be saved on disk using the 'url', or returned in memory as Memoryblock.
The items on this page are in the following plugins: MBS AVFoundation Plugin.