CaptureRequest.Key

Kotlin |Java

public static final class CaptureRequest.Key
extends Object

java.lang.Object
↳	android.hardware.camera2.CaptureRequest.Key<T>

A Key is used to do capture request field lookups with CaptureRequest.get or to set fields with CaptureRequest.Builder.set(Key, Object).

For example, to set the crop rectangle for the next capture:

 Rect cropRectangle = new Rect(0, 0, 640, 480);
 captureRequestBuilder.set(SCALER_CROP_REGION, cropRectangle);

To enumerate over all possible keys for CaptureRequest, see CameraCharacteristics.getAvailableCaptureRequestKeys.

See also:

Summary

Public constructors
`Key(String name, Class<T> type)` Construct a new Key with a given name and type.

Public methods
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`String`	`getName()` Return a camelCase, period separated name formatted like: `"root.section[.subsections].name"`.
`int`	`hashCode()` Returns a hash code value for the object.
`String`	`toString()` Return this `Key` as a string representation.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Key

Added in API level 29

public Key (String name, 
                Class<T> type)

Construct a new Key with a given name and type.

Normally, applications should use the existing Key definitions in CaptureRequest, and not need to construct their own Key objects. However, they may be useful for testing purposes and for defining custom capture request fields.

Parameters
`name`	`String`: This value cannot be `null`.
`type`	`Class`: This value cannot be `null`.

Public methods

equals

Added in API level 21

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`o`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getName

Added in API level 21

public String getName ()

Return a camelCase, period separated name formatted like: "root.section[.subsections].name".

Built-in keys exposed by the Android SDK are always prefixed with "android."; keys that are device/platform-specific are prefixed with "com.".

For example, CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP would have a name of "android.scaler.streamConfigurationMap"; whereas a device specific key might look like "com.google.nexus.data.private".

Returns
`String`	String representation of the key name This value cannot be `null`.

hashCode

Added in API level 21

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.

toString

Added in API level 21

public String toString ()

Return this Key as a string representation.

"CaptureRequest.Key(%s)", where %s represents the name of this key as returned by getName().

Returns
`String`	string representation of `Key` This value cannot be `null`.