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 configration with the width, height, and user-defined format.

Public methods

boolean equals(Object obj)

Check if this InputConfiguration is equal to another InputConfiguration.

int getFormat()

Get the format of this input configration.

int getHeight()

Get the height of this input configration.

int getWidth()

Get the width of this input configration.

int hashCode()

Returns a hash code value for the object.

String toString()

Return this InputConfiguration as a string representation.

Inherited methods

Public constructors

InputConfiguration

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

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

Images of an user-defined format are accessible by applications. Use 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.

Public methods

equals

added in API level 23
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.

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

getFormat

added in API level 23
int getFormat ()

Get the format of this input configration.

Returns
int format of this input configuration.

getHeight

added in API level 23
int getHeight ()

Get the height of this input configration.

Returns
int height of this input configuration.

getWidth

added in API level 23
int getWidth ()

Get the width of this input configration.

Returns
int width of this input configuration.

hashCode

added in API level 23
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(Object) 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(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

toString

added in API level 23
String toString ()

Return this InputConfiguration as a string representation.

"InputConfiguration(w:%d, h:%d, format:%d)", where %d represents the width, height, and format, respectively.

Returns
String string representation of InputConfiguration