ImgSource_GetList_JSN

Return the available image acquisition sources.
ImgSource_GetList_JSN(protocol) ➔ imgSrcListJSON
protocol Text Optional protocol identifier
↩︎ imgSrcListJSON Text The image source list encoded as a JSON object.

Return a list of the available image acquisition sources encoded in JSON.

Parameter protocol is optional. If present, only the sources available via the specified protocol are returned.

The supported acquisition protocols are:

Image Acquisition Protocols
Key Description
TWAIN The TWAIN standard. Available on all platforms, supported mostly by scanners.
IC Image Capture, the standard image acquisition framework on macOS.
WIA Windows Image Acquisition, the standard image acquisition platform on Windows.

The list of image sources is returned in imgSrcListJSON as a 4D object encoded in JSON format.

The names of the properties in the returned object are the ID’s of the sources. The value of each property is an object containing information about the source. The properties of the source information object are described in the following table:

Image Source Properties
Property name Description
Name The name of the source (a string).
Protocol

The name of the protocol used to access the source (a string).

Possible values are "TWAIN", "IC", and "WIA".

Kind

The kind of the source (a string).

Present only in IC and WIA sources. Possible values are "Scanner" and "Camera".

UUID

The UUID of the source (a string).

Present only in IC and WIA sources.

Architectures

An array of strings noting the processor architectures of the driver used to access the source. The array contains either or both of "i386" and "x86_64".

Present only in TWAIN sources.