Monkeybread Xojo plugin - ImageCaptureEventsMBS events

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The call to requestSendMessage was successful.