Skip to main content

Interface: FormatFilter

Properties​

fps​

• Optional fps: Filter<number>

The target FPS you want to record video at. If the FPS requirements can not be met, the format closest to this value will be used.

Defined in​

devices/getCameraFormat.ts:51

photoAspectRatio​

• Optional photoAspectRatio: Filter<number>

The target aspect ratio of the photo output, expressed as a factor: width / height.

In most cases, you want this to be the same as targetVideoAspectRatio, which you often want to be as close to the screen's aspect ratio as possible (usually ~9:16)

Example

const screen = Dimensions.get('screen')
targetPhotoAspectRatio: screen.width / screen.height

Defined in​

devices/getCameraFormat.ts:46

photoResolution​

• Optional photoResolution: Filter<Size>

The target resolution of the photo output pipeline. If no format supports the given resolution, the format closest to this value will be used.

Defined in​

devices/getCameraFormat.ts:21

pixelFormat​

• Optional pixelFormat: Filter<PixelFormat>

The target pixel format you want to use. If no format supports the target pixel format, the best other matching format will be used.

Defined in​

devices/getCameraFormat.ts:61

videoAspectRatio​

• Optional videoAspectRatio: Filter<number>

The target aspect ratio of the video (and preview) output, expressed as a factor: width / height.

In most cases, you want this to be as close to the screen's aspect ratio as possible (usually ~9:16).

Example

const screen = Dimensions.get('screen')
targetVideoAspectRatio: screen.width / screen.height

Defined in​

devices/getCameraFormat.ts:33

videoResolution​

• Optional videoResolution: Filter<Size>

The target resolution of the video (and frame processor) output pipeline. If no format supports the given resolution, the format closest to this value will be used.

Defined in​

devices/getCameraFormat.ts:16

videoStabilizationMode​

• Optional videoStabilizationMode: Filter<VideoStabilizationMode>

The target video stabilization mode you want to use. If no format supports the target video stabilization mode, the best other matching format will be used.

Defined in​

devices/getCameraFormat.ts:56