Skip to main content

Interface: CameraDeviceFormat

A Camera Device's stream-configuration format.

A format specifies:

  • Video Resolution (videoWidth/videoHeight)
  • Photo Resolution (photoWidth/photoHeight)
  • Possible FPS ranges (fps)
  • Video Stabilization Modes (videoStabilizationModes)
  • Pixel Formats (pixelFormats)

Properties​

autoFocusSystem​

• autoFocusSystem: AutoFocusSystem

Specifies this format's auto focus system.

Defined in​

CameraDevice.ts:122

fieldOfView​

• fieldOfView: number

The video field of view in degrees

Defined in​

CameraDevice.ts:94

maxExposure​

• maxExposure: number

The maximum Exposure-Bias value this format supports. When setting the exposure to this value, the image is almost completely bright (over-exposed).

Defined in​

CameraDevice.ts:90

maxFps​

• maxFps: number

The maximum frame rate this Format is able to run at. High resolution formats often run at lower frame rates.

Defined in​

CameraDevice.ts:118

maxISO​

• maxISO: number

Maximum supported ISO value

Defined in​

CameraDevice.ts:78

maxZoom​

• maxZoom: number

The maximum zoom factor (e.g. 128)

Defined in​

CameraDevice.ts:98

minExposure​

• minExposure: number

The minimum Exposure-Bias value this format supports. When setting the exposure to this value, the image is almost completely dark (under-exposed).

Defined in​

CameraDevice.ts:86

minFps​

• minFps: number

The minum frame rate this Format needs to run at. High resolution formats often run at lower frame rates.

Defined in​

CameraDevice.ts:114

minISO​

• minISO: number

Minimum supported ISO value

Defined in​

CameraDevice.ts:82

photoHeight​

• photoHeight: number

The height of the highest resolution a still image (photo) can be produced in

Defined in​

CameraDevice.ts:62

photoWidth​

• photoWidth: number

The width of the highest resolution a still image (photo) can be produced in

Defined in​

CameraDevice.ts:66

pixelFormats​

• pixelFormats: PixelFormat[]

Specifies this format's supported pixel-formats. In most cases, this is ['native', 'yuv'], some iPhones also support 'rgb'.

Any value represented here can be used to configure the Camera to stream Frames in the given PixelFormat.

Defined in​

CameraDevice.ts:133

supportsDepthCapture​

• supportsDepthCapture: boolean

Specifies whether this format supports delivering depth data for photo or video capture.

Defined in​

CameraDevice.ts:110

supportsPhotoHdr​

• supportsPhotoHdr: boolean

Specifies whether this format supports HDR mode for photo capture

Defined in​

CameraDevice.ts:106

supportsVideoHdr​

• supportsVideoHdr: boolean

Specifies whether this format supports HDR mode for video capture

Defined in​

CameraDevice.ts:102

videoHeight​

• videoHeight: number

The video resolutions's height

Defined in​

CameraDevice.ts:70

videoStabilizationModes​

• videoStabilizationModes: VideoStabilizationMode[]

All supported video stabilization modes

Defined in​

CameraDevice.ts:126

videoWidth​

• videoWidth: number

The video resolution's width

Defined in​

CameraDevice.ts:74