diff --git a/programming/maui/api-reference/camera-enhancer-module.md b/programming/maui/api-reference/camera-enhancer-module.md new file mode 100644 index 0000000..c00771c --- /dev/null +++ b/programming/maui/api-reference/camera-enhancer-module.md @@ -0,0 +1,41 @@ +--- +layout: default-layout +title: CameraEnhancerModule - Dynamsoft Capture Vision MAUI Edition API Reference +description: The class CameraEnhancerModule of DCV MAUI represents the camera enhancer module, which provides general functions for the camera enhancer. +keywords: camera enhancer, MAUI +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# CameraEnhancerModule + +The `CameraEnhancerModule` class defines general functions of the camera enhancer module. + +## Definition + +*Namespace:* Dynamsoft.CameraEnhancer.Maui + +*Assembly:* Dynamsoft.CameraEnhancer.Maui + +```csharp +class CameraEnhancerModule +``` + +## Methods + +| Method | Description | +|------- |-------------| +| [`GetVersion`](#getversion) | Get the version of Dynamsoft Camera Enhancer. | + +### GetVersion + +Get the version of Dynamsoft Camera Enhancer. + +```csharp +static string GetVersion(); +``` + +**Return Value** + +The version of Dynamsoft Camera Enhancer. diff --git a/programming/maui/api-reference/camera-enhancer-v2.2.3000.md b/programming/maui/api-reference/camera-enhancer-v2.2.3000.md new file mode 100644 index 0000000..060fa41 --- /dev/null +++ b/programming/maui/api-reference/camera-enhancer-v2.2.3000.md @@ -0,0 +1,235 @@ +--- +layout: default-layout +title: CameraEnhancer Class - Dynamsoft Capture Vision MAUI Edition +description: CameraEnhancer Class of DCV MAUI edition is the class that defines camera controlling APIs. +keywords: Camera, scan region, focus mode, zoom factor +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# CameraEnhancer + +The `CameraEnhancer` class is the primary class of Dynamsoft Camera Enhancer that defines the camera controlling APIs. It is a subclass of `ImageSourceAdapter`. + +## Definition + +*Namespace:* Dynamsoft.CameraEnhancer.Maui + +*Assembly:* Dynamsoft.CaptureVisionRouter.Maui + +```java +class CameraEnhancer : ImageSourceAdapter +``` + +## Methods + +| Method | Description | +|------- |-------------| +| [`CameraEnhancer(CameraView cameraView)`](#cameraenhancercameraview-cameraview) | The constructor. Initialize the `CameraEnhancer` with a `CameraView` instance. | +| [`CameraEnhancer`](#cameraenhancer-1) | The constructor. | +| [`SetCameraView`](#setcameraview) | Set/get the `CameraView` instance that bind with this `CameraEnhancer` instance. | +| [`GetCameraView`](#getcameraview) | Set/get the `CameraView` instance that bind with this `CameraEnhancer` instance. | +| [`Open`](#open) | Open the camera. | +| [`Close`](#close) | Close the camera. | +| [`SetScanRegion`](#setscanregion) | Set a scan region. The video frame is cropped based on the scan region. | +| [`GetScanRegion`](#getscanregion) | Get a scan region. | +| [`EnableEnhancedFeatures`](#enableenhancedfeatures) | Enable the specified enhanced features. View EnumEnhancedFeatures for more details. | +| [`DisableEnhancedFeatures`](#disableenhancedfeatures) | Disable the specified enhanced features. View EnumEnhancedFeatures for more details. | +| [`SelectCamera`](#selectcamera) | Select a camera with a camera position. | +| [`GetCameraPosition`](#getcameraposition) | Select a camera with a camera position. | +| [`SetZoomFactor`](#setzoomfactor) | Set the zoom factor of the camera. | +| [`GetZoomFactor`](#getzoomfactor) | Get the zoom factor of the camera. | +| [`SetFocus`](#setfocus) | Set the focus point of interest and trigger an one-off auto-focus. After the focus, you can either lock the focalngth or keep the continuous auto focus enabled by configuring the subsequent focus mode. | +| [`GetFocusMode`](#getfocusmode) | Set the focus point of interest and trigger an one-off auto-focus. After the focus, you can either lock the focalngth or keep the continuous auto focus enabled by configuring the subsequent focus mode. | + +The following methods are inherited from superclass [`ImageSourceAdapter`]({{ site.dcv_android_api }}core/image-source-adapter.html) + +| Method | Description | +| ------ | ----------- | +| [`StartFetching`]({{ site.dcv_maui_api }}core/image-source-adapter.html#startfetching) | Start fetching images from the source to the Video Buffer of ImageSourceAdapter. | +| [`StopFetching`]({{ site.dcv_maui_api }}core/image-source-adapter.html#stopfetching) | Stop fetching images from the source to the Video Buffer of ImageSourceAdapter. | +| [`SetMaximumImageCount`]({{ site.dcv_maui_api }}core/image-source-adapter.html#setmaximumimagecount) | Sets the maximum number of images that can be buffered at any time. | +| [`GetMaximumImageCount`]({{ site.dcv_maui_api }}core/image-source-adapter.html#getmaximumimagecount) | Returns the maximum number of images that can be buffered. | +| [`GetImageCount`]({{ site.dcv_maui_api }}core/image-source-adapter.html#getimagecount) | Returns the current number of images in the buffer. | +| [`IsBufferEmpty`]({{ site.dcv_maui_api }}core/image-source-adapter.html#isbufferempty) | Determines whether the buffer is currently empty. | +| [`ClearBuffer`]({{ site.dcv_maui_api }}core/image-source-adapter.html#clearbuffer) | Clears all images from the buffer, resetting the state for new image fetching. | +| [`SetColourChannelUsageType`]({{ site.dcv_maui_api }}core/image-source-adapter.html#setcolourchannelusagetype) | Sets the usage type for color channels in images. | +| [`GetColourChannelUsageType`]({{ site.dcv_maui_api }}core/image-source-adapter.html#getcolourchannelusagetype) | Returns the current usage type for color channels in images. | + +### CameraEnhancer(CameraView cameraView) + +The constructor. Initialize the `CameraEnhancer` with a `CameraView` instance. + +```csharp +CameraEnhancer(CameraView cameraView); +``` + +**Parameters** + +`cameraView`: A [`CameraView`](camera-view.md) instance. + +### CameraEnhancer + +The constructor. + +```csharp +CameraEnhancer(); +``` + +### SetCameraView + +Bind a `CameraView` instance with this `CameraEnhancer` instance. + +```csharp +void SetCameraView(CameraView view); +``` + +### GetCameraView + +Get the `CameraView` object that bind to this `CameraEnhancer`. + +```csharp +CameraView GetCameraView(); +``` + +### Open + +Open the camera. + +```csharp +void Open(); +``` + +### Close + +Close the camera. + +```csharp +void Close(); +``` + +### SetScanRegion + +Set a scan region. The video frame is cropped based on the scan region. To learn the full code to setting a scan region, please refer to the [scan region](../guide/scan-region.md) article. + +```csharp +void SetScanRegion(DMRect scanRegion); +``` + +**Parameters** + +`scanRegion`: A [`DMRect`]({{ site.dcv_maui_api }}core/rect.html) object. + +### GetScanRegion + +Get the scan region if one has been set. + +```csharp +DMRect GetScanRegion(); +``` + +**Return Value** + +A [`DMRect`]({{ site.dcv_android_api }}core/basic-structures/rect.html) object that represent the scan region area. + +### EnableEnhancedFeatures + +Enable the specified enhanced features. View [EnumEnhancedFeatures]({{ site.dce_maui_api }}enum/enhanced-features.html) to learn about these enhanced features. By default, these enhanced features are all disabled. + +```csharp +void EnableEnhancedFeatures(EnumEnhancedFeatures features); +``` + +**Parameters** + +`enhancedFeatures`: A combined value of `EnumEnhancedFeatures` which indicates a series of enhanced features. + +**Return Value** + +A bool value that indicates whether the enhanced features are enabled successfully. + +### DisableEnhancedFeatures + +Disable any enhanced features that have been previously enabled. View [EnumEnhancedFeatures]({{ site.dce_maui_api }}enum/enhanced-features.html) to learn about these enhanced features. + +```csharp +void DisableEnhancedFeatures(EnumEnhancedFeatures features); +``` + +**Parameters** + +`enhancedFeatures`: A combined value of `EnhancedFeatures` which indicates a series of enhanced features. + +### SelectCamera + +Select a camera with a camera position. + +```csharp +void SelectCamera(EnumCameraPosition cameraPosition); +``` + +**Parameters** + +`cameraPosition`: One of the [`EnumCameraPosition`]({{ site.dce_maui_api }}enum/camera-position.html) value. + +### GetCameraPosition + +Get the current camera position. + +```csharp +EnumCameraPosition GetCameraPosition(); +``` + +**Return Value** + +A `EnumCameraPosition` value that represents the current camera position. + +### SetZoomFactor + +Set the zoom factor of the camera. + +```csharp +void SetZoomFactor(float zoomFactor); +``` + +**Parameters** + +`zoomFactor`: The zoom factor. + +### GetZoomFactor + +Get the zoom factor of the camera. + +```csharp +float GetZoomFactor(); +``` + +**Return Value** + +The zoom factor. + +### SetFocus + +Set the focus point of interest and trigger an one-off auto-focus. After the focus, you can either lock the focalngth or keep the continuous auto focus enabled by configuring the subsequent focus mode. + +```csharp +void SetFocus(Point focusPoint, EnumFocusMode subsequentFocusMode); +``` + +**Parameters** + +`focusPoint`: The focus point of interest. The coordinate base of the point is "image". +`subsequentFocusMode`: The subsequent focus mode of type [`EnumFocusMode`]({{ site.dce_maui_api }}enum/focus-mode.html). + +### GetFocusMode + +Get the current focus mode. + +```csharp +EnumFocusMode GetFocusMode(); +``` + +**Return Value** + +A [`EnumFocusMode`]({{ site.dce_maui_api }}enum/focus-mode.html) value that represents the current focus mode. diff --git a/programming/maui/api-reference/camera-enhancer.md b/programming/maui/api-reference/camera-enhancer.md index 060fa41..319a594 100644 --- a/programming/maui/api-reference/camera-enhancer.md +++ b/programming/maui/api-reference/camera-enhancer.md @@ -16,7 +16,7 @@ The `CameraEnhancer` class is the primary class of Dynamsoft Camera Enhancer tha *Namespace:* Dynamsoft.CameraEnhancer.Maui -*Assembly:* Dynamsoft.CaptureVisionRouter.Maui +*Assembly:* Dynamsoft.CameraEnhancer.Maui ```java class CameraEnhancer : ImageSourceAdapter @@ -42,6 +42,8 @@ class CameraEnhancer : ImageSourceAdapter | [`GetZoomFactor`](#getzoomfactor) | Get the zoom factor of the camera. | | [`SetFocus`](#setfocus) | Set the focus point of interest and trigger an one-off auto-focus. After the focus, you can either lock the focalngth or keep the continuous auto focus enabled by configuring the subsequent focus mode. | | [`GetFocusMode`](#getfocusmode) | Set the focus point of interest and trigger an one-off auto-focus. After the focus, you can either lock the focalngth or keep the continuous auto focus enabled by configuring the subsequent focus mode. | +| [`TurnOnTorch`](#turnontorch) | Turn on the torch. | +| [`TurnOffTorch`](#turnofftorch) | Turn off the torch. | The following methods are inherited from superclass [`ImageSourceAdapter`]({{ site.dcv_android_api }}core/image-source-adapter.html) @@ -233,3 +235,19 @@ EnumFocusMode GetFocusMode(); **Return Value** A [`EnumFocusMode`]({{ site.dce_maui_api }}enum/focus-mode.html) value that represents the current focus mode. + +### TurnOnTorch + +Turn on the torch. + +```csharp +void TurnOnTorch(); +``` + +### TurnOffTorch + +Turn off the torch. + +```csharp +void TurnOffTorch(); +``` diff --git a/programming/maui/api-reference/camera-view-v2.2.3000.md b/programming/maui/api-reference/camera-view-v2.2.3000.md new file mode 100644 index 0000000..3738024 --- /dev/null +++ b/programming/maui/api-reference/camera-view-v2.2.3000.md @@ -0,0 +1,76 @@ +--- +layout: default-layout +title: CameraView Class - Dynamsoft Capture Vision MAUI Edition +description: The CameraView class of DCV MAUI edition is used to display the camera preview and provides UI controlling APIs +keywords: Torch button, scan region mask, scan laser, camera view, ui +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# CameraView + +The `CameraView` class is used to display the camera preview and provides UI controlling APIs. Users can add interactable UI elements on the view. + +## Definition + +*Namespace:* Dynamsoft.CameraEnhancer.Maui + +*Assembly:* Dynamsoft.CaptureVisionRouter.Maui + +```java +class CameraView : View +``` + +## Methods & Properties + +| Method | Description | +|------- |-------------| +| [`CameraView`](#cameraview-1) | The constructor. | + +| Property | Type | Description | +|--------- | ---- |-------------| +| [`TorchButton`](#torchbutton) | *TorchButton* | The property that defines a torch button. User can click the button to turn on/off the torch. | +| [`TorchButtonVisible`](#torchbuttonvisible) | *bool* | The property that defines whether the torch button is visible. | +| [`ScanRegionMaskVisible`](#scanregionmaskvisible) | *bool* | The property that defines whether the scan region mask is visible. | +| [`ScanLaserVisible`](#scanlaservisible) | *bool* | The property that defines whether the scan laser is visible. | + +### CameraView + +The constructor. Create an instance of `CameraView`. + +```csharp +CameraView(); +``` + +### TorchButton + +The property that defines a torch button. User can click the button to turn on/off the torch. View [`TorchButton`]({{ site.dce_maui_api }}torch-button.html) class for how more information about how to configure the torch button. + +```csharp +TorchButton TorchButton { get; set; } +``` + +### TorchButtonVisible + +The property that defines whether the torch button is visible. + +```csharp +bool TorchButtonVisible { get; set; } +``` + +### ScanRegionMaskVisible + +The property that defines whether the scan region mask is visible. + +```csharp +bool ScanRegionMaskVisible { get; set; } +``` + +### ScanLaserVisible + +The property that defines whether the scan laser is visible. + +```csharp +bool ScanLaserVisible { get; set; } +``` diff --git a/programming/maui/api-reference/camera-view.md b/programming/maui/api-reference/camera-view.md index 3738024..879799a 100644 --- a/programming/maui/api-reference/camera-view.md +++ b/programming/maui/api-reference/camera-view.md @@ -16,7 +16,7 @@ The `CameraView` class is used to display the camera preview and provides UI con *Namespace:* Dynamsoft.CameraEnhancer.Maui -*Assembly:* Dynamsoft.CaptureVisionRouter.Maui +*Assembly:* Dynamsoft.CameraEnhancer.Maui ```java class CameraView : View @@ -27,6 +27,7 @@ class CameraView : View | Method | Description | |------- |-------------| | [`CameraView`](#cameraview-1) | The constructor. | +| [`GetDrawingLayer`](#getdrawinglayer) | Get the specified `DrawingLayer`. | | Property | Type | Description | |--------- | ---- |-------------| @@ -43,6 +44,22 @@ The constructor. Create an instance of `CameraView`. CameraView(); ``` +### GetDrawingLayer + +Get the specified `DrawingLayer`. + +```csharp +DrawingLayer GetDrawingLayer(EnumDrawingLayerId id); +``` + +**Parameters** + +`[in] id`: One of the [`EnumDrawingLayerId`]({{ site.dce_maui_api }}enum/drawing-layer-id.html) member that specifies the ID of the layer that you want to get. + +**Return Value** + +The `DrawingLayer` instance. + ### TorchButton The property that defines a torch button. User can click the button to turn on/off the torch. View [`TorchButton`]({{ site.dce_maui_api }}torch-button.html) class for how more information about how to configure the torch button. diff --git a/programming/maui/api-reference/drawing-item.md b/programming/maui/api-reference/drawing-item.md new file mode 100644 index 0000000..b9e68f5 --- /dev/null +++ b/programming/maui/api-reference/drawing-item.md @@ -0,0 +1,37 @@ +--- +layout: default-layout +title: DrawingItem Class - Dynamsoft Capture Vision MAUI Edition +description: The DrawingItem class of DCV MAUI edition is an abstract class that describes a basic UI element on the view. +keywords: Torch button, scan region mask, scan laser, camera view, ui +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# DrawingItem + +The `DrawingItem` class is an abstract class that describes a basic UI element on the view. + +## Definition + +*Namespace:* Dynamsoft.CameraEnhancer.Maui + +*Assembly:* Dynamsoft.CameraEnhancer.Maui + +```java +abstract class DrawingItem +``` + +## Properties + +| Property | Type | Description | +|--------- | ---- |-------------| +| [`DrawingStyleId`](#drawingstyleid) | `int` | The style id of the drawing item. | + +### DrawingStyleId + +The style id of the drawing item. View all available IDs via [EnumDrawingStyleId](enum/drawing-style-id.html). + +```csharp +int DrawingStyleId { get; set; } +``` diff --git a/programming/maui/api-reference/drawing-layer.md b/programming/maui/api-reference/drawing-layer.md new file mode 100644 index 0000000..ba78bdc --- /dev/null +++ b/programming/maui/api-reference/drawing-layer.md @@ -0,0 +1,76 @@ +--- +layout: default-layout +title: DrawingLayer Class - Dynamsoft Capture Vision MAUI Edition +description: The DrawingLayer class of DCV MAUI edition is the container of DrawingItems. +keywords: Torch button, scan region mask, scan laser, camera view, ui +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# DrawingLayer + +The `DrawingLayer` class is the container of the [`DrawingItems`](drawing-item.html). + +## Definition + +*Namespace:* Dynamsoft.CameraEnhancer.Maui + +*Assembly:* Dynamsoft.CameraEnhancer.Maui + +```java +class DrawingLayer +``` + +## Methods & Properties + +| Method | Description | +|------- |-------------| +| [`ClearDrawingItems`](#cleardrawingitems) | Clear all the [`DrawingItems`](drawing-item.html) on the layer. | +| [`SetDefaultStyle`](#setdefaultstyle) | Set the default style of the layer with a style id. | + +| Property | Type | Description | +|--------- | ---- |-------------| +| [`Id`](#id) | *int* | The ID of the layer. | +| [`DrawingItems`](#drawingitems) | *IList* | A list contains all the `DrawingItems` on the layer. | +| [`Visible`](#visible) | bool** | A bool value determines whether the layer is visible. | + +### ClearDrawingItems + +Clear all the `DrawingItems` on the layer. + +```csharp +void ClearDrawingItems(); +``` + +### SetDefaultStyle + +Set the default style of the layer with a style id. View all available IDs via [EnumDrawingStyleId](enum/drawing-style-id.html). + +```csharp +void SetDefaultStyle(int styleId); +``` + +### Id + +The ID of the layer. + +```csharp +int Id { get; } +``` + +### DrawingItems + +A list contains all the `DrawingItems` on the layer. + +```csharp +IList DrawingItems { get; set; } +``` + +### Visible + +A bool value determines whether the layer is visible. + +```csharp +bool Visible { get; set; } +``` diff --git a/programming/maui/api-reference/enum/camera-position-2.2.3000.md b/programming/maui/api-reference/enum/camera-position-2.2.3000.md new file mode 100644 index 0000000..f59c0ca --- /dev/null +++ b/programming/maui/api-reference/enum/camera-position-2.2.3000.md @@ -0,0 +1,30 @@ +--- +layout: default-layout +title: EnumCameraPosition - Dynamsoft Capture Vision MAUI Edition +description: The enumeration CameraPosition of DCE MAUI describes the camera position. +keywords: Camera Position, front forward, back forward +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: CameraPosition +--- + +# Enumeration CameraPosition + +`CameraPosition` describes the camera position. + +## Definition + +*Namespace:* Dynamsoft.CameraEnhancer.Maui + +*Assembly:* Dynamsoft.CaptureVisionRouter.Maui + +```csharp +public enum EnumCameraPosition : int +{ + // The back-facing camera. + CP_BACK = 0, + // The front-facing camera. + CP_FRONT = 1 +} +``` diff --git a/programming/maui/api-reference/enum/camera-position.md b/programming/maui/api-reference/enum/camera-position.md index 29aee5c..d83144f 100644 --- a/programming/maui/api-reference/enum/camera-position.md +++ b/programming/maui/api-reference/enum/camera-position.md @@ -1,6 +1,6 @@ --- layout: default-layout -title: EnumCameraPosition - Dynamsoft Vision Router MAUI Edition +title: EnumCameraPosition - Dynamsoft Capture Vision MAUI Edition description: The enumeration CameraPosition of DCE MAUI describes the camera position. keywords: Camera Position, front forward, back forward needGenerateH3Content: true @@ -26,5 +26,14 @@ public enum EnumCameraPosition : int CP_BACK = 0, // The front-facing camera. CP_FRONT = 1 + /** + * The back-facing ultra-wide-angle camera. It is an ultra-wide-angle camera for macro-distance capturing. + */ + CP_BACK_ULTRA_WIDE, + /** + * A back-facing virtual camera. It is a vitural camera that can switch between the wide-angle camera and the ultra-wide-angle camera automatically. + * Supported devices include: iPhone 13 Pro, iPhone 13 Pro Max, iPhone 14 Pro, iPhone 14 Pro Max, iPhone 15 Pro, iPhone 15 Pro Max. + */ + CP_BACK_DUAL_WIDE_AUTO } ``` diff --git a/programming/maui/api-reference/enum/drawing-layer-id.md b/programming/maui/api-reference/enum/drawing-layer-id.md new file mode 100644 index 0000000..142ce8d --- /dev/null +++ b/programming/maui/api-reference/enum/drawing-layer-id.md @@ -0,0 +1,29 @@ +--- +layout: default-layout +title: EnumDrawingLayerId - Dynamsoft Capture Vision MAUI Edition +description: The enumeration DrawingLayerId of DCE MAUI describes the layer ID. +keywords: Camera Position, front forward, back forward +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: EnumDrawingLayerId +--- + +# Enumeration EnumDrawingLayerId + +`EnumDrawingLayerId` describes the layer ID. + +## Definition + +*Namespace:* Dynamsoft.CameraEnhancer.Maui + +*Assembly:* Dynamsoft.CameraEnhancer.Maui + +```csharp +public enum EnumDrawingLayerId : int +{ + DLI_DDN = 1, + DLI_DBR = 2, + DLI_DLR = 3 +} +``` diff --git a/programming/maui/api-reference/enum/drawing-style-id.md b/programming/maui/api-reference/enum/drawing-style-id.md new file mode 100644 index 0000000..a7800fa --- /dev/null +++ b/programming/maui/api-reference/enum/drawing-style-id.md @@ -0,0 +1,34 @@ +--- +layout: default-layout +title: EnumDrawingStyleId - Dynamsoft Capture Vision MAUI Edition +description: The enumeration DrawingLayerId of DCE MAUI describes the drawing style IDs. +keywords: Camera Position, front forward, back forward +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: EnumDrawingStyleId +--- + +# Enumeration EnumDrawingStyleId + +`EnumDrawingStyleId` describes the drawing style IDs. + +## Definition + +*Namespace:* Dynamsoft.CameraEnhancer.Maui + +*Assembly:* Dynamsoft.CameraEnhancer.Maui + +```csharp +public class EnumDrawingStyleId +{ + DSI_BLUE_STROKE = 1, + DSI_GREEN_STROKE = 2, + DSI_ORANGE_STROKE = 3, + DSI_YELLOW_STROKE = 4, + DSI_BLUE_STROKE_FILL = 5, + DSI_GREEN_STROKE_FILL = 6, + DSI_ORANGE_STROKE_FILL = 7, + DSI_YELLOW_STROKE_FILL = 8 +} +``` diff --git a/programming/maui/api-reference/enum/enhanced-features.md b/programming/maui/api-reference/enum/enhanced-features.md index 861c05c..a96f296 100644 --- a/programming/maui/api-reference/enum/enhanced-features.md +++ b/programming/maui/api-reference/enum/enhanced-features.md @@ -1,6 +1,6 @@ --- layout: default-layout -title: EnumEnhancedFeatures - Dynamsoft Vision Router MAUI Edition +title: EnumEnhancedFeatures - Dynamsoft Capture Vision MAUI Edition description: The enumeration EnhancedFeatures of DCE MAUI describes the enhanced camera controlling features. keywords: frame filter, sensor control, enhanced focus, auto zoom, smart torch needGenerateH3Content: true diff --git a/programming/maui/api-reference/enum/focus-mode.md b/programming/maui/api-reference/enum/focus-mode.md index 06b723d..2aa15a1 100644 --- a/programming/maui/api-reference/enum/focus-mode.md +++ b/programming/maui/api-reference/enum/focus-mode.md @@ -1,6 +1,6 @@ --- layout: default-layout -title: EnumFocusMode - Dynamsoft Vision Router MAUI Edition +title: EnumFocusMode - Dynamsoft Capture Vision MAUI Edition description: The enumeration FocusMode of DCE MAUI describes the focus mode. keywords: focus mode, lock focal length, keep continuous auto focus needGenerateH3Content: true diff --git a/programming/maui/api-reference/feedback-v2.2.3000.md b/programming/maui/api-reference/feedback-v2.2.3000.md new file mode 100644 index 0000000..e3cfeb5 --- /dev/null +++ b/programming/maui/api-reference/feedback-v2.2.3000.md @@ -0,0 +1,46 @@ +--- +layout: default-layout +title: Feedback Class - Dynamsoft Capture Vision MAUI Edition +description: Feedback class of DCV MAUI edition provides methods to trigger feedbacks from the hardware, such as vibrate and beep. +keywords: virbrate, beep +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# Feedback + +The `Feedback` class provides methods to trigger feedbacks from the hardware, such as vibrate and beep. + +## Definition + +*Namespace:* Dynamsoft.CameraEnhancer.Maui + +*Assembly:* Dynamsoft.CaptureVisionRouter.Maui + +```java +class Feedback +``` + +## Methods + +| Method | Description | +|------- |-------------| +| [`Vibrate`](#vibrate) | Trigger a vibrate. | +| [`Beep`](#beep) | Trigger a beep. | + +### Vibrate + +Trigger a vibrate. + +```java +static void Vibrate(); +``` + +### Beep + +Trigger a beep. + +```java +static void Beep(); +``` diff --git a/programming/maui/api-reference/feedback.md b/programming/maui/api-reference/feedback.md index e3cfeb5..052e072 100644 --- a/programming/maui/api-reference/feedback.md +++ b/programming/maui/api-reference/feedback.md @@ -16,7 +16,7 @@ The `Feedback` class provides methods to trigger feedbacks from the hardware, su *Namespace:* Dynamsoft.CameraEnhancer.Maui -*Assembly:* Dynamsoft.CaptureVisionRouter.Maui +*Assembly:* Dynamsoft.CameraEnhancer.Maui ```java class Feedback diff --git a/programming/maui/api-reference/image-editor-view.md b/programming/maui/api-reference/image-editor-view.md new file mode 100644 index 0000000..6357731 --- /dev/null +++ b/programming/maui/api-reference/image-editor-view.md @@ -0,0 +1,75 @@ +--- +layout: default-layout +title: ImageEditorView Class - Dynamsoft Capture Vision MAUI Edition +description: The ImageEditorView class of DCV MAUI edition is used to display an image and related UI elements. +keywords: Torch button, scan region mask, scan laser, camera view, ui +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# ImageEditorView + +The `ImageEditorView` class is used to display an image and related UI elements. + +## Definition + +*Namespace:* Dynamsoft.CameraEnhancer.Maui + +*Assembly:* Dynamsoft.CameraEnhancer.Maui + +```java +class ImageEditorView : View +``` + +## Methods & Properties + +| Method | Description | +|------- |-------------| +| [`ImageEditorView`](#imageeditorview-1) | The constructor. | +| [`GetDrawingLayer`](#getdrawinglayer) | Get the specified `DrawingLayer`. | + +| Property | Type | Description | +|--------- | ---- |-------------| +| [`OriginalImage`](#originalimage) | *ImageData* | The original image that displayed on the view. | +| [`SelectedDrawingItem`](#selecteddrawingitem) | *DrawingItem* | The selected [`DrawingItem`](drawingitem.md) on the view. | + +### ImageEditorView + +The constructor. Create an instance of `ImageEditorView`. + +```csharp +ImageEditorView(); +``` + +### GetDrawingLayer + +Get the specified `DrawingLayer`. + +```csharp +DrawingLayer GetDrawingLayer(EnumDrawingLayerId id); +``` + +**Parameters** + +`[in] id`: One of the [`EnumDrawingLayerId`]({{ site.dce_maui_api }}enum/drawing-layer-id.html) member that specifies the ID of the layer that you want to get. + +**Return Value** + +The `DrawingLayer` instance. + +### OriginalImage + +The origial image that displayed on the view. + +```csharp +ImageData OriginalImage{ get; set; } +``` + +### SelectedDrawingItem + +The selected [`DrawingItem`](drawingitem.md) on the view. + +```csharp +DrawingItem SelectedDrawingItem { get; } +``` diff --git a/programming/maui/api-reference/quad-drawing-item.md b/programming/maui/api-reference/quad-drawing-item.md new file mode 100644 index 0000000..f6748c7 --- /dev/null +++ b/programming/maui/api-reference/quad-drawing-item.md @@ -0,0 +1,63 @@ +--- +layout: default-layout +title: QuadDrawingItem Class - Dynamsoft Capture Vision MAUI Edition +description: The QuadDrawingItem class of DCV MAUI edition describes a quad that can be drawn on the view. +keywords: Torch button, scan region mask, scan laser, camera view, ui +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# QuadDrawingItem + +The `QuadDrawingItem` class describes a quad that can be drawn on the view. + +## Definition + +*Namespace:* Dynamsoft.CameraEnhancer.Maui + +*Assembly:* Dynamsoft.CameraEnhancer.Maui + +```java +class QuadDrawingItem : DrawingItem +``` + +## Methods & Properties + +| Method | Description | +|------- |-------------| +| [`QuadDrawingItem`](#quaddrawingitem-1) | The constructor. | + +| Property | Type | Description | +|--------- | ---- |-------------| +| [`Quad`](#quad) | *ImageData* | Get the quad information of the `QuadDrawingItem`. | + +The following property is inherited from `DrawingItem` + +| Property | Type | Description | +|--------- | ---- |-------------| +| [`DrawingStyleId`](#drawingstyleid) | `int` | The style id of the drawing item. | + +### QuadDrawingItem + +The constructor. + +```csharp +QuadDrawingItem(Quadrilateral quad); +``` + +### Quad + +Get the quad information of the `QuadDrawingItem`. + +```csharp +Quadrilateral Quad { get; } +``` + +### DrawingStyleId + +The style id of the drawing item. View all available IDs via [EnumDrawingStyleId](enum/drawing-style-id.html). + +```csharp +int DrawingStyleId { get; set; } +``` diff --git a/programming/maui/api-reference/torch-button-v2.2.3000.md b/programming/maui/api-reference/torch-button-v2.2.3000.md new file mode 100644 index 0000000..5d2dbb6 --- /dev/null +++ b/programming/maui/api-reference/torch-button-v2.2.3000.md @@ -0,0 +1,82 @@ +--- +layout: default-layout +title: TorchButton Class - Dynamsoft Capture Vision MAUI Edition +description: TorchButton class of DCV MAUI edition defines a torch button with its location, size and image. +keywords: Torch button, torch image +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# TorchButton + +The TorchButton class defines a torch button with its location, size and image. + +## Definition + +*Namespace:* Dynamsoft.CameraEnhancer.Maui + +*Assembly:* Dynamsoft.CaptureVisionRouter.Maui + +```java +class TorchButton +``` + +## Properties + +| Property | Type | Description | +|--------- |------|-------------| +| [`X`](#x) | *double* | The x-coordinate of the torch button. | +| [`Y`](#y) | *double* | The y-coordinate of the torch button. | +| [`Width`](#width) | *double* | The width of the torch button. | +| [`Height`](#height) | *double* | The height of the torch button. | +| [`TorchOnImageSource`](#torchonimagesource) | *ImageSource* | The image source of the torch button when the torch is on. | +| [`TorchOffImageSource`](#torchoffimagesource) | *ImageSource* | The image source of the torch button when the torch is off. | + +### X + +The x-coordinate of the torch button. + +```csharp +double X { get; set; } +``` + +### Y + +The y-coordinate of the torch button. + +```csharp +double Y { get; set; } +``` + +### Width + +The width of the torch button. + +```csharp +double Width { get; set; } +``` + +### Height + +The height of the torch button. + +```csharp +double Height { get; set; } +``` + +### TorchOnImageSource + +The image source of the torch button when the torch is on. + +```csharp +ImageSource? TorchOnImageSource { get; set; } +``` + +### TorchOffImageSource + +The image source of the torch button when the torch is off. + +```csharp +ImageSource? TorchOffImageSource { get; set; } +``` diff --git a/programming/maui/api-reference/torch-button.md b/programming/maui/api-reference/torch-button.md index 5d2dbb6..edfbf50 100644 --- a/programming/maui/api-reference/torch-button.md +++ b/programming/maui/api-reference/torch-button.md @@ -16,7 +16,7 @@ The TorchButton class defines a torch button with its location, size and image. *Namespace:* Dynamsoft.CameraEnhancer.Maui -*Assembly:* Dynamsoft.CaptureVisionRouter.Maui +*Assembly:* Dynamsoft.CameraEnhancer.Maui ```java class TorchButton