Overview

Builder for a ImageCaptureConfig.

Summary

Constructors

Creates a new Builder object.

Methods

Generates a Builder from another Config object

Parameters:

configuration: An immutable configuration to pre-populate this builder.

Returns:

The new Builder.

Builds an immutable ImageCaptureConfig from the current state.

Returns:

A ImageCaptureConfig populated with the current state.

Sets the image capture mode.

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

Parameters:

captureMode: The requested image capture mode.

Returns:

The current Builder.

Sets the FlashMode.

Parameters:

flashMode: The requested flash mode.

Returns:

The current Builder.

Sets the CaptureBundle.

Parameters:

captureBundle: The requested capture bundle for extension.

Returns:

The current Builder.

Sets the CaptureProcessor.

Parameters:

captureProcessor: The requested capture processor for extension.

Returns:

The current Builder.

Sets the of the ImageProxy returned by the .

Warning. This could lead to an invalid configuration as image format support is per device. Also, setting the buffer format in conjuncture with image capture extensions will result in an invalid configuration. In this case ImageCapture.ImageCapture(ImageCaptureConfig) will throw an java.lang.IllegalArgumentException.

Parameters:

bufferImageFormat: The image format for captured images.

Returns:

The current Builder.

Sets the max number of CaptureStage.

Parameters:

maxCaptureStages: The max CaptureStage number.

Returns:

The current Builder.

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.

Parameters:

targetName: A unique string identifier for the instance of the class being configured.

Returns:

the current Builder.

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.

Parameters:

lensFacing: The direction of the camera's lens.

Returns:

the current Builder.

Sets a CameraIdFilter that filter out the unavailable camera id.

The camera id filter will be used to filter those cameras with lens facing specified in the config.

Parameters:

cameraIdFilter: The CameraIdFilter.

Returns:

the current Builder.

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 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.

This method can be used to request an aspect ratio that is not from the standard set of aspect ratios defined in the AspectRatio.

This method will remove any value set by setTargetAspectRatio().

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

Parameters:

aspectRatio: A representing the ratio of the target's width and height.

Returns:

The current Builder.

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

It is not allowed to set both target aspect ratio and target resolution on the same use case.

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.

Parameters:

aspectRatio: A AspectRatio representing the ratio of the target's width and height.

Returns:

The current Builder.

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

This is one of four valid values: , , , . Rotation values are relative to the "natural" rotation, .

Parameters:

rotation: The rotation of the intended target.

Returns:

The current Builder.

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.

It is not allowed to set both target aspect ratio and target resolution on the same use case.

The target aspect ratio will also be set the same as the aspect ratio of the provided . Make sure to set the target resolution with the correct orientation.

Parameters:

resolution: The target resolution to choose from supported output sizes list.

Returns:

The current Builder.

Sets the default resolution of the intended target from this configuration.

Parameters:

resolution: The default resolution to choose from supported output sizes list.

Returns:

The current Builder.

Sets the default executor that will be used for background tasks.

Parameters:

executor: The executor which will be used for background tasks.

Returns:

the current Builder.