Light Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a logical light on the device.
[Android.Runtime.Register("android/hardware/lights/Light", ApiSince=31, DoNotGenerateAcw=true)]
public sealed class Light : Java.Lang.Object, Android.OS.IParcelable, IDisposable
[<Android.Runtime.Register("android/hardware/lights/Light", ApiSince=31, DoNotGenerateAcw=true)>]
type Light = class
inherit Object
interface IParcelable
interface IJavaObject
interface IDisposable
interface IJavaPeerable
- Inheritance
- Attributes
- Implements
Remarks
Represents a logical light on the device.
Java documentation for android.hardware.lights.Light.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Fields
| Name | Description |
|---|---|
| LightCapabilityAnimation |
Obsolete.
Capability for lights that support animations and fast transitions. |
| LightCapabilityBrightness |
Obsolete.
Capability for lights that could adjust its LED brightness. |
| LightCapabilityColorRgb |
Obsolete.
Capability for lights that have red, green and blue LEDs to control the light's color. |
| LightCapabilityRgb |
Capability for lights that have red, green and blue LEDs to control the light's color. |
| LightTypeApplication |
Obsolete.
Type for lights that indicate application driven use cases. |
| LightTypeInput |
Obsolete.
Type for lights that indicate a monochrome color LED light. |
| LightTypeKeyboardBacklight |
Obsolete.
Type for lights that illuminate keyboard keys. |
| LightTypeMicrophone |
Obsolete.
Type for lights that indicate microphone usage |
| LightTypePlayerId |
Obsolete.
Type for lights that indicate a group of LED lights representing player id. |
Properties
| Name | Description |
|---|---|
| Class |
Returns the runtime class of this |
| Creator |
Implement the Parcelable interface |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| HasAnimationControl |
Check whether the light has animation capabilities. |
| HasBrightnessControl |
Check whether the light has led brightness control. |
| HasRgbControl |
Check whether the light has RGB led control. |
| Id |
Returns the id of the light. |
| JniIdentityHashCode |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniManagedPeerState |
Gets the state flags last assigned by the runtime. (Inherited from JavaObject) |
| JniPeerMembers |
Gets the JNI metadata used to access members of this Java binding. |
| MinUpdatePeriodMillis |
Returns the minimum update period supported by the light. |
| Name |
Returns the name of the light. |
| Ordinal |
Returns the ordinal of the light. |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
| ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
| Type |
Returns the logical type of the light. |
Methods
| Name | Description |
|---|---|
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Construct(JniObjectReference, JniObjectReferenceOptions) |
Delegates construction of this peer to the runtime's value manager. (Inherited from JavaObject) |
| DescribeContents() |
Implement the Parcelable interface |
| Dispose() |
Releases the resources held by this Java peer. (Inherited from Object) |
| Dispose(Boolean) |
Releases the resources held by this Java peer. (Inherited from Object) |
| DisposeUnlessReferenced() |
Asks the value manager to dispose this peer unless its mapping retains this same managed instance. (Inherited from JavaObject) |
| Equals(Object) |
Tests whether another managed peer refers to the same Java object. (Inherited from JavaObject) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| JavaFinalize() |
Obsolete.
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
| NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) |
Stores a reference value in the control block without creating a JNI reference copy. (Inherited from JavaObject) |
| ToArray<T>() |
Creates a managed array from this Java array wrapper. (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() |
Unregisters this Java peer from the interop runtime. (Inherited from Object) |
| Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
| Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| WriteToParcel(Parcel, ParcelableWriteFlags) |
Implement the Parcelable interface |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() |
Marks this peer as disposed and calls |
| IJavaPeerable.Finalized() |
Marks this peer as disposed and calls |
| IJavaPeerable.JniObjectReferenceControlBlock |
Gets the native control-block pointer used by this peer. (Inherited from JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) |
Stores the identity hash code supplied by the runtime. (Inherited from JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) |
Replaces the stored managed peer state flags. (Inherited from JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) |
Updates the peer reference and releases a disposed peer's control block when the reference is invalid. (Inherited from JavaObject) |
| IJavaPeerable.UnregisterFromRuntime() |
Removes this instance from the runtime's Java object lookup. |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) |
Reuses a compatible managed peer or obtains a wrapper of the requested type. |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |