Added in API level 36

AmbientBacklightSettings

---

Kotlin |Java

class AmbientBacklightSettings : Parcelable

kotlin.Any
↳	android.media.quality.AmbientBacklightSettings

Settings to configure ambient backlight hardware.

Summary

Constants
static Int	SOURCE_AUDIO The detection is enabled for audio.
static Int	SOURCE_AUDIO_VIDEO The detection is enabled for audio and video.
static Int	SOURCE_NONE The detection is disabled.
static Int	SOURCE_VIDEO The detection is enabled for video.

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public constructors
AmbientBacklightSettings(source: Int, maxFps: Int, colorFormat: Int, horizontalZonesNumber: Int, verticalZonesNumber: Int, isLetterboxOmitted: Boolean, threshold: Int) Constructs AmbientBacklightSettings.

Public methods
Int	describeContents()
Int	getColorFormat() Gets color format.
Int	getHorizontalZonesCount() Gets the number of horizontal color zones.
Int	getMaxFps() Gets max frames per second.
Int	getSource() Gets source of ambient backlight detection.
Int	getThreshold() Gets the detection threshold of the ambient light.
Int	getVerticalZonesCount() Gets the number of vertical color zones.
Boolean	isLetterboxOmitted() Returns true if the black portion of the screen in letter box mode is omitted; false otherwise.
String	toString()
Unit	writeToParcel(dest: Parcel, flags: Int)

Properties
static Parcelable.Creator<AmbientBacklightSettings!>	CREATOR

Constants

SOURCE_AUDIO

Added in API level 36

static val SOURCE_AUDIO: Int

The detection is enabled for audio.

Value: 1

SOURCE_AUDIO_VIDEO

Added in API level 36

static val SOURCE_AUDIO_VIDEO: Int

The detection is enabled for audio and video.

Value: 3

SOURCE_NONE

Added in API level 36

static val SOURCE_NONE: Int

The detection is disabled.

Value: 0

SOURCE_VIDEO

Added in API level 36

static val SOURCE_VIDEO: Int

The detection is enabled for video.

Value: 2

Public constructors

AmbientBacklightSettings

Added in API level 36

AmbientBacklightSettings(
    source: Int, 
    maxFps: Int, 
    colorFormat: Int, 
    horizontalZonesNumber: Int, 
    verticalZonesNumber: Int, 
    isLetterboxOmitted: Boolean, 
    threshold: Int)

Constructs AmbientBacklightSettings.

Parameters
source	Int: Value is android.media.quality.AmbientBacklightSettings#SOURCE_NONE, android.media.quality.AmbientBacklightSettings#SOURCE_AUDIO, android.media.quality.AmbientBacklightSettings#SOURCE_VIDEO, or android.media.quality.AmbientBacklightSettings#SOURCE_AUDIO_VIDEO
colorFormat	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

Public methods

describeContents

Added in API level 36

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

Added in API level 36

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

Added in API level 36

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

Added in API level 36

fun getMaxFps(): Int

Gets max frames per second.

Return
Int	Value is 1 or greater

getSource

Added in API level 36

fun getSource(): Int

Gets source of ambient backlight detection.

Return
Int	Value is android.media.quality.AmbientBacklightSettings#SOURCE_NONE, android.media.quality.AmbientBacklightSettings#SOURCE_AUDIO, android.media.quality.AmbientBacklightSettings#SOURCE_VIDEO, or android.media.quality.AmbientBacklightSettings#SOURCE_AUDIO_VIDEO

getThreshold

Added in API level 36

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

Added in API level 36

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

Added in API level 36

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

Added in API level 36

fun toString(): String

Return
String	a string representation of the object.

writeToParcel

Added in API level 36

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

Properties

CREATOR

Added in API level 36

static val CREATOR: Parcelable.Creator<AmbientBacklightSettings!>