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	Desktop only

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:

• /MacFrameworks/Image Capture/Image Capture Views
• /MacFrameworks/Image Capture/Scanner Browser

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	Desktop only

This event is sent after the scanner device completes an overview scan.

Some examples using this event:

• /MacFrameworks/Image Capture/Scanner Browser

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	Desktop only

This event is sent after the scanner device completes a scan.

Some examples using this event:

• /MacFrameworks/Image Capture/Scanner Browser

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	Desktop only

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:

• /MacFrameworks/Image Capture/Scanner Browser

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	Desktop only

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:

• /MacFrameworks/Image Capture/Scanner Browser

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	Desktop only

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:

• /MacFrameworks/Image Capture/Scanner Browser

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	Desktop only

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	Desktop only

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	Desktop only

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.