Platforms to show: All Mac Windows Linux Cross-Platform

Back to ICScannerFunctionalUnitMBS class.

ICScannerFunctionalUnitMBS.acceptsThresholdForBlackAndWhiteScanning as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Indicates if this functional unit accepts threshold value to be used when performing a scan in black & white.

(Read only property)

ICScannerFunctionalUnitMBS.bitDepth as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The bit depth to use when performing the final scan.

This will always be one of the supported bit depths.
(Read and Write property)

ICScannerFunctionalUnitMBS.canPerformOverviewScan as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Indicates if this functional unit can perfrom an overview scan.

Not all functional units can perform an overview scan. For example, a document feeder or a sheet feeder unit cannot perform an overview scan.
(Read only property)

Some examples using this property:

ICScannerFunctionalUnitMBS.defaultThresholdForBlackAndWhiteScanning as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Default threshold value used when performing a scan in black & white.

This value is from 0 to 255.
(Read only property)

ICScannerFunctionalUnitMBS.documentSize as NSSizeMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Document size of the current document type expressed in current measurement unit.

(Read only property)

ICScannerFunctionalUnitMBS.documentType as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Current document type.

This will always be one of the supported document types.
(Read and Write property)

Some examples using this property:

ICScannerFunctionalUnitMBS.measurementUnit as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Current measurement unit. This will always be one of the supported measurement units.

(Read and Write property)

Some examples using this property:

ICScannerFunctionalUnitMBS.nativeXResolution as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Optical resolution along the X axis.

(Read only property)

ICScannerFunctionalUnitMBS.nativeYResolution as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Optical resolution along the Y axis.

(Read only property)

ICScannerFunctionalUnitMBS.overviewImage as Variant

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Overview scan image.

This property will be nil for functional units that do not support overview scans.
Value is a CGImageMBS.
(Read only property)

Some examples using this property:

ICScannerFunctionalUnitMBS.overviewResolution as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Overview image resolution.

Value assigned to this will be contrained by resolutions allowed by the device.
(Read and Write property)

Some examples using this property:

ICScannerFunctionalUnitMBS.overviewScanInProgress as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Indicates if an overview scan is in progress.

(Read only property)

Some examples using this property:

ICScannerFunctionalUnitMBS.physicalSize as NSSizeMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Physical size of the scan area in current measurement unit.

(Read only property)

Some examples using this property:

ICScannerFunctionalUnitMBS.pixelDataType as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The pixel data type.

See ICScannerPixelDataType* constants.
(Read and Write property)

ICScannerFunctionalUnitMBS.preferredResolutions as NSIndexSetMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Current scan resolution.

This will always be one of the supported resolution values.
(Read only property)

ICScannerFunctionalUnitMBS.preferredScaleFactors as NSIndexSetMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Preferred scale factors in percentage.

(Read only property)

ICScannerFunctionalUnitMBS.resolution as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Current scan resolution.

This will always be one of the supported resolution values.
(Read and Write property)

ICScannerFunctionalUnitMBS.scaleFactor as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Current scale factor.

This will always be one of the supported scale factor values.
(Read only property)

ICScannerFunctionalUnitMBS.scanArea as NSRectMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
This property along with scanAreaOrientation describes the area to be scanned.

(Read and Write property)

Some examples using this property:

ICScannerFunctionalUnitMBS.scanAreaOrientation as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Desired orientation of the scan area.

This property along with scanArea describes the area to be scanned.
This property is set to ICEXIFOrientation1 initially. This property is not used by the ICScannerFunctionalUnitDocumentFeeder subclass.

Possible values:
ICEXIFOrientation11Normal
ICEXIFOrientation22Flipped horizontally
ICEXIFOrientation33Rotated 180°
ICEXIFOrientation44Flipped vertically
ICEXIFOrientation55Rotated 90° CCW and flipped vertically
ICEXIFOrientation66Rotated 90° CCW
ICEXIFOrientation77Rotated 90° CW and flipped vertically
ICEXIFOrientation88Rotated 90° CW
(Read and Write property)

ICScannerFunctionalUnitMBS.scanInProgress as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Indicates if a scan is in progress.

(Read only property)

Some examples using this property:

ICScannerFunctionalUnitMBS.scanProgressPercentDone as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Indicates percentage of scan completed.

(Read only property)

Some examples using this property:

ICScannerFunctionalUnitMBS.state as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Indicates the current state of the functional unit.

See ICScannerFunctionalUnitState* constants.
(Read only property)

ICScannerFunctionalUnitMBS.supportedBitDepths as NSIndexSetMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Supported bit depths.

The values in this set are valid values defined by ICScannerBitDepth.
(Read only property)

ICScannerFunctionalUnitMBS.supportedDocumentTypes as NSIndexSetMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Supported document types.

The values in this set are valid values defined by ICScannerDocumentType.
(Read only property)

ICScannerFunctionalUnitMBS.supportedMeasurementUnits as NSIndexSetMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Supported measurement units. The values in this set are valid values defined by ICScannerMeasurementUnit.

(Read only property)

ICScannerFunctionalUnitMBS.supportedResolutions as NSIndexSetMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Supported scan resolutions in DPI.

(Read only property)

Some examples using this property:

ICScannerFunctionalUnitMBS.supportedScaleFactors as NSIndexSetMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Supported scale factors in percentage.

(Read only property)

ICScannerFunctionalUnitMBS.thresholdForBlackAndWhiteScanning as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Threshold value to be used when performing a scan in black & white.

This value should be from 0 to 255.
(Read and Write property)

ICScannerFunctionalUnitMBS.type as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Functional unit type.

See ICScannerFunctionalUnitType* constants.
(Read only property)

ICScannerFunctionalUnitMBS.usesThresholdForBlackAndWhiteScanning as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Image Capture MBS AVFoundation Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Indicates if this functional unit uses threshold value to be used when performing a scan in black & white.

(Read only property)

The items on this page are in the following plugins: MBS AVFoundation Plugin.


The biggest plugin in space...