Class ImageSourceAdapter`Abstract`

The ImageSourceAdapter class provides an interface for fetching and buffering images. It is an abstract class that needs to be implemented by a concrete class to provide actual functionality. Each ImageSourceAdapter instance object will correspond to a native instance object.

See

Hierarchy (View Summary)

ImageSourceAdapter
- CameraEnhancer

Index

Properties

Methods

addImageToBuffer clearBuffer destroy getColourChannelUsageType getImageCount getImageData getMaximumImageCount init isBufferEmpty setColourChannelUsageType setMaximumImageCount startFetching stopFetching

Properties

`Protected`isaId

isaId: string = ""

Methods

addImageToBuffer

addImageToBuffer(imageData: ImageData): void
Adds an image to the buffer of the adapter.
Parameters
- imageData: ImageData
  The ImageData object to be added to the buffer.
Returns void

clearBuffer

clearBuffer(): Promise<void>
Clear the image buffer.

Returns Promise<void>

destroy

destroy(): void
Destroy native instance. This object is no longer available after destroy().

Returns void

getColourChannelUsageType

getColourChannelUsageType(): Promise<EnumColourChannelUsageType>
Get the current usage type for color channels in images.

Returns Promise<EnumColourChannelUsageType>
- A promise that resolves to an enum representing the color channel usage type.

getImageCount

getImageCount(): Promise<number>
Get the current number of images in the buffer.

Returns Promise<number>
- A promise that resolves to the number of images in the buffer.

getImageData

getImageData(): undefined | null | ImageData
Get a buffered image.

Returns undefined | null | ImageData
- The ImageData object if available, otherwisenull or undefined if no image is found in the buffer.

getMaximumImageCount

getMaximumImageCount(): Promise<number>
Get the maximum number of images that can be buffered.

Returns Promise<number>
- A promise that resolves to the maximum capability of the Buffer.

`Protected`init

init(): void
Returns void

isBufferEmpty

isBufferEmpty(): Promise<boolean>
Determines whether the buffer is empty.

Returns Promise<boolean>

setColourChannelUsageType

setColourChannelUsageType(type: EnumColourChannelUsageType): Promise<void>
Set the usage type of a color channel in images.
Parameters
- type: EnumColourChannelUsageType
  The usage type(EnumColourChannelUsageType) to be set for the color channel.
Returns Promise<void>

setMaximumImageCount

setMaximumImageCount(count: number): Promise<void>
Set the maximum number of images that can be buffered at any time.
Parameters
- count: number
  The maximum capability of the Buffer.
Returns Promise<void>

startFetching

startFetching(): void
Start fetching images from the source to the Buffer of ImageSourceAdapter.

Returns void

stopFetching

stopFetching(): void
Stop fetching images from the source to the Buffer of ImageSourceAdapter.

Returns void