-
Notifications
You must be signed in to change notification settings - Fork 586
/
definitions.ts
365 lines (339 loc) · 8.37 KB
/
definitions.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
import type { PermissionState } from '@capacitor/core';
export type CameraPermissionState = PermissionState | 'limited';
export type CameraPermissionType = 'camera' | 'photos';
export interface PermissionStatus {
camera: CameraPermissionState;
photos: CameraPermissionState;
}
export interface CameraPluginPermissions {
permissions: CameraPermissionType[];
}
export interface CameraPlugin {
/**
* Prompt the user to pick a photo from an album, or take a new photo
* with the camera.
*
* @since 1.0.0
*/
getPhoto(options: ImageOptions): Promise<Photo>;
/**
* Allows the user to pick multiple pictures from the photo gallery.
* On iOS 13 and older it only allows to pick one picture.
*
* @since 1.2.0
*/
pickImages(options: GalleryImageOptions): Promise<GalleryPhotos>;
/**
* iOS 14+ Only: Allows the user to update their limited photo library selection.
* On iOS 15+ returns all the limited photos after the picker dismissal.
* On iOS 14 or if the user gave full access to the photos it returns an empty array.
*
* @since 4.1.0
*/
pickLimitedLibraryPhotos(): Promise<GalleryPhotos>;
/**
* iOS 14+ Only: Return an array of photos selected from the limited photo library.
*
* @since 4.1.0
*/
getLimitedLibraryPhotos(): Promise<GalleryPhotos>;
/**
* Check camera and photo album permissions
*
* @since 1.0.0
*/
checkPermissions(): Promise<PermissionStatus>;
/**
* Request camera and photo album permissions
*
* @since 1.0.0
*/
requestPermissions(
permissions?: CameraPluginPermissions,
): Promise<PermissionStatus>;
}
export interface ImageOptions {
/**
* The quality of image to return as JPEG, from 0-100
* Note: This option is only supported on Android and iOS
*
* @since 1.0.0
*/
quality?: number;
/**
* Whether to allow the user to crop or make small edits (platform specific).
* On iOS 14+ it's only supported for CameraSource.Camera, but not for CameraSource.Photos.
*
* @since 1.0.0
*/
allowEditing?: boolean;
/**
* How the data should be returned. Currently, only 'Base64', 'DataUrl' or 'Uri' is supported
*
* @since 1.0.0
*/
resultType: CameraResultType;
/**
* Whether to save the photo to the gallery.
* If the photo was picked from the gallery, it will only be saved if edited.
* @default: false
*
* @since 1.0.0
*/
saveToGallery?: boolean;
/**
* The desired maximum width of the saved image. The aspect ratio is respected.
*
* @since 1.0.0
*/
width?: number;
/**
* The desired maximum height of the saved image. The aspect ratio is respected.
*
* @since 1.0.0
*/
height?: number;
/**
* Whether to automatically rotate the image "up" to correct for orientation
* in portrait mode
* @default: true
*
* @since 1.0.0
*/
correctOrientation?: boolean;
/**
* The source to get the photo from. By default this prompts the user to select
* either the photo album or take a photo.
* @default: CameraSource.Prompt
*
* @since 1.0.0
*/
source?: CameraSource;
/**
* iOS and Web only: The camera direction.
* @default: CameraDirection.Rear
*
* @since 1.0.0
*/
direction?: CameraDirection;
/**
* iOS only: The presentation style of the Camera.
* @default: 'fullscreen'
*
* @since 1.0.0
*/
presentationStyle?: 'fullscreen' | 'popover';
/**
* Web only: Whether to use the PWA Element experience or file input. The
* default is to use PWA Elements if installed and fall back to file input.
* To always use file input, set this to `true`.
*
* Learn more about PWA Elements: https://capacitorjs.com/docs/web/pwa-elements
*
* @since 1.0.0
*/
webUseInput?: boolean;
/**
* Text value to use when displaying the prompt.
* @default: 'Photo'
*
* @since 1.0.0
*
*/
promptLabelHeader?: string;
/**
* Text value to use when displaying the prompt.
* iOS only: The label of the 'cancel' button.
* @default: 'Cancel'
*
* @since 1.0.0
*/
promptLabelCancel?: string;
/**
* Text value to use when displaying the prompt.
* The label of the button to select a saved image.
* @default: 'From Photos'
*
* @since 1.0.0
*/
promptLabelPhoto?: string;
/**
* Text value to use when displaying the prompt.
* The label of the button to open the camera.
* @default: 'Take Picture'
*
* @since 1.0.0
*/
promptLabelPicture?: string;
}
export interface Photo {
/**
* The base64 encoded string representation of the image, if using CameraResultType.Base64.
*
* @since 1.0.0
*/
base64String?: string;
/**
* The url starting with 'data:image/jpeg;base64,' and the base64 encoded string representation of the image, if using CameraResultType.DataUrl.
*
* Note: On web, the file format could change depending on the browser.
* @since 1.0.0
*/
dataUrl?: string;
/**
* If using CameraResultType.Uri, the path will contain a full,
* platform-specific file URL that can be read later using the Filesystem API.
*
* @since 1.0.0
*/
path?: string;
/**
* webPath returns a path that can be used to set the src attribute of an image for efficient
* loading and rendering.
*
* @since 1.0.0
*/
webPath?: string;
/**
* Exif data, if any, retrieved from the image
*
* @since 1.0.0
*/
exif?: any;
/**
* The format of the image, ex: jpeg, png, gif.
*
* iOS and Android only support jpeg.
* Web supports jpeg, png and gif, but the exact availability may vary depending on the browser.
* gif is only supported if `webUseInput` is set to `true` or if `source` is set to `Photos`.
*
* @since 1.0.0
*/
format: string;
/**
* Whether if the image was saved to the gallery or not.
*
* On Android and iOS, saving to the gallery can fail if the user didn't
* grant the required permissions.
* On Web there is no gallery, so always returns false.
*
* @since 1.1.0
*/
saved: boolean;
}
export interface GalleryPhotos {
/**
* Array of all the picked photos.
*
* @since 1.2.0
*/
photos: GalleryPhoto[];
}
export interface GalleryPhoto {
/**
* Full, platform-specific file URL that can be read later using the Filesystem API.
*
* @since 1.2.0
*/
path?: string;
/**
* webPath returns a path that can be used to set the src attribute of an image for efficient
* loading and rendering.
*
* @since 1.2.0
*/
webPath: string;
/**
* Exif data, if any, retrieved from the image
*
* @since 1.2.0
*/
exif?: any;
/**
* The format of the image, ex: jpeg, png, gif.
*
* iOS and Android only support jpeg.
* Web supports jpeg, png and gif.
*
* @since 1.2.0
*/
format: string;
}
export interface GalleryImageOptions {
/**
* The quality of image to return as JPEG, from 0-100
* Note: This option is only supported on Android and iOS.
*
* @since 1.2.0
*/
quality?: number;
/**
* The desired maximum width of the saved image. The aspect ratio is respected.
*
* @since 1.2.0
*/
width?: number;
/**
* The desired maximum height of the saved image. The aspect ratio is respected.
*
* @since 1.2.0
*/
height?: number;
/**
* Whether to automatically rotate the image "up" to correct for orientation
* in portrait mode
* @default: true
*
* @since 1.2.0
*/
correctOrientation?: boolean;
/**
* iOS only: The presentation style of the Camera.
* @default: 'fullscreen'
*
* @since 1.2.0
*/
presentationStyle?: 'fullscreen' | 'popover';
/**
* Maximum number of pictures the user will be able to choose.
* Note: This option is only supported on Android 13+ and iOS.
*
* @default 0 (unlimited)
*
* @since 1.2.0
*/
limit?: number;
}
export enum CameraSource {
/**
* Prompts the user to select either the photo album or take a photo.
*/
Prompt = 'PROMPT',
/**
* Take a new photo using the camera.
*/
Camera = 'CAMERA',
/**
* Pick an existing photo from the gallery or photo album.
*/
Photos = 'PHOTOS',
}
export enum CameraDirection {
Rear = 'REAR',
Front = 'FRONT',
}
export enum CameraResultType {
Uri = 'uri',
Base64 = 'base64',
DataUrl = 'dataUrl',
}
/**
* @deprecated Use `Photo`.
* @since 1.0.0
*/
export type CameraPhoto = Photo;
/**
* @deprecated Use `ImageOptions`.
* @since 1.0.0
*/
export type CameraOptions = ImageOptions;