@capgo/camera-preview 3.2.5 → 3.2.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p>
|
|
2
2
|
<h3 align="center">Capacitor Camera Preview</h3>
|
|
3
|
-
<p align="center"><strong><code>@
|
|
3
|
+
<p align="center"><strong><code>@capgo/camera-preview</code></strong></p>
|
|
4
4
|
<br>
|
|
5
5
|
<p align="center"><strong>CAPACITOR 3</strong></p><br>
|
|
6
6
|
|
|
@@ -33,11 +33,11 @@ Version 2+ of this plugin is compatible with Ionic 5+ and Capacitor 3. If your p
|
|
|
33
33
|
# Installation
|
|
34
34
|
|
|
35
35
|
```
|
|
36
|
-
yarn add @
|
|
36
|
+
yarn add @capgo/camera-preview
|
|
37
37
|
|
|
38
38
|
or
|
|
39
39
|
|
|
40
|
-
npm install @
|
|
40
|
+
npm install @capgo/camera-preview
|
|
41
41
|
```
|
|
42
42
|
Then run
|
|
43
43
|
```
|
|
@@ -57,7 +57,7 @@ For more help consult the [Capacitor docs](https://capacitorjs.com/docs/android/
|
|
|
57
57
|
You will need to add two permissions to `Info.plist`. Follow the [Capacitor docs](https://capacitorjs.com/docs/ios/configuration#configuring-infoplist) and add permissions with the raw keys `NSCameraUsageDescription` and `NSMicrophoneUsageDescription`. `NSMicrophoneUsageDescription` is only required, if audio will be used. Otherwise set the `disableAudio` option to `true`, which also disables the microphone permission request.
|
|
58
58
|
|
|
59
59
|
## Extra Web installation steps
|
|
60
|
-
Add `import '@
|
|
60
|
+
Add `import '@capgo/camera-preview'` to you entry script in ionic on `app.module.ts`, so capacitor can register the web platform from the plugin
|
|
61
61
|
|
|
62
62
|
|
|
63
63
|
# Methods
|
|
@@ -101,7 +101,7 @@ All options stated are optional and will default to values here
|
|
|
101
101
|
* `disableExifHeaderStripping` - 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) -->
|
|
102
102
|
|
|
103
103
|
```javascript
|
|
104
|
-
import { CameraPreview, CameraPreviewOptions } from '@
|
|
104
|
+
import { CameraPreview, CameraPreviewOptions } from '@capgo/camera-preview';
|
|
105
105
|
|
|
106
106
|
const cameraPreviewOptions: CameraPreviewOptions = {
|
|
107
107
|
position: 'rear',
|
|
@@ -193,7 +193,7 @@ CameraPreview.hide();
|
|
|
193
193
|
<!-- <info>Take the picture. If width and height are not specified or are 0 it will use the defaults. If width and height are specified, it will choose a supported photo size that is closest to width and height specified and has closest aspect ratio to the preview. The argument `quality` defaults to `85` and specifies the quality/compression value: `0=max compression`, `100=max quality`.</info><br/> -->
|
|
194
194
|
|
|
195
195
|
```javascript
|
|
196
|
-
import { CameraPreviewPictureOptions } from '@
|
|
196
|
+
import { CameraPreviewPictureOptions } from '@capgo/camera-preview';
|
|
197
197
|
|
|
198
198
|
const cameraPreviewPictureOptions: CameraPreviewPictureOptions = {
|
|
199
199
|
quality: 50
|
|
@@ -215,7 +215,7 @@ const base64PictureData = result.value;
|
|
|
215
215
|
<info>Captures a sample image from the video stream. Only for Android and iOS, web implementation falls back to `capture` method. This can be used to perform real-time analysis on the current frame in the video. The argument `quality` defaults to `85` and specifies the quality/compression value: `0=max compression`, `100=max quality`.</info><br/>
|
|
216
216
|
|
|
217
217
|
```javascript
|
|
218
|
-
import { CameraSampleOptions } from '@
|
|
218
|
+
import { CameraSampleOptions } from '@capgo/camera-preview';
|
|
219
219
|
|
|
220
220
|
const cameraSampleOptions: CameraSampleOptions = {
|
|
221
221
|
quality: 50
|
|
@@ -233,7 +233,7 @@ const base64PictureData = result.value;
|
|
|
233
233
|
<info>Get the flash modes supported by the camera device currently started. Returns an array containing supported flash modes. See <code>[FLASH_MODE](#camera_Settings.FlashMode)</code> for possible values that can be returned</info><br/>
|
|
234
234
|
|
|
235
235
|
```javascript
|
|
236
|
-
import { CameraPreviewFlashMode } from '@
|
|
236
|
+
import { CameraPreviewFlashMode } from '@capgo/camera-preview';
|
|
237
237
|
|
|
238
238
|
const flashModes = await CameraPreview.getSupportedFlashModes();
|
|
239
239
|
const supportedFlashModes: CameraPreviewFlashMode[] = flashModes.result;
|