Skip to main content

Interface: FormatFilter

Properties​

fps​

• Optional fps: 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:52

photoAspectRatio​

• Optional photoAspectRatio: number

The target aspect ratio of the photo output, expressed as a factor: width / height. (Note: Cameras are in landscape orientation)

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.height / screen.width

Defined in​

devices/getCameraFormat.ts:47

photoHdr​

• Optional photoHdr: boolean

Whether you want to find a format that supports Photo HDR.

Defined in​

devices/getCameraFormat.ts:66

photoResolution​

• Optional photoResolution: "max" | 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:20

pixelFormat​

• Optional pixelFormat: 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:62

videoAspectRatio​

• Optional videoAspectRatio: number

The target aspect ratio of the video (and preview) output, expressed as a factor: width / height. (Note: Cameras are in landscape orientation)

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.height / screen.width

Defined in​

devices/getCameraFormat.ts:33

videoHdr​

• Optional videoHdr: boolean

Whether you want to find a format that supports Photo HDR.

Defined in​

devices/getCameraFormat.ts:70

videoResolution​

• Optional videoResolution: "max" | 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:15

videoStabilizationMode​

• Optional videoStabilizationMode: 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:57