DeviceStateSensorOrientationMap

public final class DeviceStateSensorOrientationMap
extends Object

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

Immutable class that maps the device fold state to sensor orientation.

Some logical cameras on foldables can include physical sensors with different sensor orientation values. As a result, the values of the logical camera device can potentially change depending on the device fold state.

The device fold state to sensor orientation map will contain information about the respective logical camera sensor orientation given a device state. Clients can query the mapping for all possible supported folded states.

Summary

Nested classes

class DeviceStateSensorOrientationMap.Builder

Builds a DeviceStateSensorOrientationMap object. 

Constants

long FOLDED

The device is folded.

long NORMAL

The device is in its normal physical configuration.

Public methods

boolean equals(Object obj)

Check if this DeviceStateSensorOrientationMap is equal to another DeviceStateSensorOrientationMap.

int getSensorOrientation(long deviceState)

Return the logical camera sensor orientation given a specific device fold state.

int hashCode()

Returns a hash code value for the object.

Inherited methods

Constants

FOLDED

Added in API level 32 
public static final long FOLDED

The device is folded. If not set, the device is unfolded or does not support folding. The exact point when this status change happens during the folding operation is device-specific.

Constant Value: 4 (0x0000000000000004)

NORMAL

Added in API level 32 
public static final long NORMAL

The device is in its normal physical configuration. This is the default if the device does not support multiple different states.

Constant Value: 0 (0x0000000000000000)

Public methods

equals

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

Check if this DeviceStateSensorOrientationMap is equal to another DeviceStateSensorOrientationMap.

Two device state orientation maps are equal if and only if all of their elements are equal.

Parameters
obj Object: the reference object with which to compare.
Returns
boolean true if the objects were equal, false otherwise

getSensorOrientation

Added in API level 32 
public int getSensorOrientation (long deviceState)

Return the logical camera sensor orientation given a specific device fold state.

Parameters
deviceState long: Device fold state Value is NORMAL, or FOLDED
Returns
int Valid CameraCharacteristics.SENSOR_ORIENTATION for any supported device fold state
Throws
IllegalArgumentException if the given device state is invalid

hashCode

Added in API level 32 
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.