Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/android/hardware/camera2/params/OisSample#pubctors) \| [Methods](https://developer.android.com/reference/android/hardware/camera2/params/OisSample#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/hardware/camera2/params/OisSample#inhmethods)
# OisSample
*** ** * ** ***
`
public
final
class
OisSample
`
`
extends https://developer.android.com/reference/java/lang/Object
`
`
`
|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.hardware.camera2.params.OisSample |
*** ** * ** ***
Immutable class to store an
`https://developer.android.com/reference/android/hardware/camera2/CaptureResult#STATISTICS_OIS_SAMPLES`.
## Summary
| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/hardware/camera2/params/OisSample#OisSample(long,%20float,%20float)(long timestamp, float xShift, float yShift) ` Create a new `https://developer.android.com/reference/android/hardware/camera2/params/OisSample`. |
| ### Public methods ||
|---|---|
| ` boolean` | ` https://developer.android.com/reference/android/hardware/camera2/params/OisSample#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Check if this `https://developer.android.com/reference/android/hardware/camera2/params/OisSample` is equal to another `https://developer.android.com/reference/android/hardware/camera2/params/OisSample`. |
| ` long` | ` https://developer.android.com/reference/android/hardware/camera2/params/OisSample#getTimestamp()() ` Get the timestamp in nanoseconds. |
| ` float` | ` https://developer.android.com/reference/android/hardware/camera2/params/OisSample#getXshift()() ` Get the shift in x direction. |
| ` float` | ` https://developer.android.com/reference/android/hardware/camera2/params/OisSample#getYshift()() ` Get the shift in y direction. |
| ` int` | ` https://developer.android.com/reference/android/hardware/camera2/params/OisSample#hashCode()() ` Returns a hash code value for the object. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/hardware/camera2/params/OisSample#toString()() ` Return the OisSample as a string representation. |
| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
## Public constructors
### OisSample
Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public OisSample (long timestamp,
float xShift,
float yShift)
```
Create a new `https://developer.android.com/reference/android/hardware/camera2/params/OisSample`.
`https://developer.android.com/reference/android/hardware/camera2/params/OisSample` contains the timestamp and the amount of shifts in x and y direction,
in pixels, of the OIS sample.
A positive value for a shift in x direction is a shift from left to right in active array
coordinate system. For example, if the optical center is `(1000, 500)` in active array
coordinates, a shift of `(3, 0)` puts the new optical center at `(1003, 500)`.
A positive value for a shift in y direction is a shift from top to bottom in active array
coordinate system. For example, if the optical center is `(1000, 500)` in active array
coordinates, a shift of `(0, 5)` puts the new optical center at `(1000, 505)`.
xShift and yShift must be finite; NaN and infinity is not allowed.
| Parameters ||
|---|---|
| `timestamp` | `long`: timestamp of the OIS sample.
|
| `xShift` | `float`: shift of the OIS sample in x direction.
|
| `yShift` | `float`: shift of the OIS sample in y direction.
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if xShift or yShift is not finite |
## Public methods
### equals
Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean equals (Object obj)
```
Check if this `https://developer.android.com/reference/android/hardware/camera2/params/OisSample` is equal to another `https://developer.android.com/reference/android/hardware/camera2/params/OisSample`.
Two samples are only equal if and only if each of the OIS information is equal.
| Parameters ||
|---|---|
| `obj` | `Object`: the reference object with which to compare.
|
| Returns ||
|---|---|
| `boolean` | `true` if the objects were equal, `false` otherwise
|
### getTimestamp
Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public long getTimestamp ()
```
Get the timestamp in nanoseconds.
The timestamps are in the same timebase as and comparable to
`https://developer.android.com/reference/android/hardware/camera2/CaptureResult#SENSOR_TIMESTAMP`.
| Returns ||
|---|---|
| `long` | a long value (guaranteed to be finite)
|
### getXshift
Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public float getXshift ()
```
Get the shift in x direction.
| Returns ||
|---|---|
| `float` | a floating point value (guaranteed to be finite)
|
### getYshift
Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public float getYshift ()
```
Get the shift in y direction.
| Returns ||
|---|---|
| `float` | a floating point value (guaranteed to be finite)
|
### hashCode
Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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
`https://developer.android.com/reference/java/util/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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.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 `https://developer.android.com/reference/java/lang/Object#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.
| Returns ||
|---|---|
| `int` | a hash code value for this object.
|
### toString
Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String toString ()
```
Return the OisSample as a string representation.
`"OisSample{timestamp:%l, shift_x:%f, shift_y:%f}"` represents the OIS sample's
timestamp, shift in x direction, and shift in y direction.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | string representation of `https://developer.android.com/reference/android/hardware/camera2/params/OisSample`
|