Skip to content

Commit 9ffbd4a

Browse files
Justin-dynamsoftJustin-dynamsoft
authored
Merge pull request #78 from dynamsoft-docs/preview
Preview
2 parents ab19ef9 + a8492f5 commit 9ffbd4a

3 files changed

Lines changed: 16 additions & 33 deletions

File tree

‎programming/javascript/api-reference/acquisition.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,33 +14,20 @@ permalink: /programming/javascript/api-reference/acquisition.html
1414

1515
| Name | Description |
1616
| ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
17-
| [addImageToBuffer](#addImageToBuffer) | Adds an image to the internal buffer. |
18-
| [clearBuffer](#clearBuffer) | Clears all images from the buffer, resetting the state for new image fetching. |
1917
| [fetchImage](#fetchImage) | Fetches the current frame from the camera's video feed. |
20-
| [getBufferOverflowProtectionMode](#getBufferOverflowProtectionMode) | Retrieves the current mode for handling buffer overflow. |
2118
| [getColourChannelUsageType](#getColourChannelUsageType) | Retrieves the current usage type for color channels in images. |
2219
| [getImage](#getImage) | Retrieves a buffered image, of type `DSImageData`. |
23-
| [getImageCount](#getImageCount) | Retrieves the current number of images in the buffer. |
24-
| [getImageFetchInterval](#getImageFetchInterval) | Retrieves the current interval at which images are continuously fetched from the camera's video feed. |
25-
| [getMaxImageCount](#getMaxImageCount) | Retrieves the maximum number of images that can be buffered. |
2620
| [getPixelFormat](#getPixelFormat) | Retrieves the current pixel format used for images fetched from the camera. |
2721
| [getScanRegion](#getScanRegion) | Retrieves the current scan region set within the camera's view. |
28-
| [hasImage](#hasImage) | Checks if an image with the specified ID is present in the buffer. |
2922
| [hasNextImageToFetch](#hasNextImageToFetch) | Determines whether there are more images available to fetch. |
3023
| [isBufferEmpty](#isBufferEmpty) | Determines whether the buffer is currently empty. |
31-
| [setBufferOverflowProtectionMode](#setBufferOverflowProtectionMode) | Sets the behavior for handling new incoming images when the buffer is full. |
3224
| [setColourChannelUsageType](#setColourChannelUsageType) | Sets the usage type for color channels in images. |
33-
| [setErrorListener](#setErrorListener) | Sets an error listener to receive notifications about errors that occur during image source operations. |
34-
| [setImageFetchInterval](#setImageFetchInterval) | Sets the interval at which images are continuously fetched from the camera's video feed. |
35-
| [setMaxImageCount](#setMaxImageCount) | Sets the maximum number of images that can be buffered at any time. |
36-
| [setNextImageToReturn](#setNextImageToReturn) | Sets the processing priority of a specific image so that it is returned the next time `getImage()` is called. |
3725
| [setPixelFormat](#setPixelFormat) | Sets the pixel format for the images fetched from the camera. |
3826
| [setScanRegion](#setScanRegion) | Sets the scan region within the camera's view which limits the frame acquisition to a specific area of the video feed. |
3927
| [singleFrameMode](#singleFrameMode) | Controls the single-frame mode of the `CameraEnhancer`. |
40-
| [startFetching](#startFetching) | Starts the process of fetching images. |
41-
| [stopFetching](#stopFetching) | Stops the process of fetching images. |
4228
| [takePhoto](#takePhoto) | Initiates a sequence to capture a single frame/image, halting the video stream temporarily. |
4329

30+
<!--
4431
## addImageToBuffer
4532
4633
Adds an image to the internal buffer.
@@ -85,6 +72,7 @@ None.
8572
```javascript
8673
cameraEnhancer.clearBuffer()
8774
```
75+
-->
8876

8977
## fetchImage
9078

@@ -115,6 +103,7 @@ document.body.appendChild(image.toCanvas());
115103

116104
[DCEFrame](interface/dceframe.md)
117105

106+
<!--
118107
## getBufferOverflowProtectionMode
119108
120109
Retrieves the current mode for handling buffer overflow.
@@ -140,6 +129,7 @@ cameraEnhancer.getBufferOverflowProtectionMode();
140129
**See also**
141130
142131
[EnumBufferOverflowProtectionMode](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/buffer-overflow-protection-mode.html?lang=js)
132+
-->
143133

144134
## getColourChannelUsageType
145135

@@ -195,6 +185,7 @@ document.body.appendChild(image.toCanvas());
195185

196186
[DCEFrame](interface/dceframe.md)
197187

188+
<!--
198189
## getImageCount
199190
200191
Retrieves the current number of images in the buffer.
@@ -260,6 +251,7 @@ The maximum image count for the buffer.
260251
```javascript
261252
let bufferSize = cameraEnhancer.getMaxImageCount();
262253
```
254+
-->
263255

264256
## getPixelFormat
265257

@@ -314,6 +306,7 @@ let region = cameraEnhancer.getScanRegion();
314306

315307
[DSRect](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/ds-rect.html)
316308

309+
<!--
317310
## hasImage
318311
319312
Checks if an image with the specified ID is present in the buffer.
@@ -335,6 +328,7 @@ Boolean indicating whether the image is present in the buffer.
335328
```javascript
336329
console.log(cameraEnhancer.hasImage(10));
337330
```
331+
-->
338332

339333
## hasNextImageToFetch
340334

@@ -384,6 +378,7 @@ if(cameraEnhancer.isBufferEmpty()) {
384378
}
385379
```
386380

381+
<!--
387382
## setBufferOverflowProtectionMode
388383
389384
Sets the behavior for handling new incoming images when the buffer is full.
@@ -409,6 +404,7 @@ cameraEnhancer.setBufferOverflowProtectionMode(Dynamsoft.Core.EnumBufferOverflow
409404
**See also**
410405
411406
[EnumBufferOverflowProtectionMode](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/buffer-overflow-protection-mode.html?lang=js)
407+
-->
412408

413409
## setColourChannelUsageType
414410

@@ -436,6 +432,7 @@ cameraEnhancer.setColourChannelUsageType(Dynamsoft.Core.EnumColourChannelUsageTy
436432

437433
[EnumColourChannelUsageType](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/colour-channel-usage-type.html?lang=js)
438434

435+
<!--
439436
## setErrorListener
440437
441438
Sets an error listener to receive notifications about errors that occur during image source operations.
@@ -555,6 +552,7 @@ None.
555552
```javascript
556553
cameraEnhancer.startFetching();
557554
```
555+
-->
558556

559557
## setPixelFormat
560558

@@ -658,6 +656,7 @@ singleFrameMode: "disabled" | "camera" | "image";
658656

659657
> As shown in the code snippet above, `singleFrameMode` should be set before calling `open()`.
660658
659+
<!--
661660
## stopFetching
662661
663662
Stops the process of fetching images.
@@ -679,6 +678,7 @@ None.
679678
```javascript
680679
cameraEnhancer.stopFetching();
681680
```
681+
-->
682682

683683
## takePhoto
684684

‎programming/javascript/api-reference/drawingitem.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ In this version, the subclasses include:
2424

2525
| Name | Description |
2626
| --------------------------------- | ------------------------------------------------------------------------------------------------------ |
27-
| [coordinateBase](#coordinatebase) | Returns or sets the coordinate system base. |
2827
| [drawingLayerId](#drawinglayerid) | Returns the numeric ID for the `DrawingLayer` this `DrawingItem` belongs to. |
2928
| [drawingStyleId](#drawingstyleid) | Returns or sets the numeric ID for the `DrawingStyle` that applies to this `DrawingItem`. |
3029
| [mediaType](#mediatype) | Returns an enumeration value which indicates the type of this `DrawingItem` (e.g., image, line, text). |
@@ -39,7 +38,7 @@ In this version, the subclasses include:
3938
| [deleteNote()](#deletenote) | Deletes a `Note` object specified by its name. |
4039
| [clearNotes()](#clearnotes) | Deletes all `Note` objects on this `DrawingItem`. |
4140

42-
## coordinateBase
41+
<!-- ## coordinateBase
4342
4443
Returns or sets the coordinate system base with a string:
4544
@@ -48,8 +47,7 @@ Returns or sets the coordinate system base with a string:
4847
4948
```typescript
5049
coordinateBase: string;
51-
```
52-
50+
``` -->
5351
## drawingLayerId
5452

5553
Returns the numeric ID for the `DrawingLayer` this `DrawingItem` belongs to.

‎programming/javascript/api-reference/index.md‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -75,31 +75,17 @@ breadcrumbText: API Reference
7575

7676
| Name | Description |
7777
| ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
78-
| [addImageToBuffer](./acquisition.md#addImageToBuffer) | Adds an image to the internal buffer. |
79-
| [clearBuffer](./acquisition.md#clearBuffer) | Clears all images from the buffer, resetting the state for new image fetching. |
8078
| [fetchImage](./acquisition.md#fetchImage) | Fetches the current frame from the camera's video feed. |
81-
| [getBufferOverflowProtectionMode](./acquisition.md#getBufferOverflowProtectionMode) | Retrieves the current mode for handling buffer overflow. |
8279
| [getColourChannelUsageType](./acquisition.md#getColourChannelUsageType) | Retrieves the current usage type for color channels in images. |
8380
| [getImage](./acquisition.md#getImage) | Retrieves a buffered image, of type `DSImageData`. |
84-
| [getImageCount](./acquisition.md#getImageCount) | Retrieves the current number of images in the buffer. |
85-
| [getImageFetchInterval](./acquisition.md#getImageFetchInterval) | Retrieves the current interval at which images are continuously fetched from the camera's video feed. |
86-
| [getMaxImageCount](./acquisition.md#getMaxImageCount) | Retrieves the maximum number of images that can be buffered. |
8781
| [getPixelFormat](./acquisition.md#getPixelFormat) | Retrieves the current pixel format used for images fetched from the camera. |
8882
| [getScanRegion](./acquisition.md#getScanRegion) | Retrieves the current scan region set within the camera's view. |
89-
| [hasImage](./acquisition.md#hasImage) | Checks if an image with the specified ID is present in the buffer. |
9083
| [hasNextImageToFetch](./acquisition.md#hasNextImageToFetch) | Determines whether there are more images available to fetch. |
9184
| [isBufferEmpty](./acquisition.md#isBufferEmpty) | Determines whether the buffer is currently empty. |
92-
| [setBufferOverflowProtectionMode](./acquisition.md#setBufferOverflowProtectionMode) | Sets the behavior for handling new incoming images when the buffer is full. |
9385
| [setColourChannelUsageType](./acquisition.md#setColourChannelUsageType) | Sets the usage type for color channels in images. |
94-
| [setErrorListener](./acquisition.md#setErrorListener) | Sets an error listener to receive notifications about errors that occur during image source operations. |
95-
| [setImageFetchInterval](./acquisition.md#setImageFetchInterval) | Sets the interval at which images are continuously fetched from the camera's video feed. |
96-
| [setMaxImageCount](./acquisition.md#setMaxImageCount) | Sets the maximum number of images that can be buffered at any time. |
97-
| [setNextImageToReturn](./acquisition.md#setNextImageToReturn) | Sets the processing priority of a specific image so that it is returned the next time `getImage()` is called. |
9886
| [setPixelFormat](./acquisition.md#setPixelFormat) | Sets the pixel format for the images fetched from the camera. |
9987
| [setScanRegion](./acquisition.md#setScanRegion) | Sets the scan region within the camera's view which limits the frame acquisition to a specific area of the video feed. |
10088
| [singleFrameMode](./acquisition.md#singleFrameMode) | Controls the single-frame mode of the `CameraEnhancer`. |
101-
| [startFetching](./acquisition.md#startFetching) | Starts the process of fetching images. |
102-
| [stopFetching](./acquisition.md#stopFetching) | Stops the process of fetching images. |
10389
| [takePhoto](./acquisition.md#takePhoto) | Initiates a sequence to capture a single frame/image, halting the video stream temporarily. |
10490

10591
### UI
@@ -185,7 +171,6 @@ breadcrumbText: API Reference
185171

186172
| Name | Description |
187173
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
188-
| [coordinateBase](./drawingitem.md#coordinatebase) | Returns or sets the coordinate system base. |
189174
| [drawingLayerId](./drawingitem.md#drawinglayerid) | Returns the numeric ID for the `DrawingLayer` this `DrawingItem` belongs to. |
190175
| [drawingStyleId](./drawingitem.md#drawingstyleid) | Returns or sets the numeric ID for the `DrawingStyle` that applies to this `DrawingItem`. |
191176
| [mediaType](./drawingitem.md#mediatype) | Returns an enumeration value which indicates the type of this `DrawingItem` (e.g., image, line, text). |

0 commit comments

Comments
 (0)