@capgo/camera-preview 7.3.9 → 7.4.0-beta.2
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/CapgoCameraPreview.podspec +16 -13
- package/README.md +306 -70
- package/android/.gradle/8.14.2/checksums/checksums.lock +0 -0
- package/android/.gradle/8.14.2/checksums/sha1-checksums.bin +0 -0
- package/android/.gradle/8.14.2/executionHistory/executionHistory.bin +0 -0
- package/android/.gradle/8.14.2/executionHistory/executionHistory.lock +0 -0
- package/android/.gradle/8.14.2/fileChanges/last-build.bin +0 -0
- package/android/.gradle/8.14.2/fileHashes/fileHashes.bin +0 -0
- package/android/.gradle/8.14.2/fileHashes/fileHashes.lock +0 -0
- package/android/.gradle/8.14.2/fileHashes/resourceHashesCache.bin +0 -0
- package/android/.gradle/8.14.2/gc.properties +0 -0
- package/android/.gradle/buildOutputCleanup/buildOutputCleanup.lock +0 -0
- package/android/.gradle/buildOutputCleanup/cache.properties +2 -0
- package/android/.gradle/buildOutputCleanup/outputFiles.bin +0 -0
- package/android/.gradle/file-system.probe +0 -0
- package/android/.gradle/vcs-1/gc.properties +0 -0
- package/android/build.gradle +9 -0
- package/android/src/main/AndroidManifest.xml +5 -0
- package/android/src/main/java/com/ahm/capacitor/camera/preview/CameraPreview.java +260 -551
- package/android/src/main/java/com/ahm/capacitor/camera/preview/CameraXView.java +968 -0
- package/android/src/main/java/com/ahm/capacitor/camera/preview/model/CameraDevice.java +54 -0
- package/android/src/main/java/com/ahm/capacitor/camera/preview/model/CameraLens.java +70 -0
- package/android/src/main/java/com/ahm/capacitor/camera/preview/model/CameraSessionConfiguration.java +65 -0
- package/android/src/main/java/com/ahm/capacitor/camera/preview/model/LensInfo.java +34 -0
- package/android/src/main/java/com/ahm/capacitor/camera/preview/model/ZoomFactors.java +34 -0
- package/dist/docs.json +729 -153
- package/dist/esm/definitions.d.ts +337 -80
- package/dist/esm/definitions.js +10 -1
- package/dist/esm/definitions.js.map +1 -1
- package/dist/esm/web.d.ts +27 -1
- package/dist/esm/web.js +248 -4
- package/dist/esm/web.js.map +1 -1
- package/dist/plugin.cjs.js +256 -4
- package/dist/plugin.cjs.js.map +1 -1
- package/dist/plugin.js +256 -4
- package/dist/plugin.js.map +1 -1
- package/ios/{Plugin → Sources/CapgoCameraPreview}/CameraController.swift +359 -34
- package/ios/{Plugin → Sources/CapgoCameraPreview}/Plugin.swift +348 -42
- package/ios/Tests/CameraPreviewPluginTests/CameraPreviewPluginTests.swift +15 -0
- package/package.json +1 -1
- package/android/src/main/java/com/ahm/capacitor/camera/preview/CameraActivity.java +0 -1279
- package/android/src/main/java/com/ahm/capacitor/camera/preview/CustomSurfaceView.java +0 -29
- package/android/src/main/java/com/ahm/capacitor/camera/preview/CustomTextureView.java +0 -39
- package/android/src/main/java/com/ahm/capacitor/camera/preview/Preview.java +0 -461
- package/android/src/main/java/com/ahm/capacitor/camera/preview/TapGestureDetector.java +0 -24
- package/ios/Plugin/Info.plist +0 -24
- package/ios/Plugin/Plugin.h +0 -10
- package/ios/Plugin/Plugin.m +0 -18
- package/ios/Plugin.xcodeproj/project.pbxproj +0 -593
- package/ios/Plugin.xcodeproj/project.xcworkspace/contents.xcworkspacedata +0 -7
- package/ios/Plugin.xcworkspace/contents.xcworkspacedata +0 -10
- package/ios/Plugin.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist +0 -8
- package/ios/PluginTests/Info.plist +0 -22
- package/ios/PluginTests/PluginTests.swift +0 -83
- package/ios/Podfile +0 -13
- package/ios/Podfile.lock +0 -23
package/dist/docs.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"api": {
|
|
3
3
|
"name": "CameraPreviewPlugin",
|
|
4
4
|
"slug": "camerapreviewplugin",
|
|
5
|
-
"docs": "",
|
|
5
|
+
"docs": "The main interface for the CameraPreview plugin.",
|
|
6
6
|
"tags": [],
|
|
7
7
|
"methods": [
|
|
8
8
|
{
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"parameters": [
|
|
12
12
|
{
|
|
13
13
|
"name": "options",
|
|
14
|
-
"docs": "
|
|
14
|
+
"docs": "- The configuration for the camera preview.",
|
|
15
15
|
"type": "CameraPreviewOptions"
|
|
16
16
|
}
|
|
17
17
|
],
|
|
@@ -19,22 +19,18 @@
|
|
|
19
19
|
"tags": [
|
|
20
20
|
{
|
|
21
21
|
"name": "param",
|
|
22
|
-
"text": "options
|
|
22
|
+
"text": "options - The configuration for the camera preview."
|
|
23
23
|
},
|
|
24
24
|
{
|
|
25
25
|
"name": "returns",
|
|
26
|
-
"text": "
|
|
27
|
-
},
|
|
28
|
-
{
|
|
29
|
-
"name": "throws",
|
|
30
|
-
"text": "An error if the something went wrong"
|
|
26
|
+
"text": "A promise that resolves when the camera preview is started."
|
|
31
27
|
},
|
|
32
28
|
{
|
|
33
29
|
"name": "since",
|
|
34
30
|
"text": "0.0.1"
|
|
35
31
|
}
|
|
36
32
|
],
|
|
37
|
-
"docs": "
|
|
33
|
+
"docs": "Starts the camera preview.",
|
|
38
34
|
"complexTypes": [
|
|
39
35
|
"CameraPreviewOptions"
|
|
40
36
|
],
|
|
@@ -48,52 +44,45 @@
|
|
|
48
44
|
"tags": [
|
|
49
45
|
{
|
|
50
46
|
"name": "returns",
|
|
51
|
-
"text": "
|
|
52
|
-
},
|
|
53
|
-
{
|
|
54
|
-
"name": "throws",
|
|
55
|
-
"text": "An error if the something went wrong"
|
|
47
|
+
"text": "A promise that resolves when the camera preview is stopped."
|
|
56
48
|
},
|
|
57
49
|
{
|
|
58
50
|
"name": "since",
|
|
59
51
|
"text": "0.0.1"
|
|
60
52
|
}
|
|
61
53
|
],
|
|
62
|
-
"docs": "
|
|
54
|
+
"docs": "Stops the camera preview.",
|
|
63
55
|
"complexTypes": [],
|
|
64
56
|
"slug": "stop"
|
|
65
57
|
},
|
|
66
58
|
{
|
|
67
59
|
"name": "capture",
|
|
68
|
-
"signature": "(options: CameraPreviewPictureOptions) => Promise<{ value: string; }>",
|
|
60
|
+
"signature": "(options: CameraPreviewPictureOptions) => Promise<{ value: string; exif: ExifData; }>",
|
|
69
61
|
"parameters": [
|
|
70
62
|
{
|
|
71
63
|
"name": "options",
|
|
72
|
-
"docs": "
|
|
64
|
+
"docs": "- The options for capturing the picture.",
|
|
73
65
|
"type": "CameraPreviewPictureOptions"
|
|
74
66
|
}
|
|
75
67
|
],
|
|
76
|
-
"returns": "Promise<{ value: string; }>",
|
|
68
|
+
"returns": "Promise<{ value: string; exif: ExifData; }>",
|
|
77
69
|
"tags": [
|
|
78
70
|
{
|
|
79
71
|
"name": "param",
|
|
80
|
-
"text": "options
|
|
72
|
+
"text": "options - The options for capturing the picture."
|
|
81
73
|
},
|
|
82
74
|
{
|
|
83
75
|
"name": "returns",
|
|
84
|
-
"text": "
|
|
85
|
-
},
|
|
86
|
-
{
|
|
87
|
-
"name": "throws",
|
|
88
|
-
"text": "An error if the something went wrong"
|
|
76
|
+
"text": "A promise that resolves with the captured image data.\nThe `value` is a base64 encoded string unless `storeToFile` is true, in which case it's a file path."
|
|
89
77
|
},
|
|
90
78
|
{
|
|
91
79
|
"name": "since",
|
|
92
80
|
"text": "0.0.1"
|
|
93
81
|
}
|
|
94
82
|
],
|
|
95
|
-
"docs": "
|
|
83
|
+
"docs": "Captures a picture from the camera.",
|
|
96
84
|
"complexTypes": [
|
|
85
|
+
"ExifData",
|
|
97
86
|
"CameraPreviewPictureOptions"
|
|
98
87
|
],
|
|
99
88
|
"slug": "capture"
|
|
@@ -104,7 +93,7 @@
|
|
|
104
93
|
"parameters": [
|
|
105
94
|
{
|
|
106
95
|
"name": "options",
|
|
107
|
-
"docs": "
|
|
96
|
+
"docs": "- The options for capturing the sample.",
|
|
108
97
|
"type": "CameraSampleOptions"
|
|
109
98
|
}
|
|
110
99
|
],
|
|
@@ -112,22 +101,18 @@
|
|
|
112
101
|
"tags": [
|
|
113
102
|
{
|
|
114
103
|
"name": "param",
|
|
115
|
-
"text": "options
|
|
104
|
+
"text": "options - The options for capturing the sample."
|
|
116
105
|
},
|
|
117
106
|
{
|
|
118
107
|
"name": "returns",
|
|
119
|
-
"text": "
|
|
120
|
-
},
|
|
121
|
-
{
|
|
122
|
-
"name": "throws",
|
|
123
|
-
"text": "An error if the something went wrong"
|
|
108
|
+
"text": "A promise that resolves with the sample image as a base64 encoded string."
|
|
124
109
|
},
|
|
125
110
|
{
|
|
126
111
|
"name": "since",
|
|
127
112
|
"text": "0.0.1"
|
|
128
113
|
}
|
|
129
114
|
],
|
|
130
|
-
"docs": "
|
|
115
|
+
"docs": "Captures a single frame from the camera preview stream.",
|
|
131
116
|
"complexTypes": [
|
|
132
117
|
"CameraSampleOptions"
|
|
133
118
|
],
|
|
@@ -141,18 +126,14 @@
|
|
|
141
126
|
"tags": [
|
|
142
127
|
{
|
|
143
128
|
"name": "returns",
|
|
144
|
-
"text": "
|
|
145
|
-
},
|
|
146
|
-
{
|
|
147
|
-
"name": "throws",
|
|
148
|
-
"text": "An error if the something went wrong"
|
|
129
|
+
"text": "A promise that resolves with an array of supported flash modes."
|
|
149
130
|
},
|
|
150
131
|
{
|
|
151
132
|
"name": "since",
|
|
152
133
|
"text": "0.0.1"
|
|
153
134
|
}
|
|
154
135
|
],
|
|
155
|
-
"docs": "
|
|
136
|
+
"docs": "Gets the flash modes supported by the active camera.",
|
|
156
137
|
"complexTypes": [
|
|
157
138
|
"CameraPreviewFlashMode"
|
|
158
139
|
],
|
|
@@ -160,44 +141,42 @@
|
|
|
160
141
|
},
|
|
161
142
|
{
|
|
162
143
|
"name": "getHorizontalFov",
|
|
163
|
-
"signature": "() => Promise<{ result:
|
|
144
|
+
"signature": "() => Promise<{ result: number; }>",
|
|
164
145
|
"parameters": [],
|
|
165
|
-
"returns": "Promise<{ result:
|
|
146
|
+
"returns": "Promise<{ result: number; }>",
|
|
166
147
|
"tags": [
|
|
167
148
|
{
|
|
168
149
|
"name": "returns",
|
|
169
|
-
"text": "
|
|
170
|
-
},
|
|
171
|
-
{
|
|
172
|
-
"name": "throws",
|
|
173
|
-
"text": "An error if the something went wrong"
|
|
150
|
+
"text": "A promise that resolves with the horizontal field of view in degrees."
|
|
174
151
|
},
|
|
175
152
|
{
|
|
176
153
|
"name": "since",
|
|
177
154
|
"text": "0.0.1"
|
|
178
155
|
}
|
|
179
156
|
],
|
|
180
|
-
"docs": "
|
|
157
|
+
"docs": "Gets the horizontal field of view (FoV) for the active camera.\nNote: This can be an estimate on some devices.",
|
|
181
158
|
"complexTypes": [],
|
|
182
159
|
"slug": "gethorizontalfov"
|
|
183
160
|
},
|
|
184
161
|
{
|
|
185
162
|
"name": "getSupportedPictureSizes",
|
|
186
|
-
"signature": "() => Promise<{ supportedPictureSizes:
|
|
163
|
+
"signature": "() => Promise<{ supportedPictureSizes: SupportedPictureSizes[]; }>",
|
|
187
164
|
"parameters": [],
|
|
188
|
-
"returns": "Promise<{ supportedPictureSizes:
|
|
165
|
+
"returns": "Promise<{ supportedPictureSizes: SupportedPictureSizes[]; }>",
|
|
189
166
|
"tags": [
|
|
190
167
|
{
|
|
191
168
|
"name": "returns",
|
|
192
|
-
"text": "
|
|
169
|
+
"text": "A promise that resolves with the list of supported sizes."
|
|
193
170
|
},
|
|
194
171
|
{
|
|
195
|
-
"name": "
|
|
196
|
-
"text": "
|
|
172
|
+
"name": "since",
|
|
173
|
+
"text": "7.4.0"
|
|
197
174
|
}
|
|
198
175
|
],
|
|
199
|
-
"docs": "Gets the supported picture sizes for
|
|
200
|
-
"complexTypes": [
|
|
176
|
+
"docs": "Gets the supported picture sizes for all cameras.",
|
|
177
|
+
"complexTypes": [
|
|
178
|
+
"SupportedPictureSizes"
|
|
179
|
+
],
|
|
201
180
|
"slug": "getsupportedpicturesizes"
|
|
202
181
|
},
|
|
203
182
|
{
|
|
@@ -206,7 +185,7 @@
|
|
|
206
185
|
"parameters": [
|
|
207
186
|
{
|
|
208
187
|
"name": "options",
|
|
209
|
-
"docs": "
|
|
188
|
+
"docs": "- The desired flash mode.",
|
|
210
189
|
"type": "{ flashMode: string; }"
|
|
211
190
|
}
|
|
212
191
|
],
|
|
@@ -214,22 +193,18 @@
|
|
|
214
193
|
"tags": [
|
|
215
194
|
{
|
|
216
195
|
"name": "param",
|
|
217
|
-
"text": "options
|
|
196
|
+
"text": "options - The desired flash mode."
|
|
218
197
|
},
|
|
219
198
|
{
|
|
220
199
|
"name": "returns",
|
|
221
|
-
"text": "
|
|
222
|
-
},
|
|
223
|
-
{
|
|
224
|
-
"name": "throws",
|
|
225
|
-
"text": "An error if the something went wrong"
|
|
200
|
+
"text": "A promise that resolves when the flash mode is set."
|
|
226
201
|
},
|
|
227
202
|
{
|
|
228
203
|
"name": "since",
|
|
229
204
|
"text": "0.0.1"
|
|
230
205
|
}
|
|
231
206
|
],
|
|
232
|
-
"docs": "
|
|
207
|
+
"docs": "Sets the flash mode for the active camera.",
|
|
233
208
|
"complexTypes": [
|
|
234
209
|
"CameraPreviewFlashMode"
|
|
235
210
|
],
|
|
@@ -243,18 +218,14 @@
|
|
|
243
218
|
"tags": [
|
|
244
219
|
{
|
|
245
220
|
"name": "returns",
|
|
246
|
-
"text": "
|
|
247
|
-
},
|
|
248
|
-
{
|
|
249
|
-
"name": "throws",
|
|
250
|
-
"text": "An error if the something went wrong"
|
|
221
|
+
"text": "A promise that resolves when the camera is flipped."
|
|
251
222
|
},
|
|
252
223
|
{
|
|
253
224
|
"name": "since",
|
|
254
225
|
"text": "0.0.1"
|
|
255
226
|
}
|
|
256
227
|
],
|
|
257
|
-
"docs": "
|
|
228
|
+
"docs": "Toggles between the front and rear cameras.",
|
|
258
229
|
"complexTypes": [],
|
|
259
230
|
"slug": "flip"
|
|
260
231
|
},
|
|
@@ -264,7 +235,7 @@
|
|
|
264
235
|
"parameters": [
|
|
265
236
|
{
|
|
266
237
|
"name": "options",
|
|
267
|
-
"docs": "
|
|
238
|
+
"docs": "- The opacity options.",
|
|
268
239
|
"type": "CameraOpacityOptions"
|
|
269
240
|
}
|
|
270
241
|
],
|
|
@@ -272,22 +243,18 @@
|
|
|
272
243
|
"tags": [
|
|
273
244
|
{
|
|
274
245
|
"name": "param",
|
|
275
|
-
"text": "options
|
|
246
|
+
"text": "options - The opacity options."
|
|
276
247
|
},
|
|
277
248
|
{
|
|
278
249
|
"name": "returns",
|
|
279
|
-
"text": "
|
|
280
|
-
},
|
|
281
|
-
{
|
|
282
|
-
"name": "throws",
|
|
283
|
-
"text": "An error if the something went wrong"
|
|
250
|
+
"text": "A promise that resolves when the opacity is set."
|
|
284
251
|
},
|
|
285
252
|
{
|
|
286
253
|
"name": "since",
|
|
287
254
|
"text": "0.0.1"
|
|
288
255
|
}
|
|
289
256
|
],
|
|
290
|
-
"docs": "
|
|
257
|
+
"docs": "Sets the opacity of the camera preview.",
|
|
291
258
|
"complexTypes": [
|
|
292
259
|
"CameraOpacityOptions"
|
|
293
260
|
],
|
|
@@ -299,24 +266,16 @@
|
|
|
299
266
|
"parameters": [],
|
|
300
267
|
"returns": "Promise<{ videoFilePath: string; }>",
|
|
301
268
|
"tags": [
|
|
302
|
-
{
|
|
303
|
-
"name": "param",
|
|
304
|
-
"text": "options the options to stop recording video with"
|
|
305
|
-
},
|
|
306
269
|
{
|
|
307
270
|
"name": "returns",
|
|
308
|
-
"text": "
|
|
309
|
-
},
|
|
310
|
-
{
|
|
311
|
-
"name": "throws",
|
|
312
|
-
"text": "An error if the something went wrong"
|
|
271
|
+
"text": "A promise that resolves with the path to the recorded video file."
|
|
313
272
|
},
|
|
314
273
|
{
|
|
315
274
|
"name": "since",
|
|
316
275
|
"text": "0.0.1"
|
|
317
276
|
}
|
|
318
277
|
],
|
|
319
|
-
"docs": "
|
|
278
|
+
"docs": "Stops an ongoing video recording.",
|
|
320
279
|
"complexTypes": [],
|
|
321
280
|
"slug": "stoprecordvideo"
|
|
322
281
|
},
|
|
@@ -326,7 +285,7 @@
|
|
|
326
285
|
"parameters": [
|
|
327
286
|
{
|
|
328
287
|
"name": "options",
|
|
329
|
-
"docs": "
|
|
288
|
+
"docs": "- The options for video recording.",
|
|
330
289
|
"type": "CameraPreviewOptions"
|
|
331
290
|
}
|
|
332
291
|
],
|
|
@@ -334,26 +293,196 @@
|
|
|
334
293
|
"tags": [
|
|
335
294
|
{
|
|
336
295
|
"name": "param",
|
|
337
|
-
"text": "options
|
|
296
|
+
"text": "options - The options for video recording."
|
|
338
297
|
},
|
|
339
298
|
{
|
|
340
299
|
"name": "returns",
|
|
341
|
-
"text": "
|
|
342
|
-
},
|
|
343
|
-
{
|
|
344
|
-
"name": "throws",
|
|
345
|
-
"text": "An error if the something went wrong"
|
|
300
|
+
"text": "A promise that resolves when video recording starts."
|
|
346
301
|
},
|
|
347
302
|
{
|
|
348
303
|
"name": "since",
|
|
349
304
|
"text": "0.0.1"
|
|
350
305
|
}
|
|
351
306
|
],
|
|
352
|
-
"docs": "
|
|
307
|
+
"docs": "Starts recording a video.",
|
|
353
308
|
"complexTypes": [
|
|
354
309
|
"CameraPreviewOptions"
|
|
355
310
|
],
|
|
356
311
|
"slug": "startrecordvideo"
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
"name": "isRunning",
|
|
315
|
+
"signature": "() => Promise<{ isRunning: boolean; }>",
|
|
316
|
+
"parameters": [],
|
|
317
|
+
"returns": "Promise<{ isRunning: boolean; }>",
|
|
318
|
+
"tags": [
|
|
319
|
+
{
|
|
320
|
+
"name": "returns",
|
|
321
|
+
"text": "A promise that resolves with the running state."
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
"name": "since",
|
|
325
|
+
"text": "7.4.0"
|
|
326
|
+
}
|
|
327
|
+
],
|
|
328
|
+
"docs": "Checks if the camera preview is currently running.",
|
|
329
|
+
"complexTypes": [],
|
|
330
|
+
"slug": "isrunning"
|
|
331
|
+
},
|
|
332
|
+
{
|
|
333
|
+
"name": "getAvailableDevices",
|
|
334
|
+
"signature": "() => Promise<{ devices: CameraDevice[]; }>",
|
|
335
|
+
"parameters": [],
|
|
336
|
+
"returns": "Promise<{ devices: CameraDevice[]; }>",
|
|
337
|
+
"tags": [
|
|
338
|
+
{
|
|
339
|
+
"name": "returns",
|
|
340
|
+
"text": "A promise that resolves with the list of available camera devices."
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
"name": "since",
|
|
344
|
+
"text": "7.4.0"
|
|
345
|
+
}
|
|
346
|
+
],
|
|
347
|
+
"docs": "Gets all available camera devices.",
|
|
348
|
+
"complexTypes": [
|
|
349
|
+
"CameraDevice"
|
|
350
|
+
],
|
|
351
|
+
"slug": "getavailabledevices"
|
|
352
|
+
},
|
|
353
|
+
{
|
|
354
|
+
"name": "getZoom",
|
|
355
|
+
"signature": "() => Promise<{ min: number; max: number; current: number; lens: LensInfo; }>",
|
|
356
|
+
"parameters": [],
|
|
357
|
+
"returns": "Promise<{ min: number; max: number; current: number; lens: LensInfo; }>",
|
|
358
|
+
"tags": [
|
|
359
|
+
{
|
|
360
|
+
"name": "returns",
|
|
361
|
+
"text": "A promise that resolves with the zoom state."
|
|
362
|
+
},
|
|
363
|
+
{
|
|
364
|
+
"name": "since",
|
|
365
|
+
"text": "7.4.0"
|
|
366
|
+
}
|
|
367
|
+
],
|
|
368
|
+
"docs": "Gets the current zoom state, including min/max and current lens info.",
|
|
369
|
+
"complexTypes": [
|
|
370
|
+
"LensInfo"
|
|
371
|
+
],
|
|
372
|
+
"slug": "getzoom"
|
|
373
|
+
},
|
|
374
|
+
{
|
|
375
|
+
"name": "setZoom",
|
|
376
|
+
"signature": "(options: { level: number; ramp?: boolean; }) => Promise<void>",
|
|
377
|
+
"parameters": [
|
|
378
|
+
{
|
|
379
|
+
"name": "options",
|
|
380
|
+
"docs": "- The desired zoom level. `ramp` is currently unused.",
|
|
381
|
+
"type": "{ level: number; ramp?: boolean | undefined; }"
|
|
382
|
+
}
|
|
383
|
+
],
|
|
384
|
+
"returns": "Promise<void>",
|
|
385
|
+
"tags": [
|
|
386
|
+
{
|
|
387
|
+
"name": "param",
|
|
388
|
+
"text": "options - The desired zoom level. `ramp` is currently unused."
|
|
389
|
+
},
|
|
390
|
+
{
|
|
391
|
+
"name": "returns",
|
|
392
|
+
"text": "A promise that resolves when the zoom level is set."
|
|
393
|
+
},
|
|
394
|
+
{
|
|
395
|
+
"name": "since",
|
|
396
|
+
"text": "7.4.0"
|
|
397
|
+
}
|
|
398
|
+
],
|
|
399
|
+
"docs": "Sets the camera's zoom level.",
|
|
400
|
+
"complexTypes": [],
|
|
401
|
+
"slug": "setzoom"
|
|
402
|
+
},
|
|
403
|
+
{
|
|
404
|
+
"name": "getFlashMode",
|
|
405
|
+
"signature": "() => Promise<{ flashMode: FlashMode; }>",
|
|
406
|
+
"parameters": [],
|
|
407
|
+
"returns": "Promise<{ flashMode: CameraPreviewFlashMode; }>",
|
|
408
|
+
"tags": [
|
|
409
|
+
{
|
|
410
|
+
"name": "returns",
|
|
411
|
+
"text": "A promise that resolves with the current flash mode."
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
"name": "since",
|
|
415
|
+
"text": "7.4.0"
|
|
416
|
+
}
|
|
417
|
+
],
|
|
418
|
+
"docs": "Gets the current flash mode.",
|
|
419
|
+
"complexTypes": [
|
|
420
|
+
"FlashMode"
|
|
421
|
+
],
|
|
422
|
+
"slug": "getflashmode"
|
|
423
|
+
},
|
|
424
|
+
{
|
|
425
|
+
"name": "removeAllListeners",
|
|
426
|
+
"signature": "() => Promise<void>",
|
|
427
|
+
"parameters": [],
|
|
428
|
+
"returns": "Promise<void>",
|
|
429
|
+
"tags": [
|
|
430
|
+
{
|
|
431
|
+
"name": "since",
|
|
432
|
+
"text": "7.4.0"
|
|
433
|
+
}
|
|
434
|
+
],
|
|
435
|
+
"docs": "Removes all registered listeners.",
|
|
436
|
+
"complexTypes": [],
|
|
437
|
+
"slug": "removealllisteners"
|
|
438
|
+
},
|
|
439
|
+
{
|
|
440
|
+
"name": "setDeviceId",
|
|
441
|
+
"signature": "(options: { deviceId: string; }) => Promise<void>",
|
|
442
|
+
"parameters": [
|
|
443
|
+
{
|
|
444
|
+
"name": "options",
|
|
445
|
+
"docs": "- The ID of the device to switch to.",
|
|
446
|
+
"type": "{ deviceId: string; }"
|
|
447
|
+
}
|
|
448
|
+
],
|
|
449
|
+
"returns": "Promise<void>",
|
|
450
|
+
"tags": [
|
|
451
|
+
{
|
|
452
|
+
"name": "param",
|
|
453
|
+
"text": "options - The ID of the device to switch to."
|
|
454
|
+
},
|
|
455
|
+
{
|
|
456
|
+
"name": "returns",
|
|
457
|
+
"text": "A promise that resolves when the camera is switched."
|
|
458
|
+
},
|
|
459
|
+
{
|
|
460
|
+
"name": "since",
|
|
461
|
+
"text": "7.4.0"
|
|
462
|
+
}
|
|
463
|
+
],
|
|
464
|
+
"docs": "Switches the active camera to the one with the specified `deviceId`.",
|
|
465
|
+
"complexTypes": [],
|
|
466
|
+
"slug": "setdeviceid"
|
|
467
|
+
},
|
|
468
|
+
{
|
|
469
|
+
"name": "getDeviceId",
|
|
470
|
+
"signature": "() => Promise<{ deviceId: string; }>",
|
|
471
|
+
"parameters": [],
|
|
472
|
+
"returns": "Promise<{ deviceId: string; }>",
|
|
473
|
+
"tags": [
|
|
474
|
+
{
|
|
475
|
+
"name": "returns",
|
|
476
|
+
"text": "A promise that resolves with the current device ID."
|
|
477
|
+
},
|
|
478
|
+
{
|
|
479
|
+
"name": "since",
|
|
480
|
+
"text": "7.4.0"
|
|
481
|
+
}
|
|
482
|
+
],
|
|
483
|
+
"docs": "Gets the ID of the currently active camera device.",
|
|
484
|
+
"complexTypes": [],
|
|
485
|
+
"slug": "getdeviceid"
|
|
357
486
|
}
|
|
358
487
|
],
|
|
359
488
|
"properties": []
|
|
@@ -362,84 +491,151 @@
|
|
|
362
491
|
{
|
|
363
492
|
"name": "CameraPreviewOptions",
|
|
364
493
|
"slug": "camerapreviewoptions",
|
|
365
|
-
"docs": "",
|
|
494
|
+
"docs": "Defines the configuration options for starting the camera preview.",
|
|
366
495
|
"tags": [],
|
|
367
496
|
"methods": [],
|
|
368
497
|
"properties": [
|
|
369
498
|
{
|
|
370
499
|
"name": "parent",
|
|
371
|
-
"tags": [
|
|
372
|
-
|
|
500
|
+
"tags": [
|
|
501
|
+
{
|
|
502
|
+
"text": "web",
|
|
503
|
+
"name": "platform"
|
|
504
|
+
}
|
|
505
|
+
],
|
|
506
|
+
"docs": "The parent element to attach the video preview to.",
|
|
373
507
|
"complexTypes": [],
|
|
374
508
|
"type": "string | undefined"
|
|
375
509
|
},
|
|
376
510
|
{
|
|
377
511
|
"name": "className",
|
|
378
|
-
"tags": [
|
|
379
|
-
|
|
512
|
+
"tags": [
|
|
513
|
+
{
|
|
514
|
+
"text": "web",
|
|
515
|
+
"name": "platform"
|
|
516
|
+
}
|
|
517
|
+
],
|
|
518
|
+
"docs": "A CSS class name to add to the preview element.",
|
|
380
519
|
"complexTypes": [],
|
|
381
520
|
"type": "string | undefined"
|
|
382
521
|
},
|
|
383
522
|
{
|
|
384
523
|
"name": "width",
|
|
385
|
-
"tags": [
|
|
386
|
-
|
|
524
|
+
"tags": [
|
|
525
|
+
{
|
|
526
|
+
"text": "android, ios, web",
|
|
527
|
+
"name": "platform"
|
|
528
|
+
}
|
|
529
|
+
],
|
|
530
|
+
"docs": "The width of the preview in pixels. Defaults to the screen width.",
|
|
387
531
|
"complexTypes": [],
|
|
388
532
|
"type": "number | undefined"
|
|
389
533
|
},
|
|
390
534
|
{
|
|
391
535
|
"name": "height",
|
|
392
|
-
"tags": [
|
|
393
|
-
|
|
536
|
+
"tags": [
|
|
537
|
+
{
|
|
538
|
+
"text": "android, ios, web",
|
|
539
|
+
"name": "platform"
|
|
540
|
+
}
|
|
541
|
+
],
|
|
542
|
+
"docs": "The height of the preview in pixels. Defaults to the screen height.",
|
|
394
543
|
"complexTypes": [],
|
|
395
544
|
"type": "number | undefined"
|
|
396
545
|
},
|
|
397
546
|
{
|
|
398
547
|
"name": "x",
|
|
399
|
-
"tags": [
|
|
400
|
-
|
|
548
|
+
"tags": [
|
|
549
|
+
{
|
|
550
|
+
"text": "android, ios",
|
|
551
|
+
"name": "platform"
|
|
552
|
+
}
|
|
553
|
+
],
|
|
554
|
+
"docs": "The horizontal origin of the preview, in pixels.",
|
|
401
555
|
"complexTypes": [],
|
|
402
556
|
"type": "number | undefined"
|
|
403
557
|
},
|
|
404
558
|
{
|
|
405
559
|
"name": "y",
|
|
406
|
-
"tags": [
|
|
407
|
-
|
|
560
|
+
"tags": [
|
|
561
|
+
{
|
|
562
|
+
"text": "android, ios",
|
|
563
|
+
"name": "platform"
|
|
564
|
+
}
|
|
565
|
+
],
|
|
566
|
+
"docs": "The vertical origin of the preview, in pixels.",
|
|
408
567
|
"complexTypes": [],
|
|
409
568
|
"type": "number | undefined"
|
|
410
569
|
},
|
|
411
570
|
{
|
|
412
571
|
"name": "includeSafeAreaInsets",
|
|
413
|
-
"tags": [
|
|
414
|
-
|
|
572
|
+
"tags": [
|
|
573
|
+
{
|
|
574
|
+
"text": "ios",
|
|
575
|
+
"name": "platform"
|
|
576
|
+
},
|
|
577
|
+
{
|
|
578
|
+
"text": "false",
|
|
579
|
+
"name": "default"
|
|
580
|
+
}
|
|
581
|
+
],
|
|
582
|
+
"docs": "Adjusts the y-position to account for safe areas (e.g., notches).",
|
|
415
583
|
"complexTypes": [],
|
|
416
584
|
"type": "boolean | undefined"
|
|
417
585
|
},
|
|
418
586
|
{
|
|
419
587
|
"name": "toBack",
|
|
420
|
-
"tags": [
|
|
421
|
-
|
|
588
|
+
"tags": [
|
|
589
|
+
{
|
|
590
|
+
"text": "android",
|
|
591
|
+
"name": "platform"
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
"text": "true",
|
|
595
|
+
"name": "default"
|
|
596
|
+
}
|
|
597
|
+
],
|
|
598
|
+
"docs": "If true, places the preview behind the webview.",
|
|
422
599
|
"complexTypes": [],
|
|
423
600
|
"type": "boolean | undefined"
|
|
424
601
|
},
|
|
425
602
|
{
|
|
426
603
|
"name": "paddingBottom",
|
|
427
|
-
"tags": [
|
|
428
|
-
|
|
604
|
+
"tags": [
|
|
605
|
+
{
|
|
606
|
+
"text": "android, ios",
|
|
607
|
+
"name": "platform"
|
|
608
|
+
}
|
|
609
|
+
],
|
|
610
|
+
"docs": "Bottom padding for the preview, in pixels.",
|
|
429
611
|
"complexTypes": [],
|
|
430
612
|
"type": "number | undefined"
|
|
431
613
|
},
|
|
432
614
|
{
|
|
433
615
|
"name": "rotateWhenOrientationChanged",
|
|
434
|
-
"tags": [
|
|
435
|
-
|
|
616
|
+
"tags": [
|
|
617
|
+
{
|
|
618
|
+
"text": "ios",
|
|
619
|
+
"name": "platform"
|
|
620
|
+
},
|
|
621
|
+
{
|
|
622
|
+
"text": "true",
|
|
623
|
+
"name": "default"
|
|
624
|
+
}
|
|
625
|
+
],
|
|
626
|
+
"docs": "Whether to rotate the preview when the device orientation changes.",
|
|
436
627
|
"complexTypes": [],
|
|
437
628
|
"type": "boolean | undefined"
|
|
438
629
|
},
|
|
439
630
|
{
|
|
440
631
|
"name": "position",
|
|
441
|
-
"tags": [
|
|
442
|
-
|
|
632
|
+
"tags": [
|
|
633
|
+
{
|
|
634
|
+
"text": "\"rear\"",
|
|
635
|
+
"name": "default"
|
|
636
|
+
}
|
|
637
|
+
],
|
|
638
|
+
"docs": "The camera to use.",
|
|
443
639
|
"complexTypes": [
|
|
444
640
|
"CameraPosition"
|
|
445
641
|
],
|
|
@@ -447,135 +643,506 @@
|
|
|
447
643
|
},
|
|
448
644
|
{
|
|
449
645
|
"name": "storeToFile",
|
|
450
|
-
"tags": [
|
|
451
|
-
|
|
646
|
+
"tags": [
|
|
647
|
+
{
|
|
648
|
+
"text": "false",
|
|
649
|
+
"name": "default"
|
|
650
|
+
}
|
|
651
|
+
],
|
|
652
|
+
"docs": "If true, saves the captured image to a file and returns the file path.\nIf false, returns a base64 encoded string.",
|
|
452
653
|
"complexTypes": [],
|
|
453
654
|
"type": "boolean | undefined"
|
|
454
655
|
},
|
|
455
656
|
{
|
|
456
657
|
"name": "disableExifHeaderStripping",
|
|
457
|
-
"tags": [
|
|
458
|
-
|
|
658
|
+
"tags": [
|
|
659
|
+
{
|
|
660
|
+
"text": "android",
|
|
661
|
+
"name": "platform"
|
|
662
|
+
},
|
|
663
|
+
{
|
|
664
|
+
"text": "false",
|
|
665
|
+
"name": "default"
|
|
666
|
+
}
|
|
667
|
+
],
|
|
668
|
+
"docs": "If true, prevents the plugin from rotating the image based on EXIF data.",
|
|
459
669
|
"complexTypes": [],
|
|
460
670
|
"type": "boolean | undefined"
|
|
461
671
|
},
|
|
462
672
|
{
|
|
463
673
|
"name": "enableHighResolution",
|
|
464
|
-
"tags": [
|
|
465
|
-
|
|
674
|
+
"tags": [
|
|
675
|
+
{
|
|
676
|
+
"text": "ios",
|
|
677
|
+
"name": "platform"
|
|
678
|
+
},
|
|
679
|
+
{
|
|
680
|
+
"text": "false",
|
|
681
|
+
"name": "default"
|
|
682
|
+
}
|
|
683
|
+
],
|
|
684
|
+
"docs": "If true, enables high-resolution image capture.",
|
|
466
685
|
"complexTypes": [],
|
|
467
686
|
"type": "boolean | undefined"
|
|
468
687
|
},
|
|
469
688
|
{
|
|
470
689
|
"name": "disableAudio",
|
|
471
|
-
"tags": [
|
|
472
|
-
|
|
690
|
+
"tags": [
|
|
691
|
+
{
|
|
692
|
+
"text": "false",
|
|
693
|
+
"name": "default"
|
|
694
|
+
}
|
|
695
|
+
],
|
|
696
|
+
"docs": "If true, disables the audio stream, preventing audio permission requests.",
|
|
473
697
|
"complexTypes": [],
|
|
474
698
|
"type": "boolean | undefined"
|
|
475
699
|
},
|
|
476
700
|
{
|
|
477
701
|
"name": "lockAndroidOrientation",
|
|
478
|
-
"tags": [
|
|
479
|
-
|
|
702
|
+
"tags": [
|
|
703
|
+
{
|
|
704
|
+
"text": "android",
|
|
705
|
+
"name": "platform"
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
"text": "false",
|
|
709
|
+
"name": "default"
|
|
710
|
+
}
|
|
711
|
+
],
|
|
712
|
+
"docs": "If true, locks the device orientation while the camera is active.",
|
|
480
713
|
"complexTypes": [],
|
|
481
714
|
"type": "boolean | undefined"
|
|
482
715
|
},
|
|
483
716
|
{
|
|
484
717
|
"name": "enableOpacity",
|
|
485
|
-
"tags": [
|
|
486
|
-
|
|
718
|
+
"tags": [
|
|
719
|
+
{
|
|
720
|
+
"text": "android, web",
|
|
721
|
+
"name": "platform"
|
|
722
|
+
},
|
|
723
|
+
{
|
|
724
|
+
"text": "false",
|
|
725
|
+
"name": "default"
|
|
726
|
+
}
|
|
727
|
+
],
|
|
728
|
+
"docs": "If true, allows the camera preview's opacity to be changed.",
|
|
487
729
|
"complexTypes": [],
|
|
488
730
|
"type": "boolean | undefined"
|
|
489
731
|
},
|
|
490
732
|
{
|
|
491
733
|
"name": "enableZoom",
|
|
492
|
-
"tags": [
|
|
493
|
-
|
|
734
|
+
"tags": [
|
|
735
|
+
{
|
|
736
|
+
"text": "android",
|
|
737
|
+
"name": "platform"
|
|
738
|
+
},
|
|
739
|
+
{
|
|
740
|
+
"text": "false",
|
|
741
|
+
"name": "default"
|
|
742
|
+
}
|
|
743
|
+
],
|
|
744
|
+
"docs": "If true, enables pinch-to-zoom functionality on the preview.",
|
|
494
745
|
"complexTypes": [],
|
|
495
746
|
"type": "boolean | undefined"
|
|
496
747
|
},
|
|
497
748
|
{
|
|
498
|
-
"name": "
|
|
499
|
-
"tags": [
|
|
500
|
-
|
|
749
|
+
"name": "enableVideoMode",
|
|
750
|
+
"tags": [
|
|
751
|
+
{
|
|
752
|
+
"text": "ios",
|
|
753
|
+
"name": "platform"
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
"text": "false",
|
|
757
|
+
"name": "default"
|
|
758
|
+
}
|
|
759
|
+
],
|
|
760
|
+
"docs": "If true, uses the video-optimized preset for the camera session.",
|
|
501
761
|
"complexTypes": [],
|
|
502
762
|
"type": "boolean | undefined"
|
|
763
|
+
},
|
|
764
|
+
{
|
|
765
|
+
"name": "deviceId",
|
|
766
|
+
"tags": [
|
|
767
|
+
{
|
|
768
|
+
"text": "ios",
|
|
769
|
+
"name": "platform"
|
|
770
|
+
}
|
|
771
|
+
],
|
|
772
|
+
"docs": "The `deviceId` of the camera to use. If provided, `position` is ignored.",
|
|
773
|
+
"complexTypes": [],
|
|
774
|
+
"type": "string | undefined"
|
|
503
775
|
}
|
|
504
776
|
]
|
|
505
777
|
},
|
|
778
|
+
{
|
|
779
|
+
"name": "ExifData",
|
|
780
|
+
"slug": "exifdata",
|
|
781
|
+
"docs": "Represents EXIF data extracted from an image.",
|
|
782
|
+
"tags": [],
|
|
783
|
+
"methods": [],
|
|
784
|
+
"properties": []
|
|
785
|
+
},
|
|
506
786
|
{
|
|
507
787
|
"name": "CameraPreviewPictureOptions",
|
|
508
788
|
"slug": "camerapreviewpictureoptions",
|
|
509
|
-
"docs": "",
|
|
789
|
+
"docs": "Defines the options for capturing a picture.",
|
|
510
790
|
"tags": [],
|
|
511
791
|
"methods": [],
|
|
512
792
|
"properties": [
|
|
513
793
|
{
|
|
514
794
|
"name": "height",
|
|
515
795
|
"tags": [],
|
|
516
|
-
"docs": "The
|
|
796
|
+
"docs": "The desired height of the picture in pixels. If not provided, the device default is used.",
|
|
517
797
|
"complexTypes": [],
|
|
518
798
|
"type": "number | undefined"
|
|
519
799
|
},
|
|
520
800
|
{
|
|
521
801
|
"name": "width",
|
|
522
802
|
"tags": [],
|
|
523
|
-
"docs": "The
|
|
803
|
+
"docs": "The desired width of the picture in pixels. If not provided, the device default is used.",
|
|
524
804
|
"complexTypes": [],
|
|
525
805
|
"type": "number | undefined"
|
|
526
806
|
},
|
|
527
807
|
{
|
|
528
808
|
"name": "quality",
|
|
529
|
-
"tags": [
|
|
530
|
-
|
|
809
|
+
"tags": [
|
|
810
|
+
{
|
|
811
|
+
"text": "85",
|
|
812
|
+
"name": "default"
|
|
813
|
+
}
|
|
814
|
+
],
|
|
815
|
+
"docs": "The quality of the captured image, from 0 to 100.\nDoes not apply to `png` format.",
|
|
531
816
|
"complexTypes": [],
|
|
532
817
|
"type": "number | undefined"
|
|
533
818
|
},
|
|
534
819
|
{
|
|
535
820
|
"name": "format",
|
|
536
|
-
"tags": [
|
|
537
|
-
|
|
821
|
+
"tags": [
|
|
822
|
+
{
|
|
823
|
+
"text": "\"jpeg\"",
|
|
824
|
+
"name": "default"
|
|
825
|
+
}
|
|
826
|
+
],
|
|
827
|
+
"docs": "The format of the captured image.",
|
|
538
828
|
"complexTypes": [
|
|
539
829
|
"PictureFormat"
|
|
540
830
|
],
|
|
541
831
|
"type": "PictureFormat"
|
|
832
|
+
},
|
|
833
|
+
{
|
|
834
|
+
"name": "saveToGallery",
|
|
835
|
+
"tags": [
|
|
836
|
+
{
|
|
837
|
+
"text": "false",
|
|
838
|
+
"name": "default"
|
|
839
|
+
},
|
|
840
|
+
{
|
|
841
|
+
"text": "7.5.0",
|
|
842
|
+
"name": "since"
|
|
843
|
+
}
|
|
844
|
+
],
|
|
845
|
+
"docs": "If true, the captured image will be saved to the user's gallery.",
|
|
846
|
+
"complexTypes": [],
|
|
847
|
+
"type": "boolean | undefined"
|
|
542
848
|
}
|
|
543
849
|
]
|
|
544
850
|
},
|
|
545
851
|
{
|
|
546
852
|
"name": "CameraSampleOptions",
|
|
547
853
|
"slug": "camerasampleoptions",
|
|
548
|
-
"docs": "",
|
|
854
|
+
"docs": "Defines the options for capturing a sample frame from the camera preview.",
|
|
549
855
|
"tags": [],
|
|
550
856
|
"methods": [],
|
|
551
857
|
"properties": [
|
|
552
858
|
{
|
|
553
859
|
"name": "quality",
|
|
554
|
-
"tags": [
|
|
555
|
-
|
|
860
|
+
"tags": [
|
|
861
|
+
{
|
|
862
|
+
"text": "85",
|
|
863
|
+
"name": "default"
|
|
864
|
+
}
|
|
865
|
+
],
|
|
866
|
+
"docs": "The quality of the captured sample, from 0 to 100.",
|
|
556
867
|
"complexTypes": [],
|
|
557
868
|
"type": "number | undefined"
|
|
558
869
|
}
|
|
559
870
|
]
|
|
560
871
|
},
|
|
872
|
+
{
|
|
873
|
+
"name": "SupportedPictureSizes",
|
|
874
|
+
"slug": "supportedpicturesizes",
|
|
875
|
+
"docs": "Represents the supported picture sizes for a camera facing a certain direction.",
|
|
876
|
+
"tags": [],
|
|
877
|
+
"methods": [],
|
|
878
|
+
"properties": [
|
|
879
|
+
{
|
|
880
|
+
"name": "facing",
|
|
881
|
+
"tags": [],
|
|
882
|
+
"docs": "The camera direction (\"front\" or \"rear\").",
|
|
883
|
+
"complexTypes": [],
|
|
884
|
+
"type": "string"
|
|
885
|
+
},
|
|
886
|
+
{
|
|
887
|
+
"name": "supportedPictureSizes",
|
|
888
|
+
"tags": [],
|
|
889
|
+
"docs": "A list of supported picture sizes for this camera.",
|
|
890
|
+
"complexTypes": [
|
|
891
|
+
"PictureSize"
|
|
892
|
+
],
|
|
893
|
+
"type": "PictureSize[]"
|
|
894
|
+
}
|
|
895
|
+
]
|
|
896
|
+
},
|
|
897
|
+
{
|
|
898
|
+
"name": "PictureSize",
|
|
899
|
+
"slug": "picturesize",
|
|
900
|
+
"docs": "Defines a standard picture size with width and height.",
|
|
901
|
+
"tags": [],
|
|
902
|
+
"methods": [],
|
|
903
|
+
"properties": [
|
|
904
|
+
{
|
|
905
|
+
"name": "width",
|
|
906
|
+
"tags": [],
|
|
907
|
+
"docs": "The width of the picture in pixels.",
|
|
908
|
+
"complexTypes": [],
|
|
909
|
+
"type": "number"
|
|
910
|
+
},
|
|
911
|
+
{
|
|
912
|
+
"name": "height",
|
|
913
|
+
"tags": [],
|
|
914
|
+
"docs": "The height of the picture in pixels.",
|
|
915
|
+
"complexTypes": [],
|
|
916
|
+
"type": "number"
|
|
917
|
+
}
|
|
918
|
+
]
|
|
919
|
+
},
|
|
561
920
|
{
|
|
562
921
|
"name": "CameraOpacityOptions",
|
|
563
922
|
"slug": "cameraopacityoptions",
|
|
564
|
-
"docs": "",
|
|
923
|
+
"docs": "Defines the options for setting the camera preview's opacity.",
|
|
565
924
|
"tags": [],
|
|
566
925
|
"methods": [],
|
|
567
926
|
"properties": [
|
|
568
927
|
{
|
|
569
928
|
"name": "opacity",
|
|
570
|
-
"tags": [
|
|
571
|
-
|
|
929
|
+
"tags": [
|
|
930
|
+
{
|
|
931
|
+
"text": "1.0",
|
|
932
|
+
"name": "default"
|
|
933
|
+
}
|
|
934
|
+
],
|
|
935
|
+
"docs": "The opacity percentage, from 0.0 (fully transparent) to 1.0 (fully opaque).",
|
|
572
936
|
"complexTypes": [],
|
|
573
937
|
"type": "number | undefined"
|
|
574
938
|
}
|
|
575
939
|
]
|
|
940
|
+
},
|
|
941
|
+
{
|
|
942
|
+
"name": "CameraDevice",
|
|
943
|
+
"slug": "cameradevice",
|
|
944
|
+
"docs": "Represents a physical camera on the device (e.g., the front-facing camera).",
|
|
945
|
+
"tags": [],
|
|
946
|
+
"methods": [],
|
|
947
|
+
"properties": [
|
|
948
|
+
{
|
|
949
|
+
"name": "deviceId",
|
|
950
|
+
"tags": [],
|
|
951
|
+
"docs": "A unique identifier for the camera device.",
|
|
952
|
+
"complexTypes": [],
|
|
953
|
+
"type": "string"
|
|
954
|
+
},
|
|
955
|
+
{
|
|
956
|
+
"name": "label",
|
|
957
|
+
"tags": [],
|
|
958
|
+
"docs": "A human-readable name for the camera device.",
|
|
959
|
+
"complexTypes": [],
|
|
960
|
+
"type": "string"
|
|
961
|
+
},
|
|
962
|
+
{
|
|
963
|
+
"name": "position",
|
|
964
|
+
"tags": [],
|
|
965
|
+
"docs": "The physical position of the camera on the device.",
|
|
966
|
+
"complexTypes": [
|
|
967
|
+
"CameraPosition"
|
|
968
|
+
],
|
|
969
|
+
"type": "CameraPosition"
|
|
970
|
+
},
|
|
971
|
+
{
|
|
972
|
+
"name": "lenses",
|
|
973
|
+
"tags": [],
|
|
974
|
+
"docs": "A list of all available lenses for this camera device.",
|
|
975
|
+
"complexTypes": [
|
|
976
|
+
"CameraLens"
|
|
977
|
+
],
|
|
978
|
+
"type": "CameraLens[]"
|
|
979
|
+
},
|
|
980
|
+
{
|
|
981
|
+
"name": "minZoom",
|
|
982
|
+
"tags": [],
|
|
983
|
+
"docs": "The overall minimum zoom factor available across all lenses on this device.",
|
|
984
|
+
"complexTypes": [],
|
|
985
|
+
"type": "number"
|
|
986
|
+
},
|
|
987
|
+
{
|
|
988
|
+
"name": "maxZoom",
|
|
989
|
+
"tags": [],
|
|
990
|
+
"docs": "The overall maximum zoom factor available across all lenses on this device.",
|
|
991
|
+
"complexTypes": [],
|
|
992
|
+
"type": "number"
|
|
993
|
+
},
|
|
994
|
+
{
|
|
995
|
+
"name": "isLogical",
|
|
996
|
+
"tags": [],
|
|
997
|
+
"docs": "Identifies whether the device is a logical camera (composed of multiple physical lenses).",
|
|
998
|
+
"complexTypes": [],
|
|
999
|
+
"type": "boolean"
|
|
1000
|
+
}
|
|
1001
|
+
]
|
|
1002
|
+
},
|
|
1003
|
+
{
|
|
1004
|
+
"name": "CameraLens",
|
|
1005
|
+
"slug": "cameralens",
|
|
1006
|
+
"docs": "Represents a single camera lens on a device. A {@link CameraDevice} can have multiple lenses.",
|
|
1007
|
+
"tags": [],
|
|
1008
|
+
"methods": [],
|
|
1009
|
+
"properties": [
|
|
1010
|
+
{
|
|
1011
|
+
"name": "label",
|
|
1012
|
+
"tags": [],
|
|
1013
|
+
"docs": "A human-readable name for the lens, e.g., \"Ultra-Wide\".",
|
|
1014
|
+
"complexTypes": [],
|
|
1015
|
+
"type": "string"
|
|
1016
|
+
},
|
|
1017
|
+
{
|
|
1018
|
+
"name": "deviceType",
|
|
1019
|
+
"tags": [],
|
|
1020
|
+
"docs": "The type of the camera lens.",
|
|
1021
|
+
"complexTypes": [
|
|
1022
|
+
"DeviceType"
|
|
1023
|
+
],
|
|
1024
|
+
"type": "DeviceType"
|
|
1025
|
+
},
|
|
1026
|
+
{
|
|
1027
|
+
"name": "focalLength",
|
|
1028
|
+
"tags": [],
|
|
1029
|
+
"docs": "The focal length of the lens in millimeters.",
|
|
1030
|
+
"complexTypes": [],
|
|
1031
|
+
"type": "number"
|
|
1032
|
+
},
|
|
1033
|
+
{
|
|
1034
|
+
"name": "baseZoomRatio",
|
|
1035
|
+
"tags": [],
|
|
1036
|
+
"docs": "The base zoom factor for this lens (e.g., 0.5 for ultra-wide, 1.0 for wide).",
|
|
1037
|
+
"complexTypes": [],
|
|
1038
|
+
"type": "number"
|
|
1039
|
+
},
|
|
1040
|
+
{
|
|
1041
|
+
"name": "minZoom",
|
|
1042
|
+
"tags": [],
|
|
1043
|
+
"docs": "The minimum zoom factor supported by this specific lens.",
|
|
1044
|
+
"complexTypes": [],
|
|
1045
|
+
"type": "number"
|
|
1046
|
+
},
|
|
1047
|
+
{
|
|
1048
|
+
"name": "maxZoom",
|
|
1049
|
+
"tags": [],
|
|
1050
|
+
"docs": "The maximum zoom factor supported by this specific lens.",
|
|
1051
|
+
"complexTypes": [],
|
|
1052
|
+
"type": "number"
|
|
1053
|
+
}
|
|
1054
|
+
]
|
|
1055
|
+
},
|
|
1056
|
+
{
|
|
1057
|
+
"name": "LensInfo",
|
|
1058
|
+
"slug": "lensinfo",
|
|
1059
|
+
"docs": "Represents the detailed information of the currently active lens.",
|
|
1060
|
+
"tags": [],
|
|
1061
|
+
"methods": [],
|
|
1062
|
+
"properties": [
|
|
1063
|
+
{
|
|
1064
|
+
"name": "focalLength",
|
|
1065
|
+
"tags": [],
|
|
1066
|
+
"docs": "The focal length of the active lens in millimeters.",
|
|
1067
|
+
"complexTypes": [],
|
|
1068
|
+
"type": "number"
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
"name": "deviceType",
|
|
1072
|
+
"tags": [],
|
|
1073
|
+
"docs": "The device type of the active lens.",
|
|
1074
|
+
"complexTypes": [
|
|
1075
|
+
"DeviceType"
|
|
1076
|
+
],
|
|
1077
|
+
"type": "DeviceType"
|
|
1078
|
+
},
|
|
1079
|
+
{
|
|
1080
|
+
"name": "baseZoomRatio",
|
|
1081
|
+
"tags": [],
|
|
1082
|
+
"docs": "The base zoom ratio of the active lens (e.g., 0.5x, 1.0x).",
|
|
1083
|
+
"complexTypes": [],
|
|
1084
|
+
"type": "number"
|
|
1085
|
+
},
|
|
1086
|
+
{
|
|
1087
|
+
"name": "digitalZoom",
|
|
1088
|
+
"tags": [],
|
|
1089
|
+
"docs": "The current digital zoom factor applied on top of the base zoom.",
|
|
1090
|
+
"complexTypes": [],
|
|
1091
|
+
"type": "number"
|
|
1092
|
+
}
|
|
1093
|
+
]
|
|
1094
|
+
}
|
|
1095
|
+
],
|
|
1096
|
+
"enums": [
|
|
1097
|
+
{
|
|
1098
|
+
"name": "DeviceType",
|
|
1099
|
+
"slug": "devicetype",
|
|
1100
|
+
"members": [
|
|
1101
|
+
{
|
|
1102
|
+
"name": "ULTRA_WIDE",
|
|
1103
|
+
"value": "\"ultraWide\"",
|
|
1104
|
+
"tags": [],
|
|
1105
|
+
"docs": ""
|
|
1106
|
+
},
|
|
1107
|
+
{
|
|
1108
|
+
"name": "WIDE_ANGLE",
|
|
1109
|
+
"value": "\"wideAngle\"",
|
|
1110
|
+
"tags": [],
|
|
1111
|
+
"docs": ""
|
|
1112
|
+
},
|
|
1113
|
+
{
|
|
1114
|
+
"name": "TELEPHOTO",
|
|
1115
|
+
"value": "\"telephoto\"",
|
|
1116
|
+
"tags": [],
|
|
1117
|
+
"docs": ""
|
|
1118
|
+
},
|
|
1119
|
+
{
|
|
1120
|
+
"name": "TRUE_DEPTH",
|
|
1121
|
+
"value": "\"trueDepth\"",
|
|
1122
|
+
"tags": [],
|
|
1123
|
+
"docs": ""
|
|
1124
|
+
},
|
|
1125
|
+
{
|
|
1126
|
+
"name": "DUAL",
|
|
1127
|
+
"value": "\"dual\"",
|
|
1128
|
+
"tags": [],
|
|
1129
|
+
"docs": ""
|
|
1130
|
+
},
|
|
1131
|
+
{
|
|
1132
|
+
"name": "DUAL_WIDE",
|
|
1133
|
+
"value": "\"dualWide\"",
|
|
1134
|
+
"tags": [],
|
|
1135
|
+
"docs": ""
|
|
1136
|
+
},
|
|
1137
|
+
{
|
|
1138
|
+
"name": "TRIPLE",
|
|
1139
|
+
"value": "\"triple\"",
|
|
1140
|
+
"tags": [],
|
|
1141
|
+
"docs": ""
|
|
1142
|
+
}
|
|
1143
|
+
]
|
|
576
1144
|
}
|
|
577
1145
|
],
|
|
578
|
-
"enums": [],
|
|
579
1146
|
"typeAliases": [
|
|
580
1147
|
{
|
|
581
1148
|
"name": "CameraPosition",
|
|
@@ -610,7 +1177,7 @@
|
|
|
610
1177
|
{
|
|
611
1178
|
"name": "CameraPreviewFlashMode",
|
|
612
1179
|
"slug": "camerapreviewflashmode",
|
|
613
|
-
"docs": "",
|
|
1180
|
+
"docs": "The available flash modes for the camera.\n'torch' is a continuous light mode.",
|
|
614
1181
|
"types": [
|
|
615
1182
|
{
|
|
616
1183
|
"text": "\"off\"",
|
|
@@ -624,15 +1191,24 @@
|
|
|
624
1191
|
"text": "\"auto\"",
|
|
625
1192
|
"complexTypes": []
|
|
626
1193
|
},
|
|
627
|
-
{
|
|
628
|
-
"text": "\"red-eye\"",
|
|
629
|
-
"complexTypes": []
|
|
630
|
-
},
|
|
631
1194
|
{
|
|
632
1195
|
"text": "\"torch\"",
|
|
633
1196
|
"complexTypes": []
|
|
634
1197
|
}
|
|
635
1198
|
]
|
|
1199
|
+
},
|
|
1200
|
+
{
|
|
1201
|
+
"name": "FlashMode",
|
|
1202
|
+
"slug": "flashmode",
|
|
1203
|
+
"docs": "",
|
|
1204
|
+
"types": [
|
|
1205
|
+
{
|
|
1206
|
+
"text": "CameraPreviewFlashMode",
|
|
1207
|
+
"complexTypes": [
|
|
1208
|
+
"CameraPreviewFlashMode"
|
|
1209
|
+
]
|
|
1210
|
+
}
|
|
1211
|
+
]
|
|
636
1212
|
}
|
|
637
1213
|
],
|
|
638
1214
|
"pluginConfigs": []
|