HdrConversionMode

public final class HdrConversionMode
extends Object implements Parcelable

java.lang.Object
   ↳ android.hardware.display.HdrConversionMode


Describes the HDR conversion mode for a device. HDR conversion mode has a conversionMode and preferredHdrOutputType.

The conversionMode can be one of: HdrConversionMode#HDR_CONVERSION_UNSUPPORTED : HDR conversion is unsupported. In this mode, preferredHdrOutputType should not be set. HdrConversionMode#HDR_CONVERSION_PASSTHROUGH : HDR conversion is disabled. The output HDR type will change dynamically to match the content. In this mode, preferredHdrOutputType should not be set. HdrConversionMode#HDR_CONVERSION_SYSTEM: The output HDR type is selected by the implementation. In this mode, preferredHdrOutputType will be the mode preferred by the system when querying. However, it should be set to HDR_TYPE_INVALID when setting the mode. HdrConversionMode#HDR_CONVERSION_FORCE: The implementation converts all content to this HDR type, when possible. In this mode, preferredHdrOutputType should be set.

Summary

Constants

int HDR_CONVERSION_FORCE

HDR output conversion is set by the user.

int HDR_CONVERSION_PASSTHROUGH

HDR output conversion is disabled

int HDR_CONVERSION_SYSTEM

HDR output conversion is managed by the device manufacturer's implementation.

int HDR_CONVERSION_UNSUPPORTED

HDR output conversion is unsupported

Inherited constants

Fields

public static final Creator<HdrConversionMode> CREATOR

Public constructors

HdrConversionMode(int conversionMode, int preferredHdrOutputType)
HdrConversionMode(int conversionMode)

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

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

int getConversionMode()
int getPreferredHdrOutputType()
int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

HDR_CONVERSION_FORCE

Added in API level 34
public static final int HDR_CONVERSION_FORCE

HDR output conversion is set by the user. The preferred output type must be set in this case.

Constant Value: 3 (0x00000003)

HDR_CONVERSION_PASSTHROUGH

Added in API level 34
public static final int HDR_CONVERSION_PASSTHROUGH

HDR output conversion is disabled

Constant Value: 1 (0x00000001)

HDR_CONVERSION_SYSTEM

Added in API level 34
public static final int HDR_CONVERSION_SYSTEM

HDR output conversion is managed by the device manufacturer's implementation.

Constant Value: 2 (0x00000002)

HDR_CONVERSION_UNSUPPORTED

Added in API level 34
public static final int HDR_CONVERSION_UNSUPPORTED

HDR output conversion is unsupported

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 34
public static final Creator<HdrConversionMode> CREATOR

Public constructors

HdrConversionMode

Added in API level 34
public HdrConversionMode (int conversionMode, 
                int preferredHdrOutputType)

Parameters
conversionMode int: Value is HDR_CONVERSION_PASSTHROUGH, HDR_CONVERSION_SYSTEM, or HDR_CONVERSION_FORCE

preferredHdrOutputType int: Value is Display.HdrCapabilities.HDR_TYPE_INVALID, Display.HdrCapabilities.HDR_TYPE_DOLBY_VISION, Display.HdrCapabilities.HDR_TYPE_HDR10, Display.HdrCapabilities.HDR_TYPE_HLG, or Display.HdrCapabilities.HDR_TYPE_HDR10_PLUS

HdrConversionMode

Added in API level 34
public HdrConversionMode (int conversionMode)

Parameters
conversionMode int: Value is HDR_CONVERSION_PASSTHROUGH, HDR_CONVERSION_SYSTEM, or HDR_CONVERSION_FORCE

Public methods

describeContents

Added in API level 34
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 34
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: This value may be null.

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

getConversionMode

Added in API level 34
public int getConversionMode ()

Returns
int Value is HDR_CONVERSION_PASSTHROUGH, HDR_CONVERSION_SYSTEM, or HDR_CONVERSION_FORCE

hashCode

Added in API level 34
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 34
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 34
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES