ImgSource_GetList_JSN¶
→ | 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:
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:
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 |
Kind |
The kind of the source (a string). Present only in |
UUID |
The UUID of the source (a string). Present only in |
Architectures |
An array of strings noting the processor architectures of the driver
used to access the source.
The array contains either or both of Present only in |