From 7d413c61664c8e973d547a1b219176f05ceee2ca Mon Sep 17 00:00:00 2001 From: Dynamsoft-Henry <78675724+Dynamsoft-Henry@users.noreply.github.com> Date: Thu, 11 Dec 2025 17:25:44 +0800 Subject: [PATCH] Updating enums --- programming/android/api-reference.md | 16 ++-- programming/android/enum/camera-position.md | 25 ++++++ programming/android/enum/camera-state.md | 29 +++++++ programming/android/enum/coordinate-base.md | 25 ++++++ .../android/enum/drawing-item-media-type.md | 28 +++++++ .../android/enum/drawing-item-state.md | 25 ++++++ programming/android/enum/enhanced-features.md | 45 ++++++++++ programming/android/enum/focus-mode.md | 25 ++++++ programming/android/enum/resolution.md | 31 +++++++ .../android/primary-api/camera-enhancer.md | 6 +- programming/ios/api-reference.md | 16 ++-- programming/ios/enum/camera-position.md | 63 ++++++++++++++ programming/ios/enum/camera-state.md | 62 ++++++++++++++ programming/ios/enum/coordinate-base.md | 45 ++++++++++ .../ios/enum/drawing-item-media-type.md | 61 ++++++++++++++ programming/ios/enum/drawing-item-state.md | 45 ++++++++++ programming/ios/enum/enhanced-features.md | 84 +++++++++++++++++++ programming/ios/enum/focus-mode.md | 45 ++++++++++ programming/ios/enum/resolution.md | 70 ++++++++++++++++ .../ios/primary-api/camera-enhancer.md | 8 +- 20 files changed, 731 insertions(+), 23 deletions(-) create mode 100644 programming/android/enum/camera-position.md create mode 100644 programming/android/enum/camera-state.md create mode 100644 programming/android/enum/coordinate-base.md create mode 100644 programming/android/enum/drawing-item-media-type.md create mode 100644 programming/android/enum/drawing-item-state.md create mode 100644 programming/android/enum/enhanced-features.md create mode 100644 programming/android/enum/focus-mode.md create mode 100644 programming/android/enum/resolution.md create mode 100644 programming/ios/enum/camera-position.md create mode 100644 programming/ios/enum/camera-state.md create mode 100644 programming/ios/enum/coordinate-base.md create mode 100644 programming/ios/enum/drawing-item-media-type.md create mode 100644 programming/ios/enum/drawing-item-state.md create mode 100644 programming/ios/enum/enhanced-features.md create mode 100644 programming/ios/enum/focus-mode.md create mode 100644 programming/ios/enum/resolution.md diff --git a/programming/android/api-reference.md b/programming/android/api-reference.md index 1439d41..f3956a1 100644 --- a/programming/android/api-reference.md +++ b/programming/android/api-reference.md @@ -51,11 +51,11 @@ permalink: /programming/android/api-reference.html ## Enumerations -* [EnumCameraPosition]({{ site.dce-enums }}camera-position.html?lang=android) -* [EnumCameraState]({{ site.dce-enums }}camera-state.html?lang=android) -* [EnumCoordinateBase]({{ site.dce-enums }}coordinate-base.html?lang=android) -* [EnumDrawingItemMediaType]({{ site.dce-enums }}drawing-item-media-type.html?lang=android) -* [EnumDrawingItemState]({{ site.dce-enums }}drawing-item-state.html?lang=android) -* [EnumEnhancedFeatures]({{ site.dce-enums }}enhanced-features.html?lang=android) -* [EnumFocusMode]({{ site.dce-enums }}focus-mode.html?lang=android) -* [EnumResolution]({{ site.dce-enums }}resolution.html?lang=android) +* [EnumCameraPosition]({{ site.android }}enum/camera-position.html?lang=android) +* [EnumCameraState]({{ site.android }}enum/camera-state.html?lang=android) +* [EnumCoordinateBase]({{ site.android }}enum/coordinate-base.html?lang=android) +* [EnumDrawingItemMediaType]({{ site.android }}enum/drawing-item-media-type.html?lang=android) +* [EnumDrawingItemState]({{ site.android }}enum/drawing-item-state.html?lang=android) +* [EnumEnhancedFeatures]({{ site.android }}enum/enhanced-features.html?lang=android) +* [EnumFocusMode]({{ site.android }}enum/focus-mode.html?lang=android) +* [EnumResolution]({{ site.android }}enum/resolution.html?lang=android) diff --git a/programming/android/enum/camera-position.md b/programming/android/enum/camera-position.md new file mode 100644 index 0000000..a114d17 --- /dev/null +++ b/programming/android/enum/camera-position.md @@ -0,0 +1,25 @@ +--- +layout: default-layout +title: CameraPosition - Dynamsoft Camera Enhancer Android Enumerations +description: The enumeration CameraPosition of Dynamsoft Camera Enhancer Android describes the camera position. +keywords: Camera Position +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: CameraPosition +--- + +# CameraPosition + +Enumeration `CameraPosition` describes the camera position. + +```java +@IntDef({CP_FRONT,CP_BACK}) +@Retention(RetentionPolicy.CLASS) +public @interface EnumCameraPosition { + // The back-facing camera. + int CP_BACK= 0; + // The front-facing camera. + int CP_FRONT = 1; +} +``` diff --git a/programming/android/enum/camera-state.md b/programming/android/enum/camera-state.md new file mode 100644 index 0000000..e145bb5 --- /dev/null +++ b/programming/android/enum/camera-state.md @@ -0,0 +1,29 @@ +--- +layout: default-layout +title: CameraState - Dynamsoft Camera Enhancer Android Enumerations +description: The enumeration CameraState of Dynamsoft Camera Enhancer Android describes the camera state. +keywords: Camera state +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: CameraState +--- + +# CameraState + +Enumeration `CameraState` describes the camera state. + +```java +@IntDef({OPENING,OPENED,CLOSING,CLOSED}) +@Retention(RetentionPolicy.CLASS) +public @interface EnumCameraState { + // The camera is opening. + int OPENING = 0; + // The camera is opened. + int OPENED = 1; + // The camera is closing. + int CLOSING = 2; + // The camera is closed. + int CLOSED = 3; +} +``` diff --git a/programming/android/enum/coordinate-base.md b/programming/android/enum/coordinate-base.md new file mode 100644 index 0000000..8378a3e --- /dev/null +++ b/programming/android/enum/coordinate-base.md @@ -0,0 +1,25 @@ +--- +layout: default-layout +title: CoordinateBase - Dynamsoft Camera Enhancer Android Enumerations +description: The enumeration CoordinateBase of Dynamsoft Camera Enhancer Android describes the coordinate base. +keywords: Coordinate base +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: CoordinateBase +--- + +# CoordinateBase + +Enumeration `CoordinateBase` describes the camera position. + +```java +@IntDef({CB_IMAGE,CB_VIEW}) +@Retention(RetentionPolicy.CLASS) +public @interface EnumCoordinateBase { + // pixel, percentage + int CB_IMAGE = 0; + // DP + int CB_VIEW = 1; +} +``` diff --git a/programming/android/enum/drawing-item-media-type.md b/programming/android/enum/drawing-item-media-type.md new file mode 100644 index 0000000..478a62c --- /dev/null +++ b/programming/android/enum/drawing-item-media-type.md @@ -0,0 +1,28 @@ +--- +layout: default-layout +title: DrawingItemMediaType - Dynamsoft Camera Enhancer Android Enumerations +description: The enumeration DrawingItemMediaType of Dynamsoft Camera Enhancer Android describes the media type of DrawingItems. +keywords: DrawingItem, media type +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: DrawingItemMediaType +--- + +# DrawingItemMediaType + +The enumeration `DrawingItemMediaType` describes the media type of DrawingItems. + +```java +@Retention(RetentionPolicy.CLASS) +public @interface EnumDrawingItemMediaType { + // The mediate type of the DrawingItem is rectangle. + int DIMT_RECTANGLE = 1; + // The mediate type of the DrawingItem is quadrilateral. + int DIMT_QUADRILATERAL = 2; + // The mediate type of the DrawingItem is text. + int DIMT_TEXT = 4; + // The mediate type of the DrawingItem is line. + int DIMT_LINE = 8; +} +``` diff --git a/programming/android/enum/drawing-item-state.md b/programming/android/enum/drawing-item-state.md new file mode 100644 index 0000000..0d4ec3f --- /dev/null +++ b/programming/android/enum/drawing-item-state.md @@ -0,0 +1,25 @@ +--- +layout: default-layout +title: DrawingItemState - Dynamsoft Camera Enhancer Android Enumerations +description: The enumeration DrawingItemState of Dynamsoft Camera Enhancer Android describes the state of DrawingItems. +keywords: DrawingItem, state +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: DrawingItemState +--- + +# DrawingItemState + +Enumeration `DrawingItemState` describes the state of DrawingItems. + +```java +@IntDef({DIS_DEFAULT,DIS_SELECTED}) +@Retention(RetentionPolicy.CLASS) +public @interface EnumDrawingItemState { + // The state of the DrawingItem is the default state. + int DIS_DEFAULT = 1; + // The state of the DrawingItem is selected. + int DIS_SELECTED = 2; +} +``` diff --git a/programming/android/enum/enhanced-features.md b/programming/android/enum/enhanced-features.md new file mode 100644 index 0000000..e3cdd58 --- /dev/null +++ b/programming/android/enum/enhanced-features.md @@ -0,0 +1,45 @@ +--- +layout: default-layout +title: EnhancedFeatures - Dynamsoft Camera Enhancer Android Enumerations +description: The enumeration EnhancedFeatures of Dynamsoft Camera Enhancer Android describes the features of camera enhancer. +keywords: Camera enhancer features +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: EnhancedFeatures +--- + +# EnhancedFeatures + +Enumeration `EnhancedFeatures` indicates the advanced features of Dynamsoft Camera Enhancer Android. + +- `Frame Filter`: The frame sharpness filter feature of DCE. By enabling this feature, the low-quality frame will be recognized and discarded automatically. +- `Sensor Control`: The sensor filter feature of DCE. By enabling this feature, the frames will be discarded automatically while the device is shaking. +- `Enhanced Focus`: The enhanced focus feature. DCE will support the camera in triggering auto-focus. +- `Auto Zoom`: The auto-zoom feature of DCE. By enabling this feature, the camera will automatically zoom in to the interest area. +- `Smart Torch`: Add a smart torch on the UI. The torch will be hided when the environment brightness is high and displayed when the brightness is low. + +```java +@Retention(RetentionPolicy.CLASS) +public @interface EnumEnhancedFeatures { + //Enable the Frame filter feature of DCE + int EF_FRAME_FILTER = 0x01; + //Enable the sensor control feature of DCE + int EF_SENSOR_CONTROL = 1 << 1; + //Enable the camera focus features of DCE + int EF_ENHANCED_FOCUS = 1 << 2; + //Enable the autozoom feature + int EF_AUTO_ZOOM = 1 << 3; + //Enable the smart torch button + int EF_SMART_TORCH = 1 << 4; + // All. + int EF_ALL = 0x1F; +} +``` + +> [!Note] +> +> Value changed in v3.2.1000: +> - Changed `EF_AUTO_ZOOM` from `1 << 4` to `1 << 3`. +> - Changed `EF_SMART_TORCH` from `1 << 5` to `1 << 4`. +> - Changed `EF_ALL` from `0x3F` to `0x1F`. diff --git a/programming/android/enum/focus-mode.md b/programming/android/enum/focus-mode.md new file mode 100644 index 0000000..15b6e8f --- /dev/null +++ b/programming/android/enum/focus-mode.md @@ -0,0 +1,25 @@ +--- +layout: default-layout +title: FocusMode - Dynamsoft Camera Enhancer Android Enumerations +description: The enumeration FocusMode of Dynamsoft Camera Enhancer Android describes the focus mode. +keywords: Focus mode +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: FocusMode +--- + +# FocusMode + +Enumeration `FocusMode` describes the focus mode. + +```java +@IntDef({FM_LOCKED,FM_CONTINUOUS_AUTO}) +@Retention(RetentionPolicy.CLASS) +public @interface EnumFocusMode { + // Lock the focal length. + int FM_LOCKED = 1; + // Keep continuous auto-focus. + int FM_CONTINUOUS_AUTO = 2; +} +``` diff --git a/programming/android/enum/resolution.md b/programming/android/enum/resolution.md new file mode 100644 index 0000000..f970d4e --- /dev/null +++ b/programming/android/enum/resolution.md @@ -0,0 +1,31 @@ +--- +layout: default-layout +title: Resolution - Dynamsoft Camera Enhancer Android Enumerations +description: The enumeration Resolution of Dynamsoft Camera Enhancer Android describes the resolution. +keywords: Resolution +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: Resolution +--- + +# EnumResolution + +Enumeration `Resolution` describes the resolution. + +```java +@IntDef({RESOLUTION_AUTO,RESOLUTION_480P,RESOLUTION_720P,RESOLUTION_1080P,RESOLUTION_2K,RESOLUTION_4K}) +@Retention(RetentionPolicy.CLASS) +public @interface EnumResolution { + // 480P + int RESOLUTION_480P = 1; + // 720P + int RESOLUTION_720P = 2; + // 1080P + int RESOLUTION_1080P = 3; + // 2K + int RESOLUTION_2K = 4; + // 4K + int RESOLUTION_4K = 5; +} +``` diff --git a/programming/android/primary-api/camera-enhancer.md b/programming/android/primary-api/camera-enhancer.md index d45bfa0..6730181 100644 --- a/programming/android/primary-api/camera-enhancer.md +++ b/programming/android/primary-api/camera-enhancer.md @@ -339,7 +339,7 @@ A [Capabilities](../auxiliary-api/capabilities.md) object. ### getCameraState -Tells you whether the camera is open, opening, closing, or closed - each state being represented by a member of the [CameraState]({{ site.dce-enums }}camera-state.html) enumeration. +Tells you whether the camera is open, opening, closing, or closed - each state being represented by a member of the [CameraState]({{ site.android }}enum/camera-state.html) enumeration. ```java EnumCameraState getCameraState(){} @@ -363,7 +363,7 @@ void setCameraStateListener (CameraStateListener listener){} ### enableEnhancedFeatures -Enable the specified enhanced features. View [EnumEnhancedFeatures]({{ site.dce-enums }}enhanced-features.html?lang=android) to learn about these enhanced features. By default, these enhanced features are all disabled. +Enable the specified enhanced features. View [EnumEnhancedFeatures]({{ site.android }}enum/enhanced-features.html?lang=android) to learn about these enhanced features. By default, these enhanced features are all disabled. ```java void enableEnhancedFeatures(int enhancedFeatures) throws CameraEnhancerException{} @@ -379,7 +379,7 @@ A bool value that indicates whether the enhanced features are enabled successful ### disableEnhancedFeatures -Disable any enhanced features that have been previously enabled. View [EnumEnhancedFeatures]({{ site.dce-enums }}enhanced-features.html?lang=android) to learn about these enhanced features. +Disable any enhanced features that have been previously enabled. View [EnumEnhancedFeatures]({{ site.android }}enum/enhanced-features.html?lang=android) to learn about these enhanced features. ```java void disableEnhancedFeatures(int enhancerFeatures){} diff --git a/programming/ios/api-reference.md b/programming/ios/api-reference.md index 820f781..e9f334a 100644 --- a/programming/ios/api-reference.md +++ b/programming/ios/api-reference.md @@ -49,11 +49,11 @@ permalink: /programming/ios/api-reference.html ## Enumerations -* [DSCameraPosition]({{ site.dce-enums }}camera-position.html?lang=objc,swift) -* [DSCameraState]({{ site.dce-enums }}camera-state.html?lang=objc,swift) -* [DSCoordinateBase]({{ site.dce-enums }}coordinate-base.html?lang=objc,swift) -* [DSDrawingItemMediaType]({{ site.dce-enums }}drawing-item-media-type.html?lang=objc,swift) -* [DSDrawingItemState]({{ site.dce-enums }}drawing-item-state.html?lang=objc,swift) -* [DSEnhancedFeatures]({{ site.dce-enums }}enhanced-features.html?lang=objc,swift) -* [DSFocusMode]({{ site.dce-enums }}focus-mode.html?lang=objc,swift) -* [DSResolution]({{ site.dce-enums }}resolution.html?lang=objc,swift) +* [DSCameraPosition]({{ site.ios }}enum/camera-position.html?lang=objc,swift) +* [DSCameraState]({{ site.ios }}enum/camera-state.html?lang=objc,swift) +* [DSCoordinateBase]({{ site.ios }}enum/coordinate-base.html?lang=objc,swift) +* [DSDrawingItemMediaType]({{ site.ios }}enum/drawing-item-media-type.html?lang=objc,swift) +* [DSDrawingItemState]({{ site.ios }}enum/drawing-item-state.html?lang=objc,swift) +* [DSEnhancedFeatures]({{ site.ios }}enum/enhanced-features.html?lang=objc,swift) +* [DSFocusMode]({{ site.ios }}enum/focus-mode.html?lang=objc,swift) +* [DSResolution]({{ site.ios }}enum/resolution.html?lang=objc,swift) diff --git a/programming/ios/enum/camera-position.md b/programming/ios/enum/camera-position.md new file mode 100644 index 0000000..d300af2 --- /dev/null +++ b/programming/ios/enum/camera-position.md @@ -0,0 +1,63 @@ +--- +layout: default-layout +title: CameraPosition - Dynamsoft Camera Enhancer iOS Enumerations +description: The enumeration CameraPosition of Dynamsoft Camera Enhancer iOS describes the camera position. +keywords: Camera Position +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: CameraPosition +--- + +# CameraPosition + +Enumeration `CameraPosition` describes the camera position. + +
+ >- Objective-C + >- Swift + > +> +```objc +typedef NS_ENUM(NSInteger, DSCameraPosition) { + /** + * The default back-facing camera. It is a wide-angle camera for general usage. + */ + DSCameraPositionBack, + /** + * The front-facing camera. + */ + DSCameraPositionFront, + /** + * The back-facing ultra-wide-angle camera. It is an ultra-wide-angle camera for macro-distance capturing. + */ + DSCameraPositionBackUltraWide API_AVAILABLE(ios(13.0)), + /** + * 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. + */ + DSCameraPositionBackDualWideAuto API_AVAILABLE(ios(13.0)) +} NS_SWIFT_NAME(CameraPosition); +``` +> +```swift +public enum CameraPosition : Int{ + /** + * The back-facing camera. + */ + back = 0 + /** + * The front-facing camera. + */ + front = 1 + /** + * The back-facing ultra-wide-angle camera. It is an ultra-wide-angle camera for macro-distance capturing. + */ + backUltraWide = 2 + /** + * 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. + */ + backDualWideAuto = 3 +} +``` diff --git a/programming/ios/enum/camera-state.md b/programming/ios/enum/camera-state.md new file mode 100644 index 0000000..4730608 --- /dev/null +++ b/programming/ios/enum/camera-state.md @@ -0,0 +1,62 @@ +--- +layout: default-layout +title: CameraState - Dynamsoft Camera Enhancer iOS Enumerations +description: The enumeration CameraState of Dynamsoft Camera Enhancer iOS describes the camera state. +keywords: Camera state +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: CameraState +--- + +# CameraState + +Enumeration `CameraState` describes the camera state. + +
+ >- Objective-C + >- Swift + > +> +```objc +typedef NS_ENUM(NSInteger, DSCameraState) +{ + /** + * The camera is opening. + */ + DSCameraStateOpening = 0, + /** + * The camera is opened. + */ + DSCameraStateOpened = 1, + /** + * The camera is closing. + */ + DSCameraStateClosing = 2, + /** + * The camera is closed. + */ + DSCameraStateClosed = 3 +}; +``` +> +```swift +public enum CameraState : Int{ + /** + * The camera is opening. + */ + opening = 0 + /** + * The camera is opened. + */ + opened = 1 + /** + * The camera is closing. + */ + closing = 2 + /** + * The camera is closed. + */ + closed = 3 +} +``` diff --git a/programming/ios/enum/coordinate-base.md b/programming/ios/enum/coordinate-base.md new file mode 100644 index 0000000..d36f69c --- /dev/null +++ b/programming/ios/enum/coordinate-base.md @@ -0,0 +1,45 @@ +--- +layout: default-layout +title: CoordinateBase - Dynamsoft Camera Enhancer iOS Enumerations +description: The enumeration CoordinateBase of Dynamsoft Camera Enhancer iOS describes the coordinate base. +keywords: Coordinate base +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: CoordinateBase +--- + +# CoordinateBase + +Enumeration `CoordinateBase` describes the camera position. + +
+ >- Objective-C + >- Swift + > +> +```objc +typedef NS_ENUM(NSInteger, DSCoordinateBase) { + /** + * Image coordinate. + */ + DSCoordinateBaseImage = 0, + /** + * View coordinate. + */ + DSCoordinateBaseView = 1 +}; +``` +> +```swift +public enum CoordinateBase : Int{ + /** + * Image coordinate. + */ + image = 0 + /** + * View coordinate. + */ + view = 1 +} +``` diff --git a/programming/ios/enum/drawing-item-media-type.md b/programming/ios/enum/drawing-item-media-type.md new file mode 100644 index 0000000..2d8025b --- /dev/null +++ b/programming/ios/enum/drawing-item-media-type.md @@ -0,0 +1,61 @@ +--- +layout: default-layout +title: DrawingItemMediaType - Dynamsoft Camera Enhancer iOS Enumerations +description: The enumeration DrawingItemMediaType of Dynamsoft Camera Enhancer iOS describes the media type of DrawingItems. +keywords: DrawingItem, media type +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: DrawingItemMediaType +--- + +# DrawingItemMediaType + +The enumeration `DrawingItemMediaType` describes the media type of DrawingItems. + +
+ >- Objective-C + >- Swift + > +> +```objc +typedef NS_ENUM(NSInteger, DSDrawingItemMediaType) { + /** + * The mediate type of the DrawingItem is rectangle. + */ + DSDrawingItemMediaTypeRectangle = 1, + /** + * The mediate type of the DrawingItem is quadrilateral. + */ + DSDrawingItemMediaTypeQuadrilateral = 2, + /** + * The mediate type of the DrawingItem is text. + */ + DSDrawingItemMediaTypeText = 4, + /** + * The mediate type of the DrawingItem is line. + */ + DSDrawingItemMediaTypeLine = 8 +}; +``` +> +```swift +public enum DrawingItemMediaType : Int{ + /** + * The mediate type of the DrawingItem is rectangle. + */ + rectangle = 1 + /** + * The mediate type of the DrawingItem is quadrilateral. + */ + quadrilateral = 2 + /** + * The mediate type of the DrawingItem is text. + */ + text = 4 + /** + * The mediate type of the DrawingItem is line. + */ + line = 8 +} +``` diff --git a/programming/ios/enum/drawing-item-state.md b/programming/ios/enum/drawing-item-state.md new file mode 100644 index 0000000..b69d6c7 --- /dev/null +++ b/programming/ios/enum/drawing-item-state.md @@ -0,0 +1,45 @@ +--- +layout: default-layout +title: DrawingItemState - Dynamsoft Camera Enhancer iOS Enumerations +description: The enumeration DrawingItemState of Dynamsoft Camera Enhancer iOS describes the state of DrawingItems. +keywords: DrawingItem, state +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: DrawingItemState +--- + +# DrawingItemState + +Enumeration `DrawingItemState` describes the state of DrawingItems. + +
+ >- Objective-C + >- Swift + > +> +```objc +typedef NS_ENUM(NSInteger, DSDrawingItemState) { + /** + * The state of the DrawingItem is the default state. + */ + DSDrawingItemStateDefault = 1, + /** + * The state of the DrawingItem is selected. + */ + DSDrawingItemStateSelected = 2 +}; +``` +> +```swift +public enum EnumDrawingItemState : Int{ + /** + * The state of the DrawingItem is the default state. + */ + default = 1 + /** + * The state of the DrawingItem is selected. + */ + selected = 2 +} +``` diff --git a/programming/ios/enum/enhanced-features.md b/programming/ios/enum/enhanced-features.md new file mode 100644 index 0000000..27ccfb2 --- /dev/null +++ b/programming/ios/enum/enhanced-features.md @@ -0,0 +1,84 @@ +--- +layout: default-layout +title: EnhancedFeatures - Dynamsoft Camera Enhancer iOS Enumerations +description: The enumeration EnhancedFeatures of Dynamsoft Camera Enhancer iOS describes the features of camera enhancer. +keywords: Camera enhancer features +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: EnhancedFeatures +--- + +# EnhancedFeatures + +Enumeration `EnhancedFeatures` indicates the advanced features of Dynamsoft Camera Enhancer iOS. + +- `Frame Filter`: The frame sharpness filter feature of DCE. By enabling this feature, the low-quality frame will be recognized and discarded automatically. +- `Sensor Control`: The sensor filter feature of DCE. By enabling this feature, the frames will be discarded automatically while the device is shaking. +- `Enhanced Focus`: The enhanced focus feature. DCE will support the camera in triggering auto-focus. +- `Auto Zoom`: The auto-zoom feature of DCE. By enabling this feature, the camera will automatically zoom in to the interest area. +- `Smart Torch`: Add a smart torch on the UI. The torch will be hided when the environment brightness is high and displayed when the brightness is low. + +
+ >- Objective-C + >- Swift + > +> +```objc +typedef NS_ENUM(NSInteger, DSEnhancedFeatures) +{ + /** + * Enable frame filter feature of the camera enhancer to make a filter out the low-quality frames. + */ + DSEnhancedFeatureFrameFilter = 1 << 0, + /** + * Enable sensor control to filter out all the frames when the device is shaking. + */ + DSEnhancedFeatureSensorControl = 1 << 1, + /** + * Enhanced focus helps low-end devices on focusing. + */ + DSEnhancedFeatureEnhancedFocus = 1 << 2, + /** + * Enable the camera zoom-in automatically when barcode is far away. + */ + DSEnhancedFeatureAutoZoom = 1 << 3, + /** + * Display a torch button when the environment light is low. + */ + DSEnhancedFeatureSmartTorch = 1 << 4, + /** + * Enable all the enhanced features. + */ + DSEnhancedFeatureAll = NSUIntegerMax +}; +``` +> +```swift +public enum EnhancedFeatures : Int{ + /** + * Enable frame filter feature of the camera enhancer to make a filter out the low-quality frames. + */ + frameFilter = 1 << 0 + /** + * Enable sensor control to filter out all the frames when the device is shaking. + */ + sensorControl = 1 << 1 + /** + * Enhanced focus helps low-end devices on focusing. + */ + enhancedFocus = 1 << 2 + /** + * Enable the camera zoom-in automatically when barcode is far away. + */ + autoZoom = 1 << 3 + /** + * Display a torch button when the environment light is low. + */ + smartTorch = 1 << 4 + /** + * Enable all the enhanced features. + */ + all = UInt.max +} +``` diff --git a/programming/ios/enum/focus-mode.md b/programming/ios/enum/focus-mode.md new file mode 100644 index 0000000..2ea5df0 --- /dev/null +++ b/programming/ios/enum/focus-mode.md @@ -0,0 +1,45 @@ +--- +layout: default-layout +title: FocusMode - Dynamsoft Camera Enhancer iOS Enumerations +description: The enumeration FocusMode of Dynamsoft Camera Enhancer iOS describes the focus mode. +keywords: Focus mode +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: FocusMode +--- + +# FocusMode + +Enumeration `FocusMode` describes the focus mode. + +
+ >- Objective-C + >- Swift + > +> +```objc +typedef NS_ENUM(NSInteger, DSFocusMode){ + /** + * Lock the focal length. + */ + DSFocusModeLocked = 1, + /** + * Enable the continuous auto-focus. + */ + DSFocusModeContinuousAuto = 2 +}; +``` +> +```swift +public enum FocusMode : Int{ + /** + * Lock the focal length. + */ + locked = 1 + /** + * Enable the continuous auto-focus. + */ + continuousAuto = 2 +} +``` diff --git a/programming/ios/enum/resolution.md b/programming/ios/enum/resolution.md new file mode 100644 index 0000000..f39b904 --- /dev/null +++ b/programming/ios/enum/resolution.md @@ -0,0 +1,70 @@ +--- +layout: default-layout +title: Resolution - Dynamsoft Camera Enhancer iOS Enumerations +description: The enumeration Resolution of Dynamsoft Camera Enhancer iOS describes the resolution. +keywords: Resolution +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: Resolution +--- + +# EnumResolution + +Enumeration `Resolution` describes the resolution. + +
+ >- Objective-C + >- Swift + > +> +```objc +typedef NS_ENUM(NSInteger, DSResolution) +{ + /** + * Deprecated + */ + DSResolutionAuto = 0, + /** + * Set the video streaming to the 480P resolution. + */ + DSResolution480P = 1, + /** + * Set the video streaming to the 720P resolution. + */ + DSResolution720P = 2, + /** + * Set the video streaming to the 480P resolution. + */ + DSResolution1080P = 3, + /** + * Set the video streaming to the 4K resolution. + */ + DSResolution4K = 4 +}; +``` +> +```swift +public enum Resolution : Int{ + /** + * Deprecated + */ + auto = 0 + /** + * Set the video streaming to the 480P resolution. + */ + 480P = 1 + /** + * Set the video streaming to the 720P resolution. + */ + 720P = 2 + /** + * Set the video streaming to the 480P resolution. + */ + 1080P = 3 + /** + * Set the video streaming to the 4K resolution. + */ + 4K = 4 +} +``` diff --git a/programming/ios/primary-api/camera-enhancer.md b/programming/ios/primary-api/camera-enhancer.md index 7c62fca..2ce7f5a 100644 --- a/programming/ios/primary-api/camera-enhancer.md +++ b/programming/ios/primary-api/camera-enhancer.md @@ -49,7 +49,7 @@ class CameraEnhancer : ImageSourceAdapter | [`outputEnhancedSettingsToFile`](#outputenhancedsettingstofile) | Output the enhanced settings to a JSON file. The enhanced settings contain auxiliary parameters of enhanced features. | | [`resetEnhancedSettings`](#resetenhancedsettings) | Reset the enhanced settings to default value. | | [`getCapabilities`](#getcapabilities) | Get the device capabilities including zoom factor, ISO, exposure time, etc. | -| [`getCameraState`](#getcamerastate) | Tells you whether the camera is open, opening, closing, or closed - each state being represented by a member of the [CameraState]({{ site.dce-enums }}camera-state.html?lang=objc,swift) enumeration. | +| [`getCameraState`](#getcamerastate) | Tells you whether the camera is open, opening, closing, or closed - each state being represented by a member of the [CameraState]({{ site.ios }}enum/camera-state.html?lang=objc,swift) enumeration. | | [`setCameraStateListener`](#setcamerastatelistener) | Set a DSCameraStateListener to receive callback when the camera state changed. | | [`enableEnhancedFeatures`](#enableenhancedfeatures) | Enable the specified enhanced features. View DSEnhancedFeatures for more details. | | [`disableEnhancedFeatures`](#disableenhancedfeatures) | Disable the specified enhanced features. View DSEnhancedFeatures for more details. | @@ -474,7 +474,7 @@ A [DSCapabilities](../auxiliary-api/capabilities.md) object. ### getCameraState -Tells you whether the camera is open, opening, closing, or closed - each state being represented by a member of the [CameraState]({{ site.dce-enums }}camera-state.html?lang=objc,swift) enumeration. +Tells you whether the camera is open, opening, closing, or closed - each state being represented by a member of the [CameraState]({{ site.ios }}enum/camera-state.html?lang=objc,swift) enumeration.
>- Objective-C @@ -516,7 +516,7 @@ func setCameraStateListener(_ listener: CameraStateListener) ### enableEnhancedFeatures -Enable the specified enhanced features. View [DSEnhancedFeatures]({{ site.dce-enums }}enhanced-features.html?lang=objc,swift) to learn about these enhanced features. By default, these enhanced features are all disabled. +Enable the specified enhanced features. View [DSEnhancedFeatures]({{ site.ios }}enum/enhanced-features.html?lang=objc,swift) to learn about these enhanced features. By default, these enhanced features are all disabled.
>- Objective-C @@ -541,7 +541,7 @@ A bool value that indicates whether the enhanced features are enabled successful ### disableEnhancedFeatures -Disable any enhanced features that have been previously enabled. View [DSEnhancedFeatures]({{ site.dce-enums }}enhanced-features.html?lang=objc,swift) to learn about these enhanced features. +Disable any enhanced features that have been previously enabled. View [DSEnhancedFeatures]({{ site.ios }}enum/enhanced-features.html?lang=objc,swift) to learn about these enhanced features.
>- Objective-C