Crate objc2_image_capture_core

Bindings to the ImageCaptureCore framework

See Apple’s docs and the general docs on framework crates for more information.

Structs

ICCameraDeviceICCameraDevice and ICDevice

ICCameraDevice is a concrete subclass of ICDevice class. ICDeviceBrowser creates instances of this class.

ICCameraFileICCameraFile and ICCameraItem

This class represents a file on an ICCameraDevice object.

ICCameraFolderICCameraFolder and ICCameraItem

This class represents a folder on an ICCameraDevice object.

ICCameraItemICCameraItem

ICCameraItem is an abstract class that represents an item in an ICCameraDevice object. ICCameraDevice object creates instances of two concrete subclasses of ICCameraItem: ICCameraFolder and ICCameraFile.

ICDeviceICDevice

ICDevice is an abstract class that represents a device supported by Image Capture facility. ImageCaptureCore defines two concrete subclasses of ICDevice, ICCameraDevice and ICScannerDevice. ICDeviceBrowser creates instances of these two subclasses to represent cameras and scanners it finds.

ICDeviceBrowserICDeviceBrowser

The ICDeviceBrowser object is used to find devices such as digital cameras and scanners that are supported by Image Capture. These device may be directly attached to the USB or FireWire bus on the host computer, or available over a TCP/IP network. This object communicates with an Image Capture agent process asynchronously to accomplish this.

ICDeviceLocationTypeICDevice

Image Capture Device Location Types

ICDeviceLocationTypeMaskICDevice

Image Capture Device Location Type Mask

ICDeviceTypeICDevice

Image Capture Device Types

ICDeviceTypeMaskICDevice

Image Capture Device Type Mask

ICEXIFOrientationTypeImageCaptureConstants

Apple’s documentation

ICLegacyReturnCodeImageCaptureConstants

Apple’s documentation

ICMediaPresentationICCameraDevice

Apple’s documentation

ICReturnCodeImageCaptureConstants

Apple’s documentation

ICReturnCodeOffsetImageCaptureConstants

Apple’s documentation

ICReturnConnectionErrorCodeImageCaptureConstants

Apple’s documentation

ICReturnDownloadErrorCodeImageCaptureConstants

Apple’s documentation

ICReturnMetadataErrorCodeImageCaptureConstants

Apple’s documentation

ICReturnObjectErrorCodeImageCaptureConstants

Apple’s documentation

ICReturnPTPDeviceErrorCodeImageCaptureConstants

Apple’s documentation

ICReturnThumbnailErrorCodeImageCaptureConstants

Apple’s documentation

ICScannerBandDataICScannerBandData

Apple’s documentation

ICScannerBitDepthICScannerFunctionalUnits

Bits per channel in the scanned image.

ICScannerColorDataFormatTypeICScannerFunctionalUnits

Identifies color data formats. Only relevant for multi-channel data. Corresponds to “ICAP_PLANARCHUNKY” of the TWAIN Specification.

ICScannerDeviceICDevice and ICScannerDevice

ICScannerDevice is a concrete subclass of ICDevice class. ICDeviceBrowser creates instances of this class.

ICScannerDocumentTypeICScannerFunctionalUnits

Document size types. Corresponds to “ICAP_SUPPORTEDSIZES” used by the Image Catpure scanner modules. Also refer to TWAIN 1.9 Specification, page 9-483.

ICScannerFeatureICScannerFunctionalUnits

ICScannerFeature class is an abstract base class used to describe a scanner feature. ImageCaptureCore defines three concrete subclasses of ICScannerFeature: ICScannerFeatureEnumeration, ICScannerFeatureRange and ICScannerFeatureBoolean.

ICScannerFeatureBooleanICScannerFunctionalUnits

ICScannerFeatureBoolean object is used to represent a property of a scanner functional unit whose value can be YES or NO.

ICScannerFeatureEnumerationICScannerFunctionalUnits

ICScannerFeatureEnumeration object is used to represent a feature of a scanner functional unit that can have one of several discrete values.

ICScannerFeatureRangeICScannerFunctionalUnits

ICScannerFeatureRange object is used to represent a property of a scanner functional unit whose value lies within a range.

ICScannerFeatureTemplateICScannerFunctionalUnits

ICScannerFeatureTemplate object is used to define a group of one or more rectangular scan areas that can be used with a scanner functional unit.

ICScannerFeatureTypeICScannerFunctionalUnits

Scanner Feature Types

ICScannerFunctionalUnitICScannerFunctionalUnits

ICScannerFunctionalUnit is an abstract class that represents a scanner functiona unit. ImageCaptureCore defines three concrete subclasses of ICScannerFunctionalUnit: ICScannerFunctionalUnitFlatbed, ICScannerFunctionalUnitPositiveTransparency, ICScannerFunctionalUnitNegativeTransparency and ICScannerFunctionalUnitDocumentFeeder. ICScannerDevice creates instances of these concrete subclasses.

ICScannerFunctionalUnitDocumentFeederICScannerFunctionalUnits

ICScannerFunctionalUnitDocumentFeeder is a concrete subclass of ICScannerFunctionalUnit class. ICScannerDevice creates instances of this class.

ICScannerFunctionalUnitFlatbedICScannerFunctionalUnits

ICScannerFunctionalUnitFlatbed is a concrete subclass of ICScannerFunctionalUnit class. ICScannerDevice creates instances of this class.

ICScannerFunctionalUnitNegativeTransparencyICScannerFunctionalUnits

ICScannerFunctionalUnitNegativeTransparency is a concrete subclass of ICScannerFunctionalUnit class. ICScannerDevice creates instances of this class.

ICScannerFunctionalUnitPositiveTransparencyICScannerFunctionalUnits

ICScannerFunctionalUnitPositiveTransparency is a concrete subclass of ICScannerFunctionalUnit class. ICScannerDevice creates instances of this class.

ICScannerFunctionalUnitStateICScannerFunctionalUnits

A flag to indicate the scanner functional unit’s state

ICScannerFunctionalUnitTypeICScannerFunctionalUnits

Scanner Functional Unit Types

ICScannerMeasurementUnitICScannerFunctionalUnits

Unit of measurement used by the scanner. This corresponds to values used for ICAP_UNITS as defined in the TWAIN Specification.

ICScannerPixelDataTypeICScannerFunctionalUnits

Pixel data types. Corresponds to “ICAP_PIXELTYPE” of the TWAIN Specification.

ICScannerTransferModeICScannerDevice

Transfer mode to be used when transferring scan data from the scanner functional unit.

Statics

ICAuthorizationStatusAuthorized^⚠ICDeviceBrowser

Apple’s documentation

ICAuthorizationStatusDenied^⚠ICDeviceBrowser

Apple’s documentation

ICAuthorizationStatusNotDetermined^⚠ICDeviceBrowser

Apple’s documentation

ICAuthorizationStatusRestricted^⚠ICDeviceBrowser

Apple’s documentation

ICButtonTypeCopy^⚠ICScannerDevice

ICButtonTypeCopy

ICButtonTypeMail^⚠ICScannerDevice

ICButtonTypeMail

ICButtonTypePrint^⚠ICScannerDevice

ICButtonTypePrint

ICButtonTypeScan^⚠ICScannerDevice

ICButtonTypeScan

ICButtonTypeTransfer^⚠ICScannerDevice

ICButtonTypeTransfer

ICButtonTypeWeb^⚠ICScannerDevice

ICButtonTypeWeb

ICCameraDeviceCanAcceptPTPCommands^⚠ICCameraDevice and ICDevice

Indicates that the camera can accept PTP commands.

ICCameraDeviceCanDeleteAllFiles^⚠ICCameraDevice and ICDevice

Indicates that the camera can delete all files in a single operation while it is connected.

ICCameraDeviceCanDeleteOneFile^⚠ICCameraDevice and ICDevice

Indicates that the camera can delete a file at a time while it is connected.

ICCameraDeviceCanReceiveFile^⚠ICCameraDevice and ICDevice

Indicates that the host can upload files to the camera.

ICCameraDeviceCanSyncClock^⚠ICCameraDevice and ICDevice

Indicates that the camera can synchronize its date and time with that of the host computer.

ICCameraDeviceCanTakePicture^⚠ICCameraDevice and ICDevice

Indicates that the camera can capture a picture while it is connected, if the client sends a ‘requestTakePicture’ message to it.

ICCameraDeviceCanTakePictureUsingShutterReleaseOnCamera^⚠ICCameraDevice and ICDevice

Indicates that the camera can capture a picture while it is connected, if the user presses the shutter release on the camera.

ICCameraDeviceSupportsHEIF^⚠ICCameraDevice and ICDevice

Indicates that the camera supports HEIF transcoding, and can change the presentation of converted assets and original assets on the fly.

ICDeleteAfterSuccessfulDownload^⚠ICCameraItem

ICDeleteAfterSuccessfulDownload

ICDeleteCanceled^⚠ICCameraDevice

The value for this key should be an NSArray <ICCameraItem >

ICDeleteErrorCanceled^⚠ICCameraDevice

The value for this key should be an ICCameraItem*

ICDeleteErrorDeviceMissing^⚠ICCameraDevice

The value for this key should be an ICCameraItem*

ICDeleteErrorFileMissing^⚠ICCameraDevice

The value for this key should be an ICCameraItem*

ICDeleteErrorReadOnly^⚠ICCameraDevice

The value for this key should be an ICCameraItem*

ICDeleteFailed^⚠ICCameraDevice

The value for this key should be an NSArray <ICCameraItem >

ICDeleteSuccessful^⚠ICCameraDevice

The value for this key should be an NSArray <ICCameraItem >

ICDeviceCanEjectOrDisconnect^⚠ICDevice

Indicates either the device is mounted as a mass-storage volume and can be ejected or the it is a remote device with an active connection that can be disconnected.

ICDeviceLocationDescriptionBluetooth^⚠ICDevice

This description is returned for locationDescription property of a device connected via Bluetooth.

ICDeviceLocationDescriptionFireWire^⚠ICDevice

This description is returned for locationDescription property of a device connected to a FireWire port.

ICDeviceLocationDescriptionMassStorage^⚠ICDevice

This description is returned for locationDescription property of a device that is mounted as a mass-storage volume.

ICDeviceLocationDescriptionUSB^⚠ICDevice

This description is returned for locationDescription property of a device connected to a USB port.

ICDownloadSidecarFiles^⚠ICCameraItem

ICDownloadSidecarFiles

ICDownloadsDirectoryURL^⚠ICCameraItem

ICDownloadsDirectoryURL

ICEnumerationChronologicalOrder^⚠ICDevice

Apple’s documentation

ICErrorDomain^⚠ImageCaptureConstants

Type representing EXIF Orientation tag value

ICImageSourceShouldCache^⚠ICCameraItem

Apple’s documentation

ICImageSourceThumbnailMaxPixelSize^⚠ICCameraItem

Use of this key will override any custom thumbnail size requested, ignoring the ICImageSourceThumbnailMaxPixelSize option entirely.

ICLocalizedStatusNotificationKey^⚠ICDevice

Key for a localized notification string.

ICOverwrite^⚠ICCameraItem

ICOverwrite

ICRunLoopMode^⚠ImageCaptureConstants

Apple’s documentation

ICSaveAsFilename^⚠ICCameraItem

ICSaveAsFilename

ICSavedAncillaryFiles^⚠ICCameraItem

ICSavedAncillaryFiles

ICSavedFilename^⚠ICCameraItem

ICSavedFilename

ICScannerStatusRequestsOverviewScan^⚠ICScannerDevice

ICScannerStatusRequestsOverviewScan

ICScannerStatusWarmUpDone^⚠ICScannerDevice

ICScannerStatusWarmUpDone

ICScannerStatusWarmingUp^⚠ICScannerDevice

ICScannerStatusWarmingUp

ICStatusCodeKey^⚠ICDevice

One of values defined in ICReturnCode.

ICStatusNotificationKey^⚠ICDevice

Key for a non-localized notification string.

ICTransportTypeBluetooth^⚠ICDevice

Indicates that the device uses Bluetooth transport.

ICTransportTypeExFAT^⚠ICDevice

Indicates that the device use mounts as a exFat storage volume.

ICTransportTypeFireWire^⚠ICDevice

Indicates that the device uses FireWire transport.

ICTransportTypeMassStorage^⚠ICDevice

Indicates that the device use mounts as a mass-storage volume.

ICTransportTypeProximity^⚠ICDevice

Indicates that the device transport is based on proximity instead of a predefined phyiscal layer.

ICTransportTypeTCPIP^⚠ICDevice

Indicates that the device uses TCP/IP transport. These devices are discovered using Bonjour.

ICTransportTypeUSB^⚠ICDevice

Indicates that the device uses USB transport.

ICTruncateAfterSuccessfulDownload^⚠ICCameraItem

The value for this key should be an NSNumber object representing a boolean value. If this value is YES, and the file is a JPG converted from HEIC on device, the padding will be stripped from the end of the file. Note that the file size property of the ICCameraItem object will not be updated to reflect the newly truncated image. This option has no effect for images coming from devices without the ability to convert from HEIC to JPG.

Traits

ICCameraDeviceDelegateICCameraDevice and ICDevice

A delegate of ICCameraDevice must conform to ICCameraDeviceDelegate protocol.

ICCameraDeviceDownloadDelegateICCameraDevice

The object passed in as ‘downloadDelegate’ in the ‘requestDownloadFile:options:downloadDelegate:didDownloadSelector:contextInfo:’ message must conform to ICCameraDeviceDownloadDelegate protocol.

ICDeviceBrowserDelegateICDeviceBrowser

A delegate of ICDeviceBrowser must conform to ICDeviceBrowserDelegate protocol.

ICDeviceDelegateICDevice

A delegate of ICDevice must conform to ICDeviceDelegate protocol.

ICScannerDeviceDelegateICDevice and ICScannerDevice

A delegate of ICScannerDevice must conform to ICScannerDeviceDelegate protocol.

Type Aliases

ICAuthorizationStatusICDeviceBrowser

Apple’s documentation

ICCameraItemMetadataOptionICCameraItem

Apple’s documentation

ICCameraItemThumbnailOptionICCameraItem

Apple’s documentation

ICDeleteErrorICCameraDevice

Apple’s documentation

ICDeleteResultICCameraDevice

Apple’s documentation

ICDeviceCapabilityICDevice

Apple’s documentation

ICDeviceLocationOptionsICDevice

Apple’s documentation

ICDeviceStatusICDevice

Apple’s documentation

ICDeviceTransportICDevice

Apple’s documentation

ICDownloadOptionICCameraItem

Apple’s documentation

ICSessionOptionsICDevice

Apple’s documentation

ICUploadOptionICCameraDevice

Apple’s documentation