Merge pull request #64 from dynamsoft-docs/preview

Preview

Author: DMGithubPublisher

_config.yml

@@ -66,6 +66,15 @@ cvr-enums: /capture-vision/docs/core/enums/capture-vision-router/
 dce_maui_api: /camera-enhancer/docs/mobile/programming/maui/api-reference/
 dcv_maui_api: /capture-vision/docs/mobile/programming/maui/api-reference/
 
+dcv_flutter: /capture-vision/docs/mobile/programming/flutter/
+dcv_flutter_api: /capture-vision/docs/mobile/programming/flutter/api-reference/
+dcp_flutter: /code-parser/docs/mobile/programming/flutter/
+dcp_flutter_api: /code-parser/docs/mobile/programming/flutter/api-reference/
+dbr_flutter: /barcode-reader/docs/mobile/programming/flutter/
+dbr_flutter_api: /barcode-reader/docs/mobile/programming/flutter/api-reference/
+dce_flutter: /camera-enhancer/docs/mobile/programming/flutter/
+dce_flutter_api: /camera-enhancer/docs/mobile/programming/flutter/api-reference/
+
 assets: /camera-enhancer/docs/mobile/assets/
 edit_icon: /camera-enhancer/docs/mobile/assets/img-icon/edit-icon.png
 smile_icon: /camera-enhancer/docs/mobile/assets/img-icon/icon-smile.png

programming/flutter/api-reference/camera-enhancer.md

@@ -0,0 +1,200 @@
+---
+layout: default-layout
+title: CameraEnhancer Class - Dynamsoft Capture Vision Flutter
+description: CameraEnhancer class of DCV Flutter edition manages camera operations and enhancements.
+keywords: camera, enhancer, barcode reader, flutter, capture vision
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+---
+
+# CameraEnhancer
+
+The `CameraEnhancer` class provides camera-specific functionality including camera selection, focus control, zoom, and other enhanced features. The `CameraEnhancer` is also responsible for the basic UI of the camera view.
+
+## Definition
+
+*Assembly:* dynamsoft_capture_vision_flutter
+
+```dart
+class CameraEnhancer
+```
+
+## Methods
+
+| Method | Description |
+| ------ | ----------- |
+| [`close`](#close) | Closes the camera and releases the related resources. |
+| [`destroy`](#destroy) | Destroys the camera enhancer instance and releases the related resources on the host side. |
+| [`disableEnhancedFeatures`](#disableenhancedfeatures) | Disables the selected and activated enhanced features of the Camera Enhancer. |
+| [`enableEnhancedFeatures`](#enableenhancedfeatures) | Activates the selected enhanced features provided by the Camera Enhancer library, including the auto-zoom and smart torch features. |
+| [`getCameraPosition`](#getcameraposition) | Returns the current camera being used. |
+| [`getColourChannelUsageType`](#getcolourchannelusagetype) | Retrieves the current colour channel that is being used by the camera enhancer. |
+| [`getFocusMode`](#getfocusmode) | Returns the current focus mode of the camera. |
+| [`getScanRegion`](#getscanregion) | Returns the current scan region. |
+| [`open`](#open) | Opens the selected camera to begin the capture process. |
+| [`selectCamera`](#selectcamera) | Selects the camera based on the specified camera position. |
+| [`setColourChannelUsageType`](#setcolourchannelusagetype) | Defines the colour channel used by the camera enhancer. |
+| [`setFocus`](#setfocus) | Sets the focus point as well as the mode for the camera. |
+| [`setScanRegion`](#setscanregion) | Sets the scan region of the camera and displays a bordered area on the UI. |
+| [`setZoomFactor`](#setzoomfactor) | Sets the zoom factor of the camera. |
+| [`turnOffTorch`](#turnofftorch) | Turns off the camera's flashlight (if available). |
+| [`turnOnTorch`](#turnontorch) | Turns on the camera's flashlight (if available). |
+
+### close
+
+Closes the camera and releases the related resources. When the `CaptureVisionRouter` instance calls `stopCapturing`, please make sure to call this method as well to ensure that the resources are released properly.
+
+```dart
+Future<void> close()
+```
+
+### destroy
+
+Destroys the camera enhancer instance and releases the related resources on the host side.
+
+```dart
+Future<void> destroy()
+```
+
+### disableEnhancedFeatures
+
+Disables the selected and activated enhanced features (represented by [`EnumEnhancedFeatures`](./enum/enhanced-features-camera.md)) of the Camera Enhancer.
+
+```dart
+Future<void> disableEnhancedFeatures(int features)
+```
+
+### enableEnhancedFeatures
+
+Activates the selected enhanced features (represented by [`EnumEnhancedFeatures`](./enum/enhanced-features-camera.md)) provided by the Camera Enhancer library, including the auto-zoom and smart torch features.
+
+```dart
+Future<void> enableEnhancedFeatures(int features)
+```
+
+**Remarks**
+
+This method must be used **after [`setInput`]({{ site.dcv_flutter_api }}capture-vision-router/capture-vision-router.html#setinput) and before the [`open`](#open) method**. If you would like to activate multiple enhanced features, then they must be combined using the OR (`|`) operator.
+
+```dart
+await _cvr.setInput(_camera);
+_camera.enableEnhancedFeatures(EnumEnhancedFeatures.autoZoom | EnumEnhancedFeatures.smartTorch);
+_camera.open();
+```
+
+### getCameraPosition
+
+Returns the current camera being used, represented as a [`EnumCameraPosition`](./enum/camera-position.md).
+
+```dart
+Future<EnumCameraPosition> getCameraPosition() async
+```
+
+### getColourChannelUsageType
+
+Retrieves the current colour channel (as a [`EnumColourChannelUsageType`](./enum/colour-channel.md)) that is being used by the camera enhancer.
+
+```dart
+Future<EnumColourChannelUsageType> getColourChannelUsageType()
+```
+
+**Remarks**
+
+This method should be used to verify which colour channel the camera is using, and in turn verify what pixel type any images retrieved during the capture process will come out in.
+
+### getFocusMode
+
+Returns the current focus mode of the camera, represented as a [`EnumFocusMode`](./enum/focus-mode.md).
+
+```dart
+Future<EnumFocusMode> getFocusMode() async 
+```
+
+### getScanRegion
+
+Returns the current scan region as a [`DSRect`]({{ site.dcv_flutter_api }}core/dsrect.html) object.
+
+```dart
+Future<DSRect?> getScanRegion() async
+```
+
+### open
+
+Opens the selected camera to begin the capture process.
+
+```dart
+Future<void> open()
+```
+
+### selectCamera
+
+Selects the camera based on the specified [`EnumCameraPosition`](./enum/camera-position.md).
+
+```dart
+Future<void> selectCamera(EnumCameraPosition position)
+```
+
+**Remarks**
+
+If you attempt to select the **backDualWideAuto** or the **backUltraWide** cameras on an Android phone, an exception will be thrown as those cameras are only available on iPhones. Supported devices include: iPhone 13 Pro, iPhone 13 Pro Max, iPhone 14 Pro, iPhone 14 Pro Max, iPhone 15 Pro, iPhone 15 Pro Max. This method must be called **after [`setInput`]({{ site.dcv_flutter_api }}capture-vision-router/capture-vision-router.html#setinput) and before the [`open`](#open) method**.
+
+> *Exception* - "This camera position is only supported on iOS"
+
+### setColourChannelUsageType
+
+Defines the colour channel (as a [`EnumColourChannelUsageType`](./enum/colour-channel.md)) used by the camera enhancer - therefore determining whether the captured images or frames will come out in grayscale or colour (or one of the individual colours).
+
+```dart
+Future<void> setColourChannelUsageType(EnumColourChannelUsageType type)
+```
+
+**Remarks**
+
+This method should be used to change the pixel type of the original image or captured frame should you choose to retrieve it after the capture process. In order to retrieve the original image after the barcode is decoded or the captured result is received, please refer to [this article].
+
+### setFocus
+
+Sets the focus point as well as the mode (as a [`EnumFocusMode`](./enum/focus-mode.md)) for the camera.
+
+```dart
+Future<void> setFocus(Point<double> point, EnumFocusMode focusMode)
+```
+
+### setScanRegion
+
+Sets the scan region of the camera and displays a bordered area on the UI to represent the scan region. To learn how to specify the scan region when using the Barcode Reader, please visit this [section of the foundational user guide]({{ site.dbr_flutter }}explore-features/ui-customization.html#specifying-a-scan-region).
+
+```dart
+Future<void> setScanRegion(DSRect region) async
+```
+
+**Remarks**
+
+This method must be called **after [`setInput`]({{ site.dcv_flutter_api }}capture-vision-router/capture-vision-router.html#setinput) and before the [`open`](#open) method**. The region is represented as a [`DSRect`]({{ site.dcv_flutter_api }}core/dsrect.html).
+
+> *Exception* - "Failed to set the scan region"
+
+### setZoomFactor
+
+Sets the zoom factor of the camera.
+
+```dart
+Future<void> setZoomFactor(double zoom)
+```
+
+### turnOffTorch
+
+Turns off the camera's flashlight (if available).
+
+```dart
+Future<void> turnOffTorch()
+```
+
+### turnOnTorch
+
+Turns on the camera's flashlight (if available).
+
+```dart
+Future<void> turnOnTorch()
+```

programming/flutter/api-reference/camera-toggle-button.md

@@ -0,0 +1,52 @@
+---
+layout: default-layout
+title: CameraToggleButton Class - Dynamsoft Capture Vision Flutter
+description: CameraToggleButton class of DCV Flutter edition displays a camera preview with customizable UI elements.
+keywords: camera, enhancer, barcode reader, flutter, capture vision, view
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+---
+
+# CameraToggleButton
+
+`CameraToggleButton` is a widget that represents a camera toggle button with customizable appearance and location. The camera toggle button allows the user to switch between the front and back cameras.
+
+## Definition
+
+*Assembly:* dynamsoft_capture_vision_flutter
+
+```dart
+class CameraToggleButton
+```
+
+## Properties
+
+### location
+
+Defines the location of the camera toggle button (as a [Rect](https://api.flutter.dev/flutter/dart-ui/Rect-class.html)). This rectangle specifies the button's position and size on the screen. Coordinates are in pixels.
+
+```dart
+Rect location;
+```
+
+### imageBase64
+
+Sets the image (as a base64 string) to be used for the camera toggle button.
+
+```dart
+String? imageBase64;
+```
+
+**Remarks**
+
+When setting the imageBase64 string, please note that the string should not include the `data:image/png;base64,` portion of the base64 string.
+
+## Code Snippet
+
+```dart
+final CameraToggleButton _cameraToggleBtn = CameraToggle(
+    location: Rect.fromLTWH(300, 30, 50, 50),
+    imageBase64: "<insert base64 string>"
+)
+```