MediaSourceImageCaptureConfig interface

Options for capturing an image from a media source.

Signature:

export interface MediaSourceImageCaptureConfig 

Properties

PropertyModifiersTypeDescription
maxHeight?readonlynumber(Optional) The maximum height of the captured image. If not specified, the source height is used.
maxWidth?readonlynumber(Optional) The maximum width of the captured image. If not specified, the source width is used.
preferredFormat?readonlyEnum<typeof MediaSourceImageCaptureFormat>(Optional) The preferred format of the captured image, if specified. The module must not assume that the captured image will always be saved in this format as the platform can use a different one.

MediaSourceImageCaptureConfig.maxHeight property

The maximum height of the captured image. If not specified, the source height is used.

Signature:

readonly maxHeight?: number;

MediaSourceImageCaptureConfig.maxWidth property

The maximum width of the captured image. If not specified, the source width is used.

Signature:

readonly maxWidth?: number;

MediaSourceImageCaptureConfig.preferredFormat property

The preferred format of the captured image, if specified. The module must not assume that the captured image will always be saved in this format as the platform can use a different one.

Signature:

readonly preferredFormat?: Enum<typeof MediaSourceImageCaptureFormat>;