Skip to content

Commit f01215a

Browse files
Dynamsoft-HenryDynamsoft-Henry
authored
Merge pull request #68 from dynamsoft-docs/preview
Updating enums
2 parents 43c9b9d + 7d413c6 commit f01215a

20 files changed

+731
-23
lines changed

‎programming/android/api-reference.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ permalink: /programming/android/api-reference.html
5151

5252
## Enumerations
5353

54-
* [EnumCameraPosition]({{ site.dce-enums }}camera-position.html?lang=android)
55-
* [EnumCameraState]({{ site.dce-enums }}camera-state.html?lang=android)
56-
* [EnumCoordinateBase]({{ site.dce-enums }}coordinate-base.html?lang=android)
57-
* [EnumDrawingItemMediaType]({{ site.dce-enums }}drawing-item-media-type.html?lang=android)
58-
* [EnumDrawingItemState]({{ site.dce-enums }}drawing-item-state.html?lang=android)
59-
* [EnumEnhancedFeatures]({{ site.dce-enums }}enhanced-features.html?lang=android)
60-
* [EnumFocusMode]({{ site.dce-enums }}focus-mode.html?lang=android)
61-
* [EnumResolution]({{ site.dce-enums }}resolution.html?lang=android)
54+
* [EnumCameraPosition]({{ site.android }}enum/camera-position.html?lang=android)
55+
* [EnumCameraState]({{ site.android }}enum/camera-state.html?lang=android)
56+
* [EnumCoordinateBase]({{ site.android }}enum/coordinate-base.html?lang=android)
57+
* [EnumDrawingItemMediaType]({{ site.android }}enum/drawing-item-media-type.html?lang=android)
58+
* [EnumDrawingItemState]({{ site.android }}enum/drawing-item-state.html?lang=android)
59+
* [EnumEnhancedFeatures]({{ site.android }}enum/enhanced-features.html?lang=android)
60+
* [EnumFocusMode]({{ site.android }}enum/focus-mode.html?lang=android)
61+
* [EnumResolution]({{ site.android }}enum/resolution.html?lang=android)

‎programming/android/enum/camera-position.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: default-layout
3+
title: CameraPosition - Dynamsoft Camera Enhancer Android Enumerations
4+
description: The enumeration CameraPosition of Dynamsoft Camera Enhancer Android describes the camera position.
5+
keywords: Camera Position
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: CameraPosition
10+
---
11+
12+
# CameraPosition
13+
14+
Enumeration `CameraPosition` describes the camera position.
15+
16+
```java
17+
@IntDef({CP_FRONT,CP_BACK})
18+
@Retention(RetentionPolicy.CLASS)
19+
public @interface EnumCameraPosition {
20+
// The back-facing camera.
21+
int CP_BACK= 0;
22+
// The front-facing camera.
23+
int CP_FRONT = 1;
24+
}
25+
```

‎programming/android/enum/camera-state.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
layout: default-layout
3+
title: CameraState - Dynamsoft Camera Enhancer Android Enumerations
4+
description: The enumeration CameraState of Dynamsoft Camera Enhancer Android describes the camera state.
5+
keywords: Camera state
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: CameraState
10+
---
11+
12+
# CameraState
13+
14+
Enumeration `CameraState` describes the camera state.
15+
16+
```java
17+
@IntDef({OPENING,OPENED,CLOSING,CLOSED})
18+
@Retention(RetentionPolicy.CLASS)
19+
public @interface EnumCameraState {
20+
// The camera is opening.
21+
int OPENING = 0;
22+
// The camera is opened.
23+
int OPENED = 1;
24+
// The camera is closing.
25+
int CLOSING = 2;
26+
// The camera is closed.
27+
int CLOSED = 3;
28+
}
29+
```

‎programming/android/enum/coordinate-base.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: default-layout
3+
title: CoordinateBase - Dynamsoft Camera Enhancer Android Enumerations
4+
description: The enumeration CoordinateBase of Dynamsoft Camera Enhancer Android describes the coordinate base.
5+
keywords: Coordinate base
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: CoordinateBase
10+
---
11+
12+
# CoordinateBase
13+
14+
Enumeration `CoordinateBase` describes the camera position.
15+
16+
```java
17+
@IntDef({CB_IMAGE,CB_VIEW})
18+
@Retention(RetentionPolicy.CLASS)
19+
public @interface EnumCoordinateBase {
20+
// pixel, percentage
21+
int CB_IMAGE = 0;
22+
// DP
23+
int CB_VIEW = 1;
24+
}
25+
```

‎programming/android/enum/drawing-item-media-type.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
layout: default-layout
3+
title: DrawingItemMediaType - Dynamsoft Camera Enhancer Android Enumerations
4+
description: The enumeration DrawingItemMediaType of Dynamsoft Camera Enhancer Android describes the media type of DrawingItems.
5+
keywords: DrawingItem, media type
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: DrawingItemMediaType
10+
---
11+
12+
# DrawingItemMediaType
13+
14+
The enumeration `DrawingItemMediaType` describes the media type of DrawingItems.
15+
16+
```java
17+
@Retention(RetentionPolicy.CLASS)
18+
public @interface EnumDrawingItemMediaType {
19+
// The mediate type of the DrawingItem is rectangle.
20+
int DIMT_RECTANGLE = 1;
21+
// The mediate type of the DrawingItem is quadrilateral.
22+
int DIMT_QUADRILATERAL = 2;
23+
// The mediate type of the DrawingItem is text.
24+
int DIMT_TEXT = 4;
25+
// The mediate type of the DrawingItem is line.
26+
int DIMT_LINE = 8;
27+
}
28+
```

‎programming/android/enum/drawing-item-state.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: default-layout
3+
title: DrawingItemState - Dynamsoft Camera Enhancer Android Enumerations
4+
description: The enumeration DrawingItemState of Dynamsoft Camera Enhancer Android describes the state of DrawingItems.
5+
keywords: DrawingItem, state
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: DrawingItemState
10+
---
11+
12+
# DrawingItemState
13+
14+
Enumeration `DrawingItemState` describes the state of DrawingItems.
15+
16+
```java
17+
@IntDef({DIS_DEFAULT,DIS_SELECTED})
18+
@Retention(RetentionPolicy.CLASS)
19+
public @interface EnumDrawingItemState {
20+
// The state of the DrawingItem is the default state.
21+
int DIS_DEFAULT = 1;
22+
// The state of the DrawingItem is selected.
23+
int DIS_SELECTED = 2;
24+
}
25+
```

‎programming/android/enum/enhanced-features.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
layout: default-layout
3+
title: EnhancedFeatures - Dynamsoft Camera Enhancer Android Enumerations
4+
description: The enumeration EnhancedFeatures of Dynamsoft Camera Enhancer Android describes the features of camera enhancer.
5+
keywords: Camera enhancer features
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: EnhancedFeatures
10+
---
11+
12+
# EnhancedFeatures
13+
14+
Enumeration `EnhancedFeatures` indicates the advanced features of Dynamsoft Camera Enhancer Android.
15+
16+
- `Frame Filter`: The frame sharpness filter feature of DCE. By enabling this feature, the low-quality frame will be recognized and discarded automatically.
17+
- `Sensor Control`: The sensor filter feature of DCE. By enabling this feature, the frames will be discarded automatically while the device is shaking.
18+
- `Enhanced Focus`: The enhanced focus feature. DCE will support the camera in triggering auto-focus.
19+
- `Auto Zoom`: The auto-zoom feature of DCE. By enabling this feature, the camera will automatically zoom in to the interest area.
20+
- `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.
21+
22+
```java
23+
@Retention(RetentionPolicy.CLASS)
24+
public @interface EnumEnhancedFeatures {
25+
//Enable the Frame filter feature of DCE
26+
int EF_FRAME_FILTER = 0x01;
27+
//Enable the sensor control feature of DCE
28+
int EF_SENSOR_CONTROL = 1 << 1;
29+
//Enable the camera focus features of DCE
30+
int EF_ENHANCED_FOCUS = 1 << 2;
31+
//Enable the autozoom feature
32+
int EF_AUTO_ZOOM = 1 << 3;
33+
//Enable the smart torch button
34+
int EF_SMART_TORCH = 1 << 4;
35+
// All.
36+
int EF_ALL = 0x1F;
37+
}
38+
```
39+
40+
> [!Note]
41+
>
42+
> Value changed in v3.2.1000:
43+
> - Changed `EF_AUTO_ZOOM` from `1 << 4` to `1 << 3`.
44+
> - Changed `EF_SMART_TORCH` from `1 << 5` to `1 << 4`.
45+
> - Changed `EF_ALL` from `0x3F` to `0x1F`.

‎programming/android/enum/focus-mode.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: default-layout
3+
title: FocusMode - Dynamsoft Camera Enhancer Android Enumerations
4+
description: The enumeration FocusMode of Dynamsoft Camera Enhancer Android describes the focus mode.
5+
keywords: Focus mode
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: FocusMode
10+
---
11+
12+
# FocusMode
13+
14+
Enumeration `FocusMode` describes the focus mode.
15+
16+
```java
17+
@IntDef({FM_LOCKED,FM_CONTINUOUS_AUTO})
18+
@Retention(RetentionPolicy.CLASS)
19+
public @interface EnumFocusMode {
20+
// Lock the focal length.
21+
int FM_LOCKED = 1;
22+
// Keep continuous auto-focus.
23+
int FM_CONTINUOUS_AUTO = 2;
24+
}
25+
```

‎programming/android/enum/resolution.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: default-layout
3+
title: Resolution - Dynamsoft Camera Enhancer Android Enumerations
4+
description: The enumeration Resolution of Dynamsoft Camera Enhancer Android describes the resolution.
5+
keywords: Resolution
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: Resolution
10+
---
11+
12+
# EnumResolution
13+
14+
Enumeration `Resolution` describes the resolution.
15+
16+
```java
17+
@IntDef({RESOLUTION_AUTO,RESOLUTION_480P,RESOLUTION_720P,RESOLUTION_1080P,RESOLUTION_2K,RESOLUTION_4K})
18+
@Retention(RetentionPolicy.CLASS)
19+
public @interface EnumResolution {
20+
// 480P
21+
int RESOLUTION_480P = 1;
22+
// 720P
23+
int RESOLUTION_720P = 2;
24+
// 1080P
25+
int RESOLUTION_1080P = 3;
26+
// 2K
27+
int RESOLUTION_2K = 4;
28+
// 4K
29+
int RESOLUTION_4K = 5;
30+
}
31+
```

‎programming/android/primary-api/camera-enhancer.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ A [Capabilities](../auxiliary-api/capabilities.md) object.
339339

340340
### getCameraState
341341

342-
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.
342+
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.
343343

344344
```java
345345
EnumCameraState getCameraState(){}
@@ -363,7 +363,7 @@ void setCameraStateListener (CameraStateListener listener){}
363363

364364
### enableEnhancedFeatures
365365

366-
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.
366+
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.
367367

368368
```java
369369
void enableEnhancedFeatures(int enhancedFeatures) throws CameraEnhancerException{}
@@ -379,7 +379,7 @@ A bool value that indicates whether the enhanced features are enabled successful
379379

380380
### disableEnhancedFeatures
381381

382-
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.
382+
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.
383383

384384
```java
385385
void disableEnhancedFeatures(int enhancerFeatures){}

0 commit comments

Comments
 (0)