AmbientBacklightEvent

Kotlin |Java

class AmbientBacklightEvent : Parcelable

kotlin.Any
↳	android.media.quality.AmbientBacklightEvent

Ambient backlight event

Summary

Constants
static Int	`AMBIENT_BACKLIGHT_EVENT_DISABLED` Event type for ambient backlight events.
static Int	`AMBIENT_BACKLIGHT_EVENT_ENABLED` Event type for ambient backlight events.
static Int	`AMBIENT_BACKLIGHT_EVENT_INTERRUPTED` Event type for ambient backlight events.
static Int	`AMBIENT_BACKLIGHT_EVENT_METADATA_AVAILABLE` Event type for ambient backlight events.

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
`AmbientBacklightEvent(eventType: Int, metadata: AmbientBacklightMetadata?)` Constructs AmbientBacklightEvent.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)`
Int	`getEventType()` Gets event type.
AmbientBacklightMetadata?	`getMetadata()` Gets ambient backlight metadata.
Int	`hashCode()`
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<AmbientBacklightEvent!>	`CREATOR`

Constants

AMBIENT_BACKLIGHT_EVENT_DISABLED

Added in API level 36

static val AMBIENT_BACKLIGHT_EVENT_DISABLED: Int

Event type for ambient backlight events. The ambient backlight is disabled.

Value: 2

AMBIENT_BACKLIGHT_EVENT_ENABLED

Added in API level 36

static val AMBIENT_BACKLIGHT_EVENT_ENABLED: Int

Event type for ambient backlight events. The ambient backlight is enabled.

Value: 1

AMBIENT_BACKLIGHT_EVENT_INTERRUPTED

Added in API level 36

static val AMBIENT_BACKLIGHT_EVENT_INTERRUPTED: Int

Event type for ambient backlight events. The ambient backlight event is preempted by another application.

Value: 4

AMBIENT_BACKLIGHT_EVENT_METADATA_AVAILABLE

Added in API level 36

static val AMBIENT_BACKLIGHT_EVENT_METADATA_AVAILABLE: Int

Event type for ambient backlight events. The ambient backlight metadata is available.

Value: 3

Public constructors

AmbientBacklightEvent

Added in API level 36

AmbientBacklightEvent(
    eventType: Int, 
    metadata: AmbientBacklightMetadata?)

Constructs AmbientBacklightEvent.

Parameters
`eventType`	Int: Value is `android.media.quality.AmbientBacklightEvent#AMBIENT_BACKLIGHT_EVENT_ENABLED`, `android.media.quality.AmbientBacklightEvent#AMBIENT_BACKLIGHT_EVENT_DISABLED`, `android.media.quality.AmbientBacklightEvent#AMBIENT_BACKLIGHT_EVENT_METADATA_AVAILABLE`, or `android.media.quality.AmbientBacklightEvent#AMBIENT_BACKLIGHT_EVENT_INTERRUPTED`
`metadata`	AmbientBacklightMetadata?: This value may be `null`.

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`

equals

Added in API level 36

fun equals(other: Any?): Boolean

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getEventType

Added in API level 36

fun getEventType(): Int

Gets event type.

Return
`Int`	Value is `android.media.quality.AmbientBacklightEvent#AMBIENT_BACKLIGHT_EVENT_ENABLED`, `android.media.quality.AmbientBacklightEvent#AMBIENT_BACKLIGHT_EVENT_DISABLED`, `android.media.quality.AmbientBacklightEvent#AMBIENT_BACKLIGHT_EVENT_METADATA_AVAILABLE`, or `android.media.quality.AmbientBacklightEvent#AMBIENT_BACKLIGHT_EVENT_INTERRUPTED`

getMetadata

Added in API level 36

fun getMetadata(): AmbientBacklightMetadata?

Gets ambient backlight metadata.

Return
`AmbientBacklightMetadata?`	the metadata of the event. It's non-null only for `AMBIENT_BACKLIGHT_EVENT_METADATA_AVAILABLE`.

hashCode

Added in API level 36

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

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

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_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<AmbientBacklightEvent!>