Skip to content

Preview #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Justin-dynamsoft merged 2 commits into from
Jul 14, 2026
Merged

Preview #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e64915
Remove commented-out API method documentation from acquisition and dr…
Justin-dynamsoft Jul 14, 2026
a8492f5
Remove commented-out API method documentation from acquisition reference
Justin-dynamsoft Jul 14, 2026
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
28 changes: 14 additions & 14 deletions programming/javascript/api-reference/acquisition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,33 +14,20 @@ permalink: /programming/javascript/api-reference/acquisition.html

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

<!--
## addImageToBuffer

Adds an image to the internal buffer.
Expand Down Expand Up @@ -85,6 +72,7 @@ None.
```javascript
cameraEnhancer.clearBuffer()
```
-->

## fetchImage

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

[DCEFrame](interface/dceframe.md)

<!--
## getBufferOverflowProtectionMode

Retrieves the current mode for handling buffer overflow.
Expand All @@ -140,6 +129,7 @@ cameraEnhancer.getBufferOverflowProtectionMode();
**See also**

[EnumBufferOverflowProtectionMode](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/buffer-overflow-protection-mode.html?lang=js)
-->

## getColourChannelUsageType

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

[DCEFrame](interface/dceframe.md)

<!--
## getImageCount

Retrieves the current number of images in the buffer.
Expand Down Expand Up @@ -260,6 +251,7 @@ The maximum image count for the buffer.
```javascript
let bufferSize = cameraEnhancer.getMaxImageCount();
```
-->

## getPixelFormat

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

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

<!--
## hasImage

Checks if an image with the specified ID is present in the buffer.
Expand All @@ -335,6 +328,7 @@ Boolean indicating whether the image is present in the buffer.
```javascript
console.log(cameraEnhancer.hasImage(10));
```
-->

## hasNextImageToFetch

Expand Down Expand Up @@ -384,6 +378,7 @@ if(cameraEnhancer.isBufferEmpty()) {
}
```

<!--
## setBufferOverflowProtectionMode

Sets the behavior for handling new incoming images when the buffer is full.
Expand All @@ -409,6 +404,7 @@ cameraEnhancer.setBufferOverflowProtectionMode(Dynamsoft.Core.EnumBufferOverflow
**See also**

[EnumBufferOverflowProtectionMode](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/buffer-overflow-protection-mode.html?lang=js)
-->

## setColourChannelUsageType

Expand Down Expand Up @@ -436,6 +432,7 @@ cameraEnhancer.setColourChannelUsageType(Dynamsoft.Core.EnumColourChannelUsageTy

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

<!--
## setErrorListener

Sets an error listener to receive notifications about errors that occur during image source operations.
Expand Down Expand Up @@ -555,6 +552,7 @@ None.
```javascript
cameraEnhancer.startFetching();
```
-->

## setPixelFormat

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

> As shown in the code snippet above, `singleFrameMode` should be set before calling `open()`.

<!--
## stopFetching

Stops the process of fetching images.
Expand All @@ -679,6 +678,7 @@ None.
```javascript
cameraEnhancer.stopFetching();
```
-->

## takePhoto

Expand Down
6 changes: 2 additions & 4 deletions programming/javascript/api-reference/drawingitem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ In this version, the subclasses include:

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

## coordinateBase
<!-- ## coordinateBase

Returns or sets the coordinate system base with a string:

Expand All @@ -48,8 +47,7 @@ Returns or sets the coordinate system base with a string:

```typescript
coordinateBase: string;
```

``` -->
## drawingLayerId

Returns the numeric ID for the `DrawingLayer` this `DrawingItem` belongs to.
Expand Down
15 changes: 0 additions & 15 deletions programming/javascript/api-reference/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,31 +75,17 @@ breadcrumbText: API Reference

| Name | Description |
| ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| [addImageToBuffer](./acquisition.md#addImageToBuffer) | Adds an image to the internal buffer. |
| [clearBuffer](./acquisition.md#clearBuffer) | Clears all images from the buffer, resetting the state for new image fetching. |
| [fetchImage](./acquisition.md#fetchImage) | Fetches the current frame from the camera's video feed. |
| [getBufferOverflowProtectionMode](./acquisition.md#getBufferOverflowProtectionMode) | Retrieves the current mode for handling buffer overflow. |
| [getColourChannelUsageType](./acquisition.md#getColourChannelUsageType) | Retrieves the current usage type for color channels in images. |
| [getImage](./acquisition.md#getImage) | Retrieves a buffered image, of type `DSImageData`. |
| [getImageCount](./acquisition.md#getImageCount) | Retrieves the current number of images in the buffer. |
| [getImageFetchInterval](./acquisition.md#getImageFetchInterval) | Retrieves the current interval at which images are continuously fetched from the camera's video feed. |
| [getMaxImageCount](./acquisition.md#getMaxImageCount) | Retrieves the maximum number of images that can be buffered. |
| [getPixelFormat](./acquisition.md#getPixelFormat) | Retrieves the current pixel format used for images fetched from the camera. |
| [getScanRegion](./acquisition.md#getScanRegion) | Retrieves the current scan region set within the camera's view. |
| [hasImage](./acquisition.md#hasImage) | Checks if an image with the specified ID is present in the buffer. |
| [hasNextImageToFetch](./acquisition.md#hasNextImageToFetch) | Determines whether there are more images available to fetch. |
| [isBufferEmpty](./acquisition.md#isBufferEmpty) | Determines whether the buffer is currently empty. |
| [setBufferOverflowProtectionMode](./acquisition.md#setBufferOverflowProtectionMode) | Sets the behavior for handling new incoming images when the buffer is full. |
| [setColourChannelUsageType](./acquisition.md#setColourChannelUsageType) | Sets the usage type for color channels in images. |
| [setErrorListener](./acquisition.md#setErrorListener) | Sets an error listener to receive notifications about errors that occur during image source operations. |
| [setImageFetchInterval](./acquisition.md#setImageFetchInterval) | Sets the interval at which images are continuously fetched from the camera's video feed. |
| [setMaxImageCount](./acquisition.md#setMaxImageCount) | Sets the maximum number of images that can be buffered at any time. |
| [setNextImageToReturn](./acquisition.md#setNextImageToReturn) | Sets the processing priority of a specific image so that it is returned the next time `getImage()` is called. |
| [setPixelFormat](./acquisition.md#setPixelFormat) | Sets the pixel format for the images fetched from the camera. |
| [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. |
| [singleFrameMode](./acquisition.md#singleFrameMode) | Controls the single-frame mode of the `CameraEnhancer`. |
| [startFetching](./acquisition.md#startFetching) | Starts the process of fetching images. |
| [stopFetching](./acquisition.md#stopFetching) | Stops the process of fetching images. |
| [takePhoto](./acquisition.md#takePhoto) | Initiates a sequence to capture a single frame/image, halting the video stream temporarily. |

### UI
Expand Down Expand Up @@ -185,7 +171,6 @@ breadcrumbText: API Reference

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