AmbientBacklightSettings
class AmbientBacklightSettings : Parcelable
| kotlin.Any | |
| ↳ | android.media.quality.AmbientBacklightSettings |
Settings to configure ambient backlight hardware.
Summary
| Constants | |
|---|---|
| static Int |
The detection is enabled for audio. |
| static Int |
The detection is enabled for audio and video. |
| static Int |
The detection is disabled. |
| static Int |
The detection is enabled for video. |
| Inherited constants | |
|---|---|
| Public constructors | |
|---|---|
AmbientBacklightSettings(source: Int, maxFps: Int, colorFormat: Int, horizontalZonesNumber: Int, verticalZonesNumber: Int, isLetterboxOmitted: Boolean, threshold: Int)Constructs AmbientBacklightSettings. |
|
| Public methods | |
|---|---|
| Int | |
| Int |
Gets color format. |
| Int |
Gets the number of horizontal color zones. |
| Int |
Gets max frames per second. |
| Int |
Gets source of ambient backlight detection. |
| Int |
Gets the detection threshold of the ambient light. |
| Int |
Gets the number of vertical color zones. |
| Boolean |
Returns |
| String |
toString() |
| Unit |
writeToParcel(dest: Parcel, flags: Int) |
| Properties | |
|---|---|
| static Parcelable.Creator<AmbientBacklightSettings!> | |
Constants
SOURCE_AUDIO
static val SOURCE_AUDIO: Int
The detection is enabled for audio.
Value: 1SOURCE_AUDIO_VIDEO
static val SOURCE_AUDIO_VIDEO: Int
The detection is enabled for audio and video.
Value: 3SOURCE_VIDEO
static val SOURCE_VIDEO: Int
The detection is enabled for video.
Value: 2Public constructors
AmbientBacklightSettings
AmbientBacklightSettings(
source: Int,
maxFps: Int,
colorFormat: Int,
horizontalZonesNumber: Int,
verticalZonesNumber: Int,
isLetterboxOmitted: Boolean,
threshold: Int)
Constructs AmbientBacklightSettings.
Public methods
describeContents
fun describeContents(): Int
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR |
getColorFormat
fun getColorFormat(): Int
Gets color format.
| Return | |
|---|---|
Int |
Value is android.graphics.PixelFormat#RGBA_8888, android.graphics.PixelFormat#RGBX_8888, android.graphics.PixelFormat#RGBA_F16, android.graphics.PixelFormat#RGBA_1010102, android.graphics.PixelFormat#RGB_888, android.graphics.PixelFormat#RGB_565, or android.graphics.PixelFormat.R_8 |
getHorizontalZonesCount
fun getHorizontalZonesCount(): Int
Gets the number of horizontal color zones.
A color zone is a group of lights that always display the same color.
| Return | |
|---|---|
Int |
Value is 0 or greater |
getMaxFps
fun getMaxFps(): Int
Gets max frames per second.
| Return | |
|---|---|
Int |
Value is 1 or greater |
getSource
fun getSource(): Int
Gets source of ambient backlight detection.
getThreshold
fun getThreshold(): Int
Gets the detection threshold of the ambient light.
If the color of a color zone is changed but the difference is smaller than the threshold, the change is ignored.
getVerticalZonesCount
fun getVerticalZonesCount(): Int
Gets the number of vertical color zones.
A color zone is a group of lights that always display the same color.
| Return | |
|---|---|
Int |
Value is 0 or greater |
isLetterboxOmitted
fun isLetterboxOmitted(): Boolean
Returns true if the black portion of the screen in letter box mode is omitted; false otherwise.
Letter-box is a technique to keep the original aspect ratio when displayed on a screen with different aspect ratio. Black bars are added to the top and bottom.
toString
fun toString(): String
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
| 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 android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |