ImageCaptureConfig.Builder

ImageCaptureConfig.Builder

public ImageCaptureConfig.Builder ()

Creates a new Builder object.

build

public ImageCaptureConfig build ()

Builds an immutable ImageCaptureConfig from the current state.

fromConfig

public static ImageCaptureConfig.Builder fromConfig (ImageCaptureConfig configuration)

Generates a Builder from another Config object

setCallbackHandler

public ImageCaptureConfig.Builder setCallbackHandler (Handler handler)

Sets the default handler that will be used for callbacks.

setCaptureMode

public ImageCaptureConfig.Builder setCaptureMode (ImageCapture.CaptureMode captureMode)

Sets the image capture mode.

Valid capture modes are ImageCapture.CaptureMode.MIN_LATENCY, which prioritizes latency over image quality, or ImageCapture.CaptureMode.MAX_QUALITY, which prioritizes image quality over latency.

setFlashMode

public ImageCaptureConfig.Builder setFlashMode (FlashMode flashMode)

Sets the FlashMode.

setLensFacing

public ImageCaptureConfig.Builder setLensFacing (CameraX.LensFacing lensFacing)

Sets the primary camera to be configured based on the direction the lens is facing.

If multiple cameras exist with equivalent lens facing direction, the first ("primary") camera for that direction will be chosen.

setTargetAspectRatio

public ImageCaptureConfig.Builder setTargetAspectRatio (Rational aspectRatio)

Sets the aspect ratio of the intended target for images from this configuration.

This is the ratio of the target's width to the image's height, where the numerator of the provided Rational corresponds to the width, and the denominator corresponds to the height.

The target aspect ratio is used as a hint when determining the resulting output aspect ratio which may differ from the request, possibly due to device constraints. Application code should check the resulting output's resolution.

For ImageCapture, the outputs are the ImageProxy or the File passed to image capture listeners.

setTargetName

public ImageCaptureConfig.Builder setTargetName (String targetName)

Sets the name of the target object being configured.

The name should be a value that can uniquely identify an instance of the object being configured.

setTargetResolution

public ImageCaptureConfig.Builder setTargetResolution (Size resolution)

Sets the intended output target resolution.

The target resolution attempts to establish a minimum bound for the image resolution. The actual image resolution will be the closest available resolution in size that is not smaller than the target resolution, as determined by the Camera implementation. However, if no resolution exists that is equal to or larger than the target resolution, the nearest available resolution smaller than the target resolution will be chosen.

setTargetRotation

public ImageCaptureConfig.Builder setTargetRotation (int rotation)

Sets the rotation of the intended target for images from this configuration.

This is one of four valid values: Surface.ROTATION_0, Surface.ROTATION_90, Surface.ROTATION_180, Surface.ROTATION_270. Rotation values are relative to the "natural" rotation, Surface.ROTATION_0.