diff --git a/info/api/WebTwain_Acquire.md b/info/api/WebTwain_Acquire.md index b5523118..684cd358 100644 --- a/info/api/WebTwain_Acquire.md +++ b/info/api/WebTwain_Acquire.md @@ -92,26 +92,11 @@ AcquireImage( successCallBack?: () => void, failureCallBack?: (deviceConfiguration?: DeviceConfiguration, errorCode: number, errorString: string) => void ): void; - -interface DeviceConfiguration { - IfShowUI?: boolean; //Whether to show the built-in User Interface from the device vendor - PixelType?: Dynamsoft.DWT.EnumDWT_PixelType | number | string; //Whether to scan in color, grey or black & white - Resolution?: number; //Measured by dots per pixel (DPI) - IfFeederEnabled?: boolean; //Whether to use the document feeder or the flatbed of the device - IfDuplexEnabled?: boolean; //Whether to scan one side or both sides - IfDisableSourceAfterAcquire?: boolean; //Whether to close the built-in User Interface after aquisition. Only valid when {IfShowUI} is true. - IfGetImageInfo?: boolean; //Whether to retrieve information about the image after it's transferred. - IfGetExtImageInfo?: boolean; //Whether to retrieve extended information about the image after it's transferred. - extendedImageInfoQueryLevel?: Dynamsoft.DWT.EnumDWT_ExtImageInfo | number; //How much extended information is retrieved. Only valid when {IfGetExtImageInfo} is true. - SelectSourceByIndex?: number; //Specify a source by its index. - IfCloseSourceAfterAcquire?: boolean; //Whether to close the data source after aquisition. Default: false. - PageSize?: Dynamsoft.DWT.EnumDWT_CapSupportedSizes | number; //Specify page size -} ``` **Parameters** -`deviceConfiguration`: Configuration for the acquisition. +`deviceConfiguration`: Configuration for the acquisition. Please refer to [Interface]({{site.info}}api/Interfaces.html#DeviceConfiguration). `successCallback`: A callback function that is executed if the request succeeds. @@ -4680,7 +4665,7 @@ DWObject.GetDevicesAsync().then((deviceList)=>{ **Parameters** -`device`: the device object. Please refer to [Device]({{site.info}}api/Interfaces.html#device) +`device`: the device object. Please refer to [Interface]({{site.info}}api/Interfaces.html#device). **Availability** @@ -4722,7 +4707,7 @@ AcquireImageAsync(deviceConfiguration?: DeviceConfiguration): Promise< boolean>; **Parameters** -`deviceConfiguration`: The device configuration +`deviceConfiguration`: The device configuration. Please refer to [Interface]({{site.info}}api/Interfaces.html#DeviceConfiguration). **Availability** diff --git a/info/api/interfaces.md b/info/api/interfaces.md index b1dd918e..87941cf4 100644 --- a/info/api/interfaces.md +++ b/info/api/interfaces.md @@ -13,6 +13,7 @@ permalink: /info/api/interfaces.html | | | :----- | | [`Device`](#device) | +| [`DeviceConfiguration`](#DeviceConfiguration) | --- @@ -31,25 +32,27 @@ interface Device{ } ``` -**Availability** -
- - - - - - - - - - - - - - - - - - -
ActiveXH5(Windows)H5(macOS/TWAIN)H5(macOS/ICA)H5(Linux)
not supportedv18.0+v18.0+v18.0+v18.0+
-
+--- + +## DeviceConfiguration + +**Syntax** + +```typescript +interface DeviceConfiguration { + IfShowUI?: boolean; //Whether to show the built-in User Interface from the device vendor + PixelType?: Dynamsoft.DWT.EnumDWT_PixelType | number | string; //Whether to scan in color, grey or black & white + Resolution?: number; //Measured by dots per pixel (DPI) + IfFeederEnabled?: boolean; //Whether to use the document feeder or the flatbed of the device + IfDuplexEnabled?: boolean; //Whether to scan one side or both sides + IfDisableSourceAfterAcquire?: boolean; //Whether to close the built-in User Interface after aquisition. Only valid when {IfShowUI} is true. + IfGetImageInfo?: boolean; //Whether to retrieve information about the image after it's transferred. + IfGetExtImageInfo?: boolean; //Whether to retrieve extended information about the image after it's transferred. + extendedImageInfoQueryLevel?: Dynamsoft.DWT.EnumDWT_ExtImageInfo | number; //How much extended information is retrieved. Only valid when {IfGetExtImageInfo} is true. + SelectSourceByIndex?: number; //Specify a source by its index. + IfCloseSourceAfterAcquire?: boolean; //Whether to close the data source after aquisition. Default: false. + PageSize?: Dynamsoft.DWT.EnumDWT_CapSupportedSizes | number; //Specify page size +} +``` + +---