Component: ImageCapture 
------------------------

Scan images from flatbet scanners on Mac.

Using the ImageKit framework from Apple to talk to flatbed or document feeder scanner.  
See [WIA](component_WIA.md) functions for Windows or older [TWAIN](component_Twain.md) functions.

| Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|
| [6.4](newinversion64.md "First functions introduced with version 6.4.") / [10.4](newinversion104.md "Newest functions in version 10.4.") | ✅ Yes | ❌ No | ❌ No | ❌ No | ❌ No |

  
| Item | Details |
|:--|:--|
| [IKDeviceBrowserPanel.Close](IKDeviceBrowserPanelClose.md)   Closes the window. | Mac only   6.5 |
| [IKDeviceBrowserPanel.GetCancelButtonLabel](IKDeviceBrowserPanelGetCancelButtonLabel.md)   Queries the caption of the cancel button. | Mac only   6.5 |
| [IKDeviceBrowserPanel.GetDisplaysLocalCameras](IKDeviceBrowserPanelGetDisplaysLocalCameras.md)   Queries whether to include local cameras in list. | Mac only   6.5 |
| [IKDeviceBrowserPanel.GetDisplaysLocalScanners](IKDeviceBrowserPanelGetDisplaysLocalScanners.md)   Queries whether to include local scanners in list. | Mac only   6.5 |
| [IKDeviceBrowserPanel.GetDisplaysNetworkCameras](IKDeviceBrowserPanelGetDisplaysNetworkCameras.md)   Queries whether to include network cameras in list. | Mac only   6.5 |
| [IKDeviceBrowserPanel.GetDisplaysNetworkScanners](IKDeviceBrowserPanelGetDisplaysNetworkScanners.md)   Queries whether to include network scanners in list. | Mac only   6.5 |
| [IKDeviceBrowserPanel.GetHeight](IKDeviceBrowserPanelGetHeight.md)   Queries height of dialog. | Mac only   6.5 |
| [IKDeviceBrowserPanel.GetMode](IKDeviceBrowserPanelGetMode.md)   Queries display mode. | Mac only   6.5 |
| [IKDeviceBrowserPanel.GetPrompt](IKDeviceBrowserPanelGetPrompt.md)   Queries the current prompt text. | Mac only   6.5 |
| [IKDeviceBrowserPanel.GetSelectButtonLabel](IKDeviceBrowserPanelGetSelectButtonLabel.md)   Queries the caption of the select button. | Mac only   6.5 |
| [IKDeviceBrowserPanel.GetWidth](IKDeviceBrowserPanelGetWidth.md)   Queries the width of the dialog. | Mac only   6.5 |
| [IKDeviceBrowserPanel.GetWindowTitle](IKDeviceBrowserPanelGetWindowTitle.md)   Queries the window title. | Mac only   6.5 |
| [IKDeviceBrowserPanel.Hide](IKDeviceBrowserPanelHide.md)   Hides the window. | Mac only   6.5 |
| [IKDeviceBrowserPanel.Reset](IKDeviceBrowserPanelReset.md)   Resets options to default. | Mac only   6.5 |
| [IKDeviceBrowserPanel.SelectedDeviceID](IKDeviceBrowserPanelSelectedDeviceID.md)   Queries ID of selected device. | Mac only   6.5 |
| [IKDeviceBrowserPanel.SelectedDeviceName](IKDeviceBrowserPanelSelectedDeviceName.md)   Queries name of selected device. | Mac only   6.5 |
| [IKDeviceBrowserPanel.SetCancelButtonLabel](IKDeviceBrowserPanelSetCancelButtonLabel.md)   Sets the caption of the cancel button. | Mac only   6.5 |
| [IKDeviceBrowserPanel.SetDisplaysLocalCameras](IKDeviceBrowserPanelSetDisplaysLocalCameras.md)   Sets whether to include local cameras in list. | Mac only   6.5 |
| [IKDeviceBrowserPanel.SetDisplaysLocalScanners](IKDeviceBrowserPanelSetDisplaysLocalScanners.md)   Sets whether to include local scanners in list. | Mac only   6.5 |
| [IKDeviceBrowserPanel.SetDisplaysNetworkCameras](IKDeviceBrowserPanelSetDisplaysNetworkCameras.md)   Sets whether to include network cameras in list. | Mac only   6.5 |
| [IKDeviceBrowserPanel.SetDisplaysNetworkScanners](IKDeviceBrowserPanelSetDisplaysNetworkScanners.md)   Sets whether to include network scanners in list. | Mac only   6.5 |
| [IKDeviceBrowserPanel.SetHeight](IKDeviceBrowserPanelSetHeight.md)   Sets the height of the dialog. | Mac only   6.5 |
| [IKDeviceBrowserPanel.SetMode](IKDeviceBrowserPanelSetMode.md)   Sets the display mode. | Mac only   6.5 |
| [IKDeviceBrowserPanel.SetPrompt](IKDeviceBrowserPanelSetPrompt.md)   Sets prompt text. | Mac only   6.5 |
| [IKDeviceBrowserPanel.SetSelectButtonLabel](IKDeviceBrowserPanelSetSelectButtonLabel.md)   Sets the caption of the select button. | Mac only   6.5 |
| [IKDeviceBrowserPanel.SetTrigger](IKDeviceBrowserPanelSetTrigger.md)   Sets the script trigger to notify on events. | Mac only   6.5 |
| [IKDeviceBrowserPanel.SetWidth](IKDeviceBrowserPanelSetWidth.md)   Sets the width of the window. | Mac only   6.5 |
| [IKDeviceBrowserPanel.SetWindowTitle](IKDeviceBrowserPanelSetWindowTitle.md)   Sets window title. | Mac only   6.5 |
| [IKDeviceBrowserPanel.Show](IKDeviceBrowserPanelShow.md)   Shows the window. | Mac only   6.5 |
| [IKDeviceBrowserPanel.Visible](IKDeviceBrowserPanelVisible.md)   Queries whether window is visible. | Mac only   6.5 |
| [IKScannerDevicePanel.ClearImage](IKScannerDevicePanelClearImage.md)   Clears all images. | Mac only   6.5 |
| [IKScannerDevicePanel.Close](IKScannerDevicePanelClose.md)   Closes the window. | Mac only   6.5 |
| [IKScannerDevicePanel.GetCombine](IKScannerDevicePanelGetCombine.md)   Queries the combine flag. | Mac only   6.5 |
| [IKScannerDevicePanel.GetDocumentName](IKScannerDevicePanelGetDocumentName.md)   Queries the document name. | Mac only   6.5 |
| [IKScannerDevicePanel.GetDownloadsDirectory](IKScannerDevicePanelGetDownloadsDirectory.md)   Queries download folder. | Mac only   6.5 |
| [IKScannerDevicePanel.GetHeight](IKScannerDevicePanelGetHeight.md)   Queries height of dialog. | Mac only   6.5 |
| [IKScannerDevicePanel.GetMode](IKScannerDevicePanelGetMode.md)   Queries mode of the scanner interface. | Mac only   6.5 |
| [IKScannerDevicePanel.GetOverviewControlLabel](IKScannerDevicePanelGetOverviewControlLabel.md)   Queries the label for the 'Overview' control. | Mac only   6.5 |
| [IKScannerDevicePanel.GetScanControlLabel](IKScannerDevicePanelGetScanControlLabel.md)   Queries the label for the 'Scan' control. | Mac only   6.5 |
| [IKScannerDevicePanel.GetScannerDeviceID](IKScannerDevicePanelGetScannerDeviceID.md)   Queries ID of current scanner device. | Mac only   6.5 |
| [IKScannerDevicePanel.GetScannerDeviceName](IKScannerDevicePanelGetScannerDeviceName.md)   Queries name of current scanner device. | Mac only   6.5 |
| [IKScannerDevicePanel.GetWidth](IKScannerDevicePanelGetWidth.md)   Queries the width of the dialog. | Mac only   6.5 |
| [IKScannerDevicePanel.GetWindowTitle](IKScannerDevicePanelGetWindowTitle.md)   Queries the window title. | Mac only   6.5 |
| [IKScannerDevicePanel.Hide](IKScannerDevicePanelHide.md)   Hides the window. | Mac only   6.5 |
| [IKScannerDevicePanel.ImageCount](IKScannerDevicePanelImageCount.md)   Queries number of images in queue. | Mac only   6.5 |
| [IKScannerDevicePanel.NextImage](IKScannerDevicePanelNextImage.md)   Queries path of next image. | Mac only   6.5 |
| [IKScannerDevicePanel.Reset](IKScannerDevicePanelReset.md)   Resets options to default. | Mac only   6.5 |
| [IKScannerDevicePanel.SetCloseTrigger](IKScannerDevicePanelSetCloseTrigger.md)   Sets a close trigger. | Mac only   8.1 |
| [IKScannerDevicePanel.SetCombine](IKScannerDevicePanelSetCombine.md)   Sets the combine flag. | Mac only   6.5 |
| [IKScannerDevicePanel.SetDocumentName](IKScannerDevicePanelSetDocumentName.md)   Set the document name. | Mac only   6.5 |
| [IKScannerDevicePanel.SetDownloadsDirectory](IKScannerDevicePanelSetDownloadsDirectory.md)   Sets the download directory. | Mac only   6.5 |
| [IKScannerDevicePanel.SetHeight](IKScannerDevicePanelSetHeight.md)   Sets the height of the dialog. | Mac only   6.5 |
| [IKScannerDevicePanel.SetMode](IKScannerDevicePanelSetMode.md)   Sets mode of the scanner interface. | Mac only   6.5 |
| [IKScannerDevicePanel.SetOverviewControlLabel](IKScannerDevicePanelSetOverviewControlLabel.md)   Sets the label for the 'Overview' control. | Mac only   6.5 |
| [IKScannerDevicePanel.SetScanControlLabel](IKScannerDevicePanelSetScanControlLabel.md)   Sets the label for the 'Scan' control. | Mac only   6.5 |
| [IKScannerDevicePanel.SetScannerDeviceID](IKScannerDevicePanelSetScannerDeviceID.md)   Selects scanner by ID. | Mac only   6.5 |
| [IKScannerDevicePanel.SetScannerDeviceName](IKScannerDevicePanelSetScannerDeviceName.md)   Selects scanner by name. | Mac only   6.5 |
| [IKScannerDevicePanel.SetTrigger](IKScannerDevicePanelSetTrigger.md)   Sets the trigger to notify when new picture arrives. | Mac only   6.5 |
| [IKScannerDevicePanel.SetWidth](IKScannerDevicePanelSetWidth.md)   Sets the width of the window. | Mac only   6.5 |
| [IKScannerDevicePanel.SetWindowTitle](IKScannerDevicePanelSetWindowTitle.md)   Sets window title. | Mac only   6.5 |
| [IKScannerDevicePanel.Show](IKScannerDevicePanelShow.md)   Shows the window. | Mac only   6.5 |
| [IKScannerDevicePanel.Visible](IKScannerDevicePanelVisible.md)   Queries whether window is visible. | Mac only   6.5 |
| [ImageCapture.CameraInfo](ImageCaptureCameraInfo.md)   Queries a value of current camera. | Mac only   8.3 |
| [ImageCapture.CloseDevice](ImageCaptureCloseDevice.md)   Requests to close a previously opened session on this device. | Mac only   6.4 |
| [ImageCapture.Contents](ImageCaptureContents.md)   Contents of the camera. | Mac only   8.3 |
| [ImageCapture.DeviceInfo](ImageCaptureDeviceInfo.md)   Queries information about device. | Mac only   6.4 |
| [ImageCapture.Devices](ImageCaptureDevices.md)   Queries list of devices. | Mac only   6.4 |
| [ImageCapture.DevicesJSON](ImageCaptureDevicesJSON.md)   Queries list of devices as JSON. | Mac only   8.3 |
| [ImageCapture.Download](ImageCaptureDownload.md)   Downloads a file from device. | Mac only   8.3 |
| [ImageCapture.Features](ImageCaptureFeatures.md)   Queries list of features. | Mac only   6.4 |
| [ImageCapture.GetFeatureValue](ImageCaptureGetFeatureValue.md)   Queries scanner vendor feature value. | Mac only   6.4 |
| [ImageCapture.GetFeatures](ImageCaptureGetFeatures.md)   Queries scanner vendor features with values as JSON. | Mac only   8.3 |
| [ImageCapture.GetParameter](ImageCaptureGetParameter.md)   Queries a parameter of current scanner functional unit. | Mac only   6.4 |
| [ImageCapture.GetParameters](ImageCaptureGetParameters.md)   Queries all parameter of current scanner functional unit as JSON. | Mac only   8.3 |
| [ImageCapture.ImagePaths](ImageCaptureImagePaths.md)   Queries list of image files. | Mac only   6.4 |
| [ImageCapture.Initialize](ImageCaptureInitialize.md)   Initializes Image Capture engine. | Mac only   6.4 |
| [ImageCapture.MediaFilenames](ImageCaptureMediaFilenames.md)   Queries file names list. | Mac only   8.3 |
| [ImageCapture.MediaFiles](ImageCaptureMediaFiles.md)   Queries all image, movie and audio files on the camera. | Mac only   8.3 |
| [ImageCapture.OpenDevice](ImageCaptureOpenDevice.md)   Requests to open a session on the device. | Mac only   6.4 |
| [ImageCapture.PDF](ImageCapturePDF.md)   Creates a PDF with all scanned documents. | Mac only   9.1 |
| [ImageCapture.PreferredDevice](ImageCapturePreferredDevice.md)   Returns UUID for preferred device. | Mac only   6.4 |
| [ImageCapture.RequestDeleteFiles](ImageCaptureRequestDeleteFiles.md)   Deletes files. | Mac only   8.3 |
| [ImageCapture.RequestDisableTethering](ImageCaptureRequestDisableTethering.md)   Disables tethering. | Mac only   8.3 |
| [ImageCapture.RequestEnableTethering](ImageCaptureRequestEnableTethering.md)   Enable tethering. | Mac only   8.3 |
| [ImageCapture.RequestOverviewScan](ImageCaptureRequestOverviewScan.md)   Starts an overview scan on selectedFunctionalUnit. | Mac only   6.4 |
| [ImageCapture.RequestScan](ImageCaptureRequestScan.md)   Starts a scan on selectedFunctionalUnit. | Mac only   6.4 |
| [ImageCapture.RequestSelectFunctionalUnit](ImageCaptureRequestSelectFunctionalUnit.md)   Requests the scanner device to select a functional unit. | Mac only   6.4 |
| [ImageCapture.RequestSyncClock](ImageCaptureRequestSyncClock.md)   Synchronizes camera clock. | Mac only   8.3 |
| [ImageCapture.RequestTakePicture](ImageCaptureRequestTakePicture.md)   Capture a new image using the camera. | Mac only   8.3 |
| [ImageCapture.SetFeatureValue](ImageCaptureSetFeatureValue.md)   Sets a vendor scanner feature value. | Mac only   6.4 |
| [ImageCapture.SetItemsAddedScript](ImageCaptureSetItemsAddedScript.md)   Sets script to call when new picture is added. | Mac only   10.4 |
| [ImageCapture.SetParameter](ImageCaptureSetParameter.md)   Sets a parameter for current scanner functional device. | Mac only   6.4 |
| [ImageCapture.Thumbnail](ImageCaptureThumbnail.md)   Queries thumbnail for a file if available. | Mac only   8.3 |
| [ImageCapture.cancelScan](ImageCapturecancelScan.md)   Cancels current scan. | Mac only   6.4 |

94 functions shown.

These functions require a license (57%).

### Release notes

- **Version 15.1**
    - Added timeout parameter to [ImageCapture.RequestScan](https://www.mbsplugins.eu/ImageCaptureRequestScan.shtml) function.
- **Version 14.1**
    - Improved [ImageCapture](https://www.mbsplugins.eu/component_ImageCapture.shtml) functions to connect scan dialogs with other functions. This allows you to set parameters without the GUI.
- **Version 13.5**
    - Improved [IKDeviceBrowserPanel.Show](https://www.mbsplugins.eu/IKDeviceBrowserPanelShow.shtml) and [IKScannerDevicePanel.Show](https://www.mbsplugins.eu/IKScannerDevicePanelShow.shtml) functions to internally call [ImageCapture.Initialize](https://www.mbsplugins.eu/ImageCaptureInitialize.shtml) if needed.
- **Version 10.5**
    - Added SystemSymbolName selector for [ImageCapture.DeviceInfo](https://www.mbsplugins.eu/ImageCaptureDeviceInfo.shtml) function.
- **Version 10.4**
    - Added [ImageCapture.SetItemsAddedScript](https://www.mbsplugins.eu/ImageCaptureSetItemsAddedScript.shtml) function.
- **Version 10.1**
    - Removed check from [ImageCapture.RequestScan](https://www.mbsplugins.eu/ImageCaptureRequestScan.shtml) to check for open session.
- **Version 10.0**
    - Changed [ImageCapture.Devices](https://www.mbsplugins.eu/ImageCaptureDevices.shtml) to filter duplicates.
    - Changed [ImageCapture.GetParameter](https://www.mbsplugins.eu/ImageCaptureGetParameter.shtml) and [ImageCapture.SetParameter](https://www.mbsplugins.eu/ImageCaptureSetParameter.shtml) to return an error if you try to set parameter of a functional unit, but none is selected.
    - Increased timeouts for [ImageCapture](https://www.mbsplugins.eu/component_ImageCapture.shtml) functions.
- **Version 9.1**
    - Added [ImageCapture.PDF](http://www.mbsplugins.eu/ImageCapturePDF.shtml) function to return PDF document for scanned documents.
- **Version 8.5**
    - Added timeouts for [ImageCapture](http://www.mbsplugins.eu/component_ImageCapture.shtml) functions so the plugin doesn't wait endless. 30s for opening session, 20s for closing, 30s to select unit, 60s to scan.
    - Changed [ImageCapture.RequestSelectFunctionalUnit](http://www.mbsplugins.eu/ImageCaptureRequestSelectFunctionalUnit.shtml) to return error directly if you request an unavailable functional unit.
    - Improved [ImageCapture.RequestSelectFunctionalUnit](http://www.mbsplugins.eu/ImageCaptureRequestSelectFunctionalUnit.shtml) to better track which unit is selected and skip the request if the device is already selected.

### Blog Entries

- [MBS @ FMTraining.TV - 25 Ways to Improve Your Database Using the FileMaker MonkeyBread Plug-in - Day 3](https://www.mbsplugins.de/archive/2025-01-24/MBS_@_FMTrainingTV_-_25_Ways_t/monkeybreadsoftware_blog_filemaker)
- [MBS @ FMTraining.TV - Scanning in FileMaker with the MonkeyBread Plug-in](https://www.mbsplugins.de/archive/2024-04-28/MBS_@_FMTrainingTV_-_Scanning_/monkeybreadsoftware_blog_filemaker)
- [Can FileMaker do that?](https://www.mbsplugins.de/archive/2024-02-03/Can_FileMaker_do_that/monkeybreadsoftware_blog_filemaker)
- [Ways to import images to FileMaker](https://www.mbsplugins.de/archive/2022-02-09/Ways_to_import_images_to_FileM/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin, June 2021 News](https://www.mbsplugins.de/archive/2021-06-01/MBS_FileMaker_Plugin_June_2021/monkeybreadsoftware_blog_filemaker)
- [Combined Components with MBS FileMaker Plugin](https://www.mbsplugins.de/archive/2021-03-29/Combined_Components_with_MBS_F/monkeybreadsoftware_blog_filemaker)
- [What is new in the MBS FileMaker Plugin Version 10.4](https://www.mbsplugins.de/archive/2020-09-22/What_is_new_in_the_MBS_FileMak/monkeybreadsoftware_blog_filemaker)
- [Import images from cameras on MacOS with FileMaker](https://www.mbsplugins.de/archive/2020-08-28/Import_images_from_cameras_on_/monkeybreadsoftware_blog_filemaker)
- [Combine MBS functions to automate processes in FileMaker](https://www.mbsplugins.de/archive/2019-04-11/Combine_MBS_functions_to_autom/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 8.3 released](https://www.mbsplugins.de/archive/2018-07-17/MBS_FileMaker_Plugin_83_releas/monkeybreadsoftware_blog_filemaker)

### FileMaker Magazin

- [Ausgabe 6/2022, Seite 15 bis 16](https://filemaker-magazin.de/neuigkeit/4206-Appetithappen-FMM_202206)
- [Ausgabe 6/2022, Seite 12 bis 13](https://filemaker-magazin.de/neuigkeit/4206-Appetithappen-FMM_202206)

### Example Databases

- [Mac only/ImageCapture/Camera Import](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Mac%20only/ImageCapture/Camera%20Import.shtml#1ScriptAnchor_)
- [Mac only/ImageCapture/ImageCapture Dialogs](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Mac%20only/ImageCapture/ImageCapture%20Dialogs.shtml#3ScriptAnchor_)
- [Mac only/ImageCapture/ImageCapture](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Mac%20only/ImageCapture/ImageCapture.shtml#1ScriptAnchor_)

[HTML Version](component_ImageCapture.shtml)