InputConfiguration

public final class InputConfiguration
extends Object

java.lang.Object
   ↳ android.hardware.camera2.params.InputConfiguration


Immutable class to store an input configuration that is used to create a reprocessable capture session.

Summary

Public constructors

InputConfiguration(int width, int height, int format)

Create an input configuration with the width, height, and user-defined format.

InputConfiguration(Collection<MultiResolutionStreamInfo> multiResolutionInputs, int format)

Create an input configuration with the format and a list of multi-resolution input stream info.

Public methods

boolean equals(Object obj)

Check if this InputConfiguration is equal to another InputConfiguration.

int getFormat()

Get the format of this input configuration.

int getHeight()

Get the height of this input configuration.

int getWidth()

Get the width of this input configuration.

int hashCode()

Returns a hash code value for the object.

boolean isMultiResolution()

Whether this input configuration is of multi-resolution.

String toString()

Return this InputConfiguration as a string representation.

Inherited methods

Public constructors

InputConfiguration

Added in API level 23
public InputConfiguration (int width, 
                int height, 
                int format)

Create an input configuration with the width, height, and user-defined format.

Images of a user-defined format are accessible by applications. Use CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP to query supported input formats

Parameters
width int: Width of the input buffers.

height int: Height of the input buffers.

format int: Format of the input buffers. One of ImageFormat or PixelFormat constants.

InputConfiguration

Added in API level 23
public InputConfiguration (Collection<MultiResolutionStreamInfo> multiResolutionInputs, 
                int format)

Create an input configuration with the format and a list of multi-resolution input stream info.

Use CameraCharacteristics.SCALER_MULTI_RESOLUTION_STREAM_CONFIGURATION_MAP to query supported multi-resolution input formats.

To do reprocessing with variable resolution input, the application calls ImageWriter.queueInputImage using an image from an ImageReader or MultiResolutionImageReader. See CameraDevice.createReprocessCaptureRequest(TotalCaptureResult) for more details on camera reprocessing.

Parameters
multiResolutionInputs Collection: A group of multi-resolution input info for the specified format. This value cannot be null.

format int: Format of the input buffers. One of ImageFormat or PixelFormat constants. Value is ImageFormat.UNKNOWN, PixelFormat.RGBA_8888, PixelFormat.RGBX_8888, PixelFormat.RGB_888, ImageFormat.RGB_565, ImageFormat.YV12, ImageFormat.Y8, android.graphics.ImageFormat.Y16, ImageFormat.YCBCR_P010, ImageFormat.NV16, ImageFormat.NV21, ImageFormat.YUY2, ImageFormat.JPEG, ImageFormat.DEPTH_JPEG, ImageFormat.YUV_420_888, ImageFormat.YUV_422_888, ImageFormat.YUV_444_888, ImageFormat.FLEX_RGB_888, ImageFormat.FLEX_RGBA_8888, ImageFormat.RAW_SENSOR, ImageFormat.RAW_PRIVATE, ImageFormat.RAW10, ImageFormat.RAW12, ImageFormat.DEPTH16, ImageFormat.DEPTH_POINT_CLOUD, android.graphics.ImageFormat.RAW_DEPTH, android.graphics.ImageFormat.RAW_DEPTH10, ImageFormat.PRIVATE, ImageFormat.HEIC, or ImageFormat.JPEG_R

Public methods

equals

Added in API level 23
public boolean equals (Object obj)

Check if this InputConfiguration is equal to another InputConfiguration.

Two input configurations are equal if and only if they have the same widths, heights, and formats.

Parameters
obj Object: the object to compare this instance with. This value may be null.

Returns
boolean true if the objects were equal, false otherwise.

getFormat

Added in API level 23
public int getFormat ()

Get the format of this input configuration.

Returns
int format of this input configuration.

getHeight

Added in API level 23
public int getHeight ()

Get the height of this input configuration.

Returns
int height of this input configuration.

getWidth

Added in API level 23
public int getWidth ()

Get the width of this input configuration.

Returns
int width of this input configuration.

hashCode

Added in API level 23
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

isMultiResolution

Added in API level 31
public boolean isMultiResolution ()

Whether this input configuration is of multi-resolution.

An multi-resolution InputConfiguration means that the reprocessing session created from it allows input images of different sizes.

Returns
boolean this input configuration is multi-resolution or not.

toString

Added in API level 23
public String toString ()

Return this InputConfiguration as a string representation.

"InputConfiguration(w:%d, h:%d, format:%d, isMultiResolution:%d)", where %d represents the width, height, format, and multi-resolution flag respectively.

Returns
String string representation of InputConfiguration