Added in API level 36

AmbientBacklightMetadata

Kotlin |Java

public final class AmbientBacklightMetadata
extends Object implements Parcelable

java.lang.Object
↳	android.media.quality.AmbientBacklightMetadata

Metadata of ambient backlight.

A metadata instance is sent from ambient backlight hardware in a AmbientBacklightEvent with AmbientBacklightEvent.AMBIENT_BACKLIGHT_EVENT_METADATA_AVAILABLE.

Summary

Constants
`int`	`ALGORITHM_NONE` The compress algorithm is disabled.
`int`	`ALGORITHM_RLE` The compress algorithm is run length encoding (RLE).

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<AmbientBacklightMetadata>`	`CREATOR`

Public constructors
`AmbientBacklightMetadata(String packageName, int compressAlgorithm, int source, int colorFormat, int horizontalZonesNumber, int verticalZonesNumber, int[] zonesColors)` Constructs AmbientBacklightMetadata.

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`int`	`getColorFormat()` Gets color format.
`int`	`getCompressionAlgorithm()` Gets compress algorithm.
`int`	`getHorizontalZonesCount()` Gets the number of horizontal color zones.
`String`	`getPackageName()` Gets package name of the metadata.
`int`	`getSource()` Gets source of ambient backlight detection.
`int`	`getVerticalZonesCount()` Gets the number of vertical color zones.
`int[]`	`getZoneColors()` Gets color data of all available color zones.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

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.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

ALGORITHM_NONE

Added in API level 36

public static final int ALGORITHM_NONE

The compress algorithm is disabled.

Constant Value: 0 (0x00000000)

ALGORITHM_RLE

Added in API level 36

public static final int ALGORITHM_RLE

The compress algorithm is run length encoding (RLE).

Constant Value: 1 (0x00000001)

Fields

CREATOR

Added in API level 36

public static final Creator<AmbientBacklightMetadata> CREATOR

Public constructors

AmbientBacklightMetadata

Added in API level 36

public AmbientBacklightMetadata (String packageName, 
                int compressAlgorithm, 
                int source, 
                int colorFormat, 
                int horizontalZonesNumber, 
                int verticalZonesNumber, 
                int[] zonesColors)

Constructs AmbientBacklightMetadata.

Parameters
`packageName`	`String`
`compressAlgorithm`	`int`: Value is `ALGORITHM_NONE`, or `ALGORITHM_RLE`
`source`	`int`: Value is `AmbientBacklightSettings.SOURCE_NONE`, `AmbientBacklightSettings.SOURCE_AUDIO`, `AmbientBacklightSettings.SOURCE_VIDEO`, or `AmbientBacklightSettings.SOURCE_AUDIO_VIDEO`
`colorFormat`	`int`: Value is `PixelFormat.RGBA_8888`, `PixelFormat.RGBX_8888`, `PixelFormat.RGBA_F16`, `PixelFormat.RGBA_1010102`, `PixelFormat.RGB_888`, `PixelFormat.RGB_565`, or android.graphics.PixelFormat.R_8
`horizontalZonesNumber`	`int`
`verticalZonesNumber`	`int`
`zonesColors`	`int`

Public methods

describeContents

Added in API level 36

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`

getColorFormat

Added in API level 36

public int getColorFormat ()

Gets color format.

Returns
`int`	Value is `PixelFormat.RGBA_8888`, `PixelFormat.RGBX_8888`, `PixelFormat.RGBA_F16`, `PixelFormat.RGBA_1010102`, `PixelFormat.RGB_888`, `PixelFormat.RGB_565`, or android.graphics.PixelFormat.R_8

getCompressionAlgorithm

Added in API level 36

public int getCompressionAlgorithm ()

Gets compress algorithm.

Returns
`int`	Value is `ALGORITHM_NONE`, or `ALGORITHM_RLE`

getHorizontalZonesCount

Added in API level 36

public int getHorizontalZonesCount ()

Gets the number of horizontal color zones.

A color zone is represented by one single aggregated color. The number should not be larger than 128.

Returns
`int`	Value is between 0 and 128 inclusive

getPackageName

Added in API level 36

public String getPackageName ()

Gets package name of the metadata.

Returns
`String`

getSource

Added in API level 36

public int getSource ()

Gets source of ambient backlight detection.

Returns
`int`	Value is `AmbientBacklightSettings.SOURCE_NONE`, `AmbientBacklightSettings.SOURCE_AUDIO`, `AmbientBacklightSettings.SOURCE_VIDEO`, or `AmbientBacklightSettings.SOURCE_AUDIO_VIDEO`

getVerticalZonesCount

Added in API level 36

public int getVerticalZonesCount ()

Gets the number of vertical color zones.

A color zone is represented by one single aggregated color. The number should not be larger than 80.

Returns
`int`	Value is between 0 and 80 inclusive

getZoneColors

Added in API level 36

public int[] getZoneColors ()

Gets color data of all available color zones.

The format of the color data can be found at getColorFormat().

Returns
`int[]`	an array of color data, in row by row (left-to-right then top-to-bottom) order of the color zones.

See also:

toString

Added in API level 36

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 36

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: The Parcel in which the object should be written. 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