Awesome

capacitor-plugin-dynamsoft-camera-preview

A Capacitor plugin for camera preview using Dynamsoft Camera Enhancer.

Online Demo

Note: This package is not actively maintained. Please use capacitor-plugin-camera.

Supported Platforms

• Web
• Android
• iOS

Versions

For Capacitor v5, use v2.x.

For Capacitor v4, use v1.x.

Install

npm install capacitor-plugin-dynamsoft-camera-preview
npx cap sync

Get Bitmap/UIImage via Reflection

If you are developing a plugin, you can use reflection to get the camera frames as Bitmap or UIImage on the native side.

Java:

Class cls = Class.forName("com.dynamsoft.capacitor.dce.CameraPreviewPlugin");
Method m = cls.getMethod("getBitmap",null);
Bitmap bitmap = (Bitmap) m.invoke(null, null);

Objective-C:

- (UIImage*)getUIImage{
    UIImage *image = ((UIImage* (*)(id, SEL))objc_msgSend)(objc_getClass("CameraPreviewPlugin"), sel_registerName("getBitmap"));
    return image;
}

API

• initialize()
• getResolution()
• setResolution(...)
• getAllCameras()
• getSelectedCamera()
• selectCamera(...)
• setScanRegion(...)
• setZoom(...)
• setFocus(...)
• setDefaultUIElementURL(...)
• startCamera()
• stopCamera()
• pauseCamera()
• resumeCamera()
• takeSnapshot(...)
• takeSnapshot2()
• takePhoto()
• toggleTorch(...)
• requestCameraPermission()
• isOpen()
• addListener('onPlayed', ...)
• removeAllListeners()
• Interfaces
• Type Aliases

initialize()

initialize() => Promise<void>

getResolution()

getResolution() => Promise<{ resolution: string; }>

Returns: <code>Promise<{ resolution: string; }></code>

setResolution(...)

setResolution(options: { resolution: number; }) => Promise<void>

getAllCameras()

getAllCameras() => Promise<{ cameras: string[]; }>

Returns: <code>Promise<{ cameras: string[]; }></code>

getSelectedCamera()

getSelectedCamera() => Promise<{ selectedCamera: string; }>

Returns: <code>Promise<{ selectedCamera: string; }></code>

selectCamera(...)

selectCamera(options: { cameraID: string; }) => Promise<void>

setScanRegion(...)

setScanRegion(options: { region: ScanRegion; }) => Promise<void>

setZoom(...)

setZoom(options: { factor: number; }) => Promise<void>

setFocus(...)

setFocus(options: { x: number; y: number; }) => Promise<void>

setDefaultUIElementURL(...)

setDefaultUIElementURL(url: string) => Promise<void>

Web Only

startCamera()

startCamera() => Promise<void>

stopCamera()

stopCamera() => Promise<void>

pauseCamera()

pauseCamera() => Promise<void>

resumeCamera()

resumeCamera() => Promise<void>

takeSnapshot(...)

takeSnapshot(options: { quality?: number; }) => Promise<{ base64: string; }>

take a snapshot as base64.

Returns: <code>Promise<{ base64: string; }></code>

takeSnapshot2()

takeSnapshot2() => Promise<{ frame: DCEFrame; }>

take a snapshot as <a href="#dceframe">DCEFrame</a>. Web Only

Returns: <code>Promise<{ frame: <a href="#dceframe">DCEFrame</a>; }></code>

takePhoto()

takePhoto() => Promise<{ base64: string; }>

Returns: <code>Promise<{ base64: string; }></code>

toggleTorch(...)

toggleTorch(options: { on: boolean; }) => Promise<void>

requestCameraPermission()

requestCameraPermission() => Promise<void>

isOpen()

isOpen() => Promise<{ isOpen: boolean; }>

Returns: <code>Promise<{ isOpen: boolean; }></code>

addListener('onPlayed', ...)

addListener(eventName: 'onPlayed', listenerFunc: onPlayedListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Returns: <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>> & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>

removeAllListeners()

removeAllListeners() => Promise<void>

Interfaces

ScanRegion

measuredByPercentage: 0 in pixel, 1 in percent

DCEFrame

Uint8Array

A typed array of 8-bit unsigned integer values. The contents are initialized to 0. If the requested number of bytes could not be allocated an exception is raised.

ArrayLike

ArrayBufferTypes

Allowed <a href="#arraybuffer">ArrayBuffer</a> types for the buffer of an ArrayBufferView and related Typed Arrays.

ArrayBuffer

Represents a raw buffer of binary data, which is used to store data for the different typed arrays. ArrayBuffers cannot be read from or written to directly, but can be passed to a typed array or DataView Object to interpret the raw buffer as needed.

Region

PluginListenerHandle

Type Aliases

ArrayBufferLike

<code>ArrayBufferTypes[keyof ArrayBufferTypes]</code>

onPlayedListener

<code>(result: { resolution: string; }): void</code>