AmbientBacklightMetadata
class AmbientBacklightMetadata : Parcelable
| kotlin.Any | |
| ↳ | 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 | |
|---|---|
| static Int |
The compress algorithm is disabled. |
| static Int |
The compress algorithm is run length encoding (RLE). |
| Inherited constants | |
|---|---|
| Public constructors | |
|---|---|
AmbientBacklightMetadata(packageName: String, compressAlgorithm: Int, source: Int, colorFormat: Int, horizontalZonesNumber: Int, verticalZonesNumber: Int, zonesColors: IntArray)Constructs AmbientBacklightMetadata. |
|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Int |
Gets color format. |
| Int |
Gets compress algorithm. |
| Int |
Gets the number of horizontal color zones. |
| String |
Gets package name of the metadata. |
| Int |
Gets source of ambient backlight detection. |
| Int |
Gets the number of vertical color zones. |
| IntArray |
Gets color data of all available color zones. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<AmbientBacklightMetadata!> | |
Constants
ALGORITHM_NONE
static val ALGORITHM_NONE: Int
The compress algorithm is disabled.
Value: 0ALGORITHM_RLE
static val ALGORITHM_RLE: Int
The compress algorithm is run length encoding (RLE).
Value: 1Public constructors
AmbientBacklightMetadata
AmbientBacklightMetadata(
packageName: String,
compressAlgorithm: Int,
source: Int,
colorFormat: Int,
horizontalZonesNumber: Int,
verticalZonesNumber: Int,
zonesColors: IntArray)
Constructs AmbientBacklightMetadata.
| Parameters | |
|---|---|
compressAlgorithm |
Int: Value is one of the following: |
source |
Int: Value is one of the following: |
colorFormat |
Int: Value is one of the following: |
Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
getColorFormat
fun getColorFormat(): Int
Gets color format.
| Return | |
|---|---|
Int |
Value is one of the following: |
getCompressionAlgorithm
fun getCompressionAlgorithm(): Int
Gets compress algorithm.
| Return | |
|---|---|
Int |
Value is one of the following: |
getHorizontalZonesCount
fun getHorizontalZonesCount(): Int
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.
| Return | |
|---|---|
Int |
Value is between 0 and 128 inclusive |
getPackageName
fun getPackageName(): String
Gets package name of the metadata.
getSource
fun getSource(): Int
Gets source of ambient backlight detection.
| Return | |
|---|---|
Int |
Value is one of the following: |
getVerticalZonesCount
fun getVerticalZonesCount(): Int
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.
| Return | |
|---|---|
Int |
Value is between 0 and 80 inclusive |
getZoneColors
fun getZoneColors(): IntArray
Gets color data of all available color zones.
The format of the color data can be found at getColorFormat().
| Return | |
|---|---|
IntArray |
an array of color data, in row by row (left-to-right then top-to-bottom) order of the color zones. |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|