Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions programming/android/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
25 changes: 25 additions & 0 deletions programming/android/enum/camera-position.md
Original file line number Diff line number Diff line change
@@ -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;
}
```
29 changes: 29 additions & 0 deletions programming/android/enum/camera-state.md
Original file line number Diff line number Diff line change
@@ -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;
}
```
25 changes: 25 additions & 0 deletions programming/android/enum/coordinate-base.md
Original file line number Diff line number Diff line change
@@ -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;
}
```
28 changes: 28 additions & 0 deletions programming/android/enum/drawing-item-media-type.md
Original file line number Diff line number Diff line change
@@ -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;
}
```
25 changes: 25 additions & 0 deletions programming/android/enum/drawing-item-state.md
Original file line number Diff line number Diff line change
@@ -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;
}
```
45 changes: 45 additions & 0 deletions programming/android/enum/enhanced-features.md
Original file line number Diff line number Diff line change
@@ -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`.
25 changes: 25 additions & 0 deletions programming/android/enum/focus-mode.md
Original file line number Diff line number Diff line change
@@ -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;
}
```
31 changes: 31 additions & 0 deletions programming/android/enum/resolution.md
Original file line number Diff line number Diff line change
@@ -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;
}
```
6 changes: 3 additions & 3 deletions programming/android/primary-api/camera-enhancer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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(){}
Expand All @@ -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{}
Expand All @@ -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){}
Expand Down
16 changes: 8 additions & 8 deletions programming/ios/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
63 changes: 63 additions & 0 deletions programming/ios/enum/camera-position.md
Original file line number Diff line number Diff line change
@@ -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.

<div class="sample-code-prefix template2"></div>
>- 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
}
```
Loading