Capacitor-community-multilens-camerapreview NPM

capacitor-community-multilens-camerapreview

fork of capacitor community camera preview with support for switchting lenses

Install

npm install capacitor-community-multilens-camerapreview
npx cap sync

API

start(...)

start(options: CameraPreviewOptions) => Promise<{}>

Param	Type
`options`	CameraPreviewOptions

Returns: Promise<{}>

stop()

stop() => Promise<{}>

Returns: Promise<{}>

capture(...)

capture(options: CameraPreviewPictureOptions) => Promise<{ value: string; }>

Param	Type
`options`	CameraPreviewPictureOptions

Returns: Promise<{ value: string; }>

captureSample(...)

captureSample(options: CameraSampleOptions) => Promise<{ value: string; }>

Param	Type
`options`	CameraSampleOptions

Returns: Promise<{ value: string; }>

getSupportedFlashModes()

getSupportedFlashModes() => Promise<{ result: CameraPreviewFlashMode[]; }>

Returns: Promise<{ result: CameraPreviewFlashMode[]; }>

setFlashMode(...)

setFlashMode(options: { flashMode: CameraPreviewFlashMode | string; }) => Promise<void>

Param	Type
`options`	{ flashMode: string; }

flip()

flip() => Promise<void>

setOpacity(...)

setOpacity(options: CameraOpacityOptions) => Promise<{}>

Param	Type
`options`	CameraOpacityOptions

Returns: Promise<{}>

setZoom(...)

setZoom(options: CameraPreviewOptions) => Promise<void>

Param	Type
`options`	CameraPreviewOptions

getSupportedZoomLevels()

getSupportedZoomLevels() => Promise<{ result: any[]; }>

Returns: Promise<{ result: any[]; }>

Interfaces

CameraPreviewOptions

Prop	Type	Description
`parent`	string	Parent element to attach the video preview element to (applicable to the web platform only)
`className`	string	Class name to add to the video preview element (applicable to the web platform only)
`width`	number	The preview width in pixels, default window.screen.width
`height`	number	The preview height in pixels, default window.screen.height
`x`	number	The x origin, default 0 (applicable to the android and ios platforms only)
`y`	number	The y origin, default 0 (applicable to the android and ios platforms only)
`toBack`	boolean	Brings your html in front of your preview, default false (applicable to the android only)
`paddingBottom`	number	The preview bottom padding in pixes. Useful to keep the appropriate preview sizes when orientation changes (applicable to the android and ios platforms only)
`rotateWhenOrientationChanged`	boolean	Rotate preview when orientation changes (applicable to the ios platforms only; default value is true)
`position`	string	Choose the camera to use 'front' or 'rear', default 'front'
`storeToFile`	boolean	Defaults to false - Capture images to a file and return the file path instead of returning base64 encoded data
`disableExifHeaderStripping`	boolean	Defaults to false - Android Only - Disable automatic rotation of the image, and let the browser deal with it (keep reading on how to achieve it)
`enableHighResolution`	boolean	Defaults to false - iOS only - Activate high resolution image capture so that output images are from the highest resolution possible on the device *
`disableAudio`	boolean	Defaults to false - Web only - Disables audio stream to prevent permission requests and output switching
`lockAndroidOrientation`	boolean	Android Only - Locks device orientation when camera is showing.
`enableOpacity`	boolean	Defaults to false - Android and Web only. Set if camera preview can change opacity.
`enableZoom`	boolean	Defaults to false - Android only. Set if camera preview will support pinch to zoom.
`zoomFactor`	any	override defualt lens choice ios String 'ultra','wide','tele' android int example 100, 200 etc

CameraPreviewPictureOptions

Prop	Type	Description
`height`	number	The picture height, optional, default 0 (Device default)
`width`	number	The picture width, optional, default 0 (Device default)
`quality`	number	The picture quality, 0 - 100, default 85 on `iOS/Android`. If left undefined, the `web` implementation will export a PNG, otherwise a JPEG will be generated