UNPKG

expo-camera

Version:

A React component that renders a preview for the device's either front or back camera. Camera's parameters like zoom, auto focus, white balance and flash mode are adjustable. With expo-camera, one can also take photos and record videos that are saved to t

123 lines 7.58 kB
import { type EventSubscription } from 'expo-modules-core'; import { type Ref, Component } from 'react'; import { CameraCapturedPicture, CameraOrientation, CameraPictureOptions, CameraViewProps, CameraRecordingOptions, CameraViewRef, ScanningOptions, ScanningResult, VideoCodec } from './Camera.types'; export default class CameraView extends Component<CameraViewProps> { /** * Property that determines if the current device has the ability to use `DataScannerViewController` (iOS 16+). */ static isModernBarcodeScannerAvailable: boolean; /** * Check whether the current device has a camera. This is useful for web and simulators cases. * This isn't influenced by the Permissions API (all platforms), or HTTP usage (in the browser). * You will still need to check if the native permission has been accepted. * @platform web */ static isAvailableAsync(): Promise<boolean>; /** * Queries the device for the available video codecs that can be used in video recording. * @return A promise that resolves to a list of strings that represents available codecs. * @platform ios */ static getAvailableVideoCodecsAsync(): Promise<VideoCodec[]>; /** * Get picture sizes that are supported by the device. * @return Returns a Promise that resolves to an array of strings representing picture sizes that can be passed to `pictureSize` prop. * The list varies across Android devices but is the same for every iOS. */ getAvailablePictureSizesAsync(): Promise<string[]>; /** * Resumes the camera preview. */ resumePreview(): Promise<void>; /** * Pauses the camera preview. It is not recommended to use `takePictureAsync` when preview is paused. */ pausePreview(): Promise<void>; static ConversionTables: { type: Record<number | typeof Symbol.iterator | "toString" | "charAt" | "charCodeAt" | "concat" | "indexOf" | "lastIndexOf" | "localeCompare" | "match" | "replace" | "search" | "slice" | "split" | "substring" | "toLowerCase" | "toLocaleLowerCase" | "toUpperCase" | "toLocaleUpperCase" | "trim" | "length" | "substr" | "valueOf" | "codePointAt" | "includes" | "endsWith" | "normalize" | "repeat" | "startsWith" | "anchor" | "big" | "blink" | "bold" | "fixed" | "fontcolor" | "fontsize" | "italics" | "link" | "small" | "strike" | "sub" | "sup" | "padStart" | "padEnd" | "trimEnd" | "trimStart" | "trimLeft" | "trimRight" | "matchAll" | "replaceAll" | "at", string | undefined>; flash: Record<number | typeof Symbol.iterator | "toString" | "charAt" | "charCodeAt" | "concat" | "indexOf" | "lastIndexOf" | "localeCompare" | "match" | "replace" | "search" | "slice" | "split" | "substring" | "toLowerCase" | "toLocaleLowerCase" | "toUpperCase" | "toLocaleUpperCase" | "trim" | "length" | "substr" | "valueOf" | "codePointAt" | "includes" | "endsWith" | "normalize" | "repeat" | "startsWith" | "anchor" | "big" | "blink" | "bold" | "fixed" | "fontcolor" | "fontsize" | "italics" | "link" | "small" | "strike" | "sub" | "sup" | "padStart" | "padEnd" | "trimEnd" | "trimStart" | "trimLeft" | "trimRight" | "matchAll" | "replaceAll" | "at", string | undefined>; }; static defaultProps: CameraViewProps; _cameraHandle?: number | null; _cameraRef: import("react").RefObject<CameraViewRef>; _lastEvents: { [eventName: string]: string; }; _lastEventsTimes: { [eventName: string]: Date; }; /** * Takes a picture and saves it to app's cache directory. Photos are rotated to match device's orientation * (if `options.skipProcessing` flag is not enabled) and scaled to match the preview. * > **Note**: Make sure to wait for the [`onCameraReady`](#oncameraready) callback before calling this method. * @param options An object in form of `CameraPictureOptions` type. * @return Returns a Promise that resolves to `CameraCapturedPicture` object, where `uri` is a URI to the local image file on Android, * iOS, and a base64 string on web (usable as the source for an `Image` element). The `width` and `height` properties specify * the dimensions of the image. * * `base64` is included if the `base64` option was truthy, and is a string containing the JPEG data * of the image in Base64. Prepend it with `'data:image/jpg;base64,'` to get a data URI, which you can use as the source * for an `Image` element for example. * * `exif` is included if the `exif` option was truthy, and is an object containing EXIF * data for the image. The names of its properties are EXIF tags and their values are the values for those tags. * * > On native platforms, the local image URI is temporary. Use [`FileSystem.copyAsync`](filesystem/#filesystemcopyasyncoptions) * > to make a permanent copy of the image. * * > **Note:** Avoid calling this method while the preview is paused. On Android, this will throw an error. On iOS, this will take a picture of the last frame that is currently on screen. */ takePictureAsync(options?: CameraPictureOptions): Promise<CameraCapturedPicture | undefined>; /** * Presents a modal view controller that uses the [`DataScannerViewController`](https://developer.apple.com/documentation/visionkit/scanning_data_with_the_camera) available on iOS 16+. * @platform ios */ static launchScanner(options?: ScanningOptions): Promise<void>; /** * Dismiss the scanner presented by `launchScanner`. * @platform ios */ static dismissScanner(): Promise<void>; /** * Invokes the `listener` function when a bar code has been successfully scanned. The callback is provided with * an object of the `ScanningResult` shape, where the `type` refers to the bar code type that was scanned and the `data` is the information encoded in the bar code * (in this case of QR codes, this is often a URL). See [`BarcodeType`](#barcodetype) for supported values. * @param listener Invoked with the [ScanningResult](#scanningresult) when a bar code has been successfully scanned. * * @platform ios */ static onModernBarcodeScanned(listener: (event: ScanningResult) => void): EventSubscription; /** * Starts recording a video that will be saved to cache directory. Videos are rotated to match device's orientation. * Flipping camera during a recording results in stopping it. * @param options A map of `CameraRecordingOptions` type. * @return Returns a Promise that resolves to an object containing video file `uri` property and a `codec` property on iOS. * The Promise is returned if `stopRecording` was invoked, one of `maxDuration` and `maxFileSize` is reached or camera preview is stopped. * @platform android * @platform ios */ recordAsync(options?: CameraRecordingOptions): Promise<{ uri: string; } | undefined>; /** * Stops recording if any is in progress. */ stopRecording(): void; _onCameraReady: () => void; _onMountError: ({ nativeEvent }: { nativeEvent: { message: string; }; }) => void; _onResponsiveOrientationChanged: ({ nativeEvent, }: { nativeEvent: { orientation: CameraOrientation; }; }) => void; _onObjectDetected: (callback?: Function) => ({ nativeEvent }: { nativeEvent: any; }) => void; _setReference: (ref: Ref<CameraViewRef>) => void; render(): import("react").JSX.Element; } //# sourceMappingURL=CameraView.d.ts.map