# Print output for @column tags ?>
Developers

- Design
- Develop
- Distribute

Developer Console

## Most visited

## Recently visited

## Results for

Summary: Ctors | Methods | Inherited Methods

# CaptureResult.Key

`public static final class CaptureResult.Key`
`extends Object` ``

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

A `Key` is used to do capture result field lookups with `CaptureResult#get`.

For example, to get the timestamp corresponding to the exposure of the first row: ``

     long timestamp = captureResult.get(CaptureResult.SENSOR_TIMESTAMP);

To enumerate over all possible keys for `CaptureResult`, see `CameraCharacteristics#getAvailableCaptureResultKeys`.

See also:

- `CaptureResult.get(CaptureResult.Key)`
- `CameraCharacteristics.getAvailableCaptureResultKeys()`

## 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 timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void` | `wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void` | `wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

## Public constructors

### Key

    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 `CaptureResult`, and not need to construct their own Key objects. However, they may be useful for testing purposes and for defining custom capture result fields.

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

## Public methods

### equals

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

The `equals` method for class `Object` implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values `x` and `y`, this method returns `true` if and only if `x` and `y` refer to the same object (`x == y` has the value `true`).

Note that it is generally necessary to override the `hashCode` method whenever this method is overridden, so as to maintain the general contract for the `hashCode` method, which states that equal objects must have equal hash codes.

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

    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

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

    public String toString ()

Return this `Key` as a string representation.

`"CaptureResult.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`.

Full name *
Email address *
Company / developer name
One of your Play Store app URLs *
Which best describes your business:*
Apps
Games
Apps & Games
*
*