Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
ImageCapture.GetParameters
Queries all parameter of current scanner functional unit as JSON.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
ImageCapture | 8.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | ❌ No |
Parameters
none
Result
Returns JSON or error.
Description
Queries all parameter of current scanner functional unit as JSON.Examples
Query parameters:
Set Variable [ $json; Value: MBS( "ImageCapture.GetParameters" ) ]
Example result:
{
"defaultThresholdForBlackAndWhiteScanning" : 127,
"supportedBitDepths" : [
"8"
],
"availableFunctionalUnitTypes" : [
"Flatbed",
"DocumentFeeder"
],
"pixelDataType" : 2,
"nativeXResolution" : 1200,
"bitDepth" : 8,
"scanAreaOrientation" : 1,
"scaleFactor" : 100,
"acceptsThresholdForBlackAndWhiteScanning" : 0,
"documentWidth" : 21.000000000000004,
"scanArea" : {
"x" : 0,
"y" : 0,
"h" : 0,
"w" : 0
},
"transferMode" : "File",
"supportedScaleFactors" : [
"100"
],
"physicalWidth" : 21.59,
"documentName" : "Scan",
"downloadsDirectory" : "\/Users\/cs\/Pictures",
"documentHeight" : 29.700000000000003,
"documentType" : "A4",
"supportedMeasurementUnits" : [
"Inches",
"Centimeters",
"Pixels"
],
"resolution" : 200,
"scanInProgress" : 0,
"preferredScaleFactors" : [
"100"
],
"maxMemoryBandSize" : 1048576,
"thresholdForBlackAndWhiteScanning" : 0,
"measurementUnit" : "Centimeters",
"physicalHeight" : 29.701066666666666,
"canPerformOverviewScan" : 1,
"nativeYResolution" : 1200,
"scanProgressPercentDone" : 0,
"state" : 1,
"supportedDocumentTypes" : [
"A4",
"B5",
"USLetter",
"A5",
"ISOB6",
"USExecutive",
"A6",
"C5",
"C6",
"A7",
"A8",
"ISOB5",
"ISOB7",
"ISOB8",
"JISB6",
"JISB7",
"JISB8",
"C7",
"C8",
"USStatement",
"BusinessCard",
"E",
"3R",
"4R",
"5R",
"6R",
"8R",
"MF",
"LF"
],
"overviewResolution" : 200,
"documentUTI" : "public.tiff",
"overviewScanInProgress" : 0,
"supportedResolutions" : [
"75",
"150",
"200",
"300",
"600",
"1200"
],
"usesThresholdForBlackAndWhiteScanning" : 0,
"preferredResolutions" : [
"75",
"150",
"200",
"300",
"600",
"1200"
]
}
See also
Release notes
- Version 8.3
- Added ImageCapture.GetFeatures and ImageCapture.GetParameters to return all as JSON.
Blog Entries
FileMaker Magazin
This function checks for a license.
Created 17th June 2018, last changed 9th June 2022
