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
This event is sent when an object is added to the device.

The object may be an instance of ICCameraFolder or ICCameraFile class.

Some examples using this event:

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
This event is sent when an object or objects are added to the device.

Instead of receive one event per object, an array of objects is sent.
The objects may be instances of ICCameraFolder or ICCameraFile class.

Some examples using this event:

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
This event is sent when the camera device is done enumerating its content and is ready to receive requests.

A session must be opened on the device in order to enumerate its content and make it ready to receive requests.

Some examples using this event:

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 event is sent when the capability of a device changes.

This usually happens when the device module takes control or yields control of the device.

Some examples using this event:

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
Files have been deleted.

This event is sent after the camera device completes a delete operation initiated by sending a requestDeleteFiles event to that device.

Some examples using this event:

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
Download of file finished.

Some examples using this event:

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
Tells the client when an Apple device has been locked, and media is unavailable until the restriction has been removed.

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
Reading file data finished.

Some examples using this event:

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
This event is sent to the delegate to provide status of the download operation.

Some examples using this event:

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
This event is sent when the metadata requested for an item on a device is available.

Some examples using this event:

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
This event is sent to the delegate to convey a PTP event.

Some examples using this event:

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
This event is sent when the thumbnail requested for an item on a device is available.

Some examples using this event:

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
Tells the client when an Apple device has been unlocked, paired to the host, and media is available.

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
This event is sent when an object is removed from the device.

The object may be an instance of ICCameraFolder or ICCameraFile class.

Some examples using this event:

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
This event is sent when an object or objects are removed from the device.

The objects may be instances of ICCameraFolder or ICCameraFile class. This method supercedes cameraDeviceDidRemoveItem method described above.

Some examples using this event:

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
This event is sent when an object or objects are renamed on the device.

The objects may be instances of ICCameraFolder or ICCameraFile class.

Some examples using this event:

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
Called when a requestSendPTPCommand event got a response or error.

Some examples using this event:

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
A file upload was completed.

Some examples using this event:

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
This event is sent for each file that gets downloaded.

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
This event is sent every time the camera device reports an error.

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
This event is sent when the user selection did change.

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 event is sent if the name of a device changes.

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.

Some examples using this event:

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
This event is sent when the sharing state of a device has changes.

Any Image Capture client application can choose to share the device over the network using the sharing or webSharing facility in Image Capture.

Some examples using this event:

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
This event is sent to the delegate to inform that a device has been added.

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.

Some examples using this event:

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
This event is sent after the device browser completes sending deviceBrowserDidAddDevice event for all local devices.

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.

Some examples using this event:

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
This event is sent to the delegate to inform that a device has been removed.

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.

Some examples using this event:

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
This event is sent when an event that occurred on the device may be of interest to the client application.

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.

Some examples using this event:

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
This event is sent every time the device browser reports an error.

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
This event is sent when the user selection did change.

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
This event is sent when the device is ready to receive requests.

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.

Some examples using this event:

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 event is sent if the name of a device changes.

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
This event is sent when the sharing state of a device has changes.

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 is sent when a session is closed on a device.

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.

Some examples using this event:

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
This event is sent to the device delegate when a camera or scanner device encounters an error.

Some examples using this event:

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 is sent when a session is opened on a device.

This event completes the process initiated by the requestOpenSession sent to the device object.

Some examples using this event:

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 to the device delegate if a button is pressed on the device.

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.

Some examples using this event:

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 to the device delegate the device sends a custom notification 'notification' with an arbitrary byte buffer 'data'.

This event is sent only if a session is open on the device.

Some examples using this event:

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
This event is sent when status information is received from a camera or a scanner.

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.

Some examples using this event:

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
This event is sent to the delegate to inform that a device has been removed.

Some examples using this event:

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
The call to requestSendMessage was successful.

Some examples using this event:

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
This event is sent when another client closes an open session on the scanner.

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.

Some examples using this event:

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
This event is sent after the scanner device completes an overview scan.

Some examples using this event:

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
This event is sent after the scanner device completes a scan.

Some examples using this event:

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
This event is sent when the scanner device receives the requested scan progress notification and a band of data is sent for each notification received.

In memory transfer mode, this will send a band of size that has been selected by the client via the maxMemoryBandSize property.

Some examples using this event:

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
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.
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.

Some examples using this event:

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
This event is sent when a functional unit is selected on the scanner device.

A functional unit is selected immediately after the scanner device is instantiated and in response to requestSelectFunctionalUnit method.

Some examples using this event:

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
This event is sent every time the scanner device reports an error.

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
For memory a based transfer this event is sent for every time an image band of data was scanned.

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
For file based transfer this event is sent for each image that gets scanned.

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.


The biggest plugin in space...