* Automatically build API documentation using Typedoc and Docusaurus
* Move MD and move to MDX for Docusaurus Guides

2021-03-03 12:37:43 +01:00

id	title	sidebar_label	custom_edit_url	hide_title
camera	Module: Camera	Camera	null	true

Module: Camera

Type aliases

Ƭ CameraDeviceProps: object

Name	Type	Description
`device`	CameraDevice	The Camera Device to use
`enableDepthData`?	boolean	Also captures data from depth-perception sensors. (e.g. disparity maps) `default` false
`enableHighResolutionCapture`?	boolean	Indicates whether the photo render pipeline should be configured to deliver high resolution still images `default` false
`enablePortraitEffectsMatteDelivery`?	boolean	A boolean specifying whether the photo render pipeline is prepared for portrait effects matte delivery. When enabling this, you must also set `enableDepthData` to `true`. `platform` iOS 12.0+ `default` false

Ƭ CameraDynamicProps: object

Name	Type	Description
`enableZoomGesture`?	boolean	Enables or disables the pinch to zoom gesture `default` false
`isActive`	boolean	Whether the Camera should actively stream video frames, or not. This can be compared to a Video component, where `isActive` specifies whether the video is paused or not. > Note: If you fully unmount the `<Camera>` component instead of using `isActive={false}`, the Camera will take a bit longer to start again. In return, it will use less resources since the Camera will be completely destroyed when unmounted.
`torch`?	off \| on	Set the current torch mode. Note: The torch is only available on `"back"` cameras, and isn't supported by every phone. `default` "off"
`zoom`?	number	Specifies the zoom factor of the current camera, in percent. (`0.0` - `1.0`) `default` 0.0

Ƭ CameraEventProps: object

Name	Type	Description
`onError`?	(`error`: CameraRuntimeError) => void	Called when any kind of runtime error occured.
`onInitialized`?	() => void	Called when the camera was successfully initialized.