ImgSource_GetList¶
protocol | Text | Restrict image sources to this protocol. |
sourceList | Object | The result image source list represented by a 4D object. |
Return a list of the available image acquisition sources as a 4D object.
Parameter protocol
is optional. If present, only the sources available via the specified protocol are returned.
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 as a 4D object.
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 |
Note
This method is a wrapper for the ImgSrc_GetList_JSN
plug-in method.
It returns a 4D object instead of a JSON object serialization.