# CameraInfoModule

The `CameraInfoModule` class provides access to details about the device camera.

## Example

```
//==============================================================================
// The following example demonstrates how to hide an object when capturing a
// photo or recording a video.
//
// Project setup:
// - Insert a plane
//==============================================================================

// Load in the required modules
const CameraInfo = require('CameraInfo');
const Scene = require('Scene');

// Locate the plane in the Scene
const plane = Scene.root.find('plane0');

//==============================================================================
// Hide the plane when capturing a photo or recording a video
//==============================================================================

// Store references to the photo capture and video recording boolean signals
const isCapturingPhoto = CameraInfo.isCapturingPhoto;
const isRecordingVideo = CameraInfo.isRecordingVideo;

// Create a boolean signal that returns true if either boolean signal are true
const hidePlane = isCapturingPhoto.or(isRecordingVideo);

// Bind the hidePlane signal to the hidden property of the plane
plane.hidden = hidePlane;
```

## Properties

| Property                | Description                                                                                                                                                                                                     |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `captureDevicePosition` | <p><code>(get) captureDevicePosition: Signal\<CameraPosition> (set) (Not Available)</code></p><p>Specifies a <code>CameraPosition</code> enum signal identifying the current camera in use on the device.</p>   |
| `effectSafeAreaInsets`  | <p><code>(get) effectSafeAreaInsets: InsetsSignal (set) (Not Available)</code></p><p>Specifies an <code>InsetsSignal</code> indicating the insets of the effect safe area.</p>                                  |
| `isCapturingPhoto`      | <p><code>(get) isCapturingPhoto: BoolSignal (set) (Not Available)</code></p><p>Specifies a <code>BoolSignal</code> that indicates whether the camera is capturing a photo.</p>                                  |
| `isRecordingVideo`      | <p><code>(get) isRecordingVideo: BoolSignal (set) (Not Available)</code></p><p>Specifies a <code>BoolSignal</code> that indicates whether the camera is recording video.</p>                                    |
| `previewScreenScale`    | <p><code>(get) previewScreenScale: ScalarSignal (set) (Not Available)</code></p><p>Specifies a <code>ScalarSignal</code> describing the scale of the preview's screen, i.e. the number of pixels per point.</p> |
| `previewSize`           | <p><code>(get) previewSize: PixelSizeSignal (set) (Not Available)</code></p><p>Specifies a <code>PixelSizeSignal</code> describing the size of the preview, in pixels.</p>                                      |

## Methods

This module exposes no methods.

## Classes

This module exposes no classes.

## Enums

| Enum                                                                                                            | Description                                                             |
| --------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| [`CameraPosition`](https://sparkar.facebook.com/docs/ar-studio/reference/enums/camerainfomodule.cameraposition) | The `CameraPosition` enum describes the direction the camera is facing. |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://sparkar-community.gitbook.io/docs/camera-info-module.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.