blob: 43fdb4bf81a13168dfbc688799ff3aab609f8916 [file] [log] [blame]
Steven Moreland84dd3b72019-07-25 17:13:52 -07001/*
2 * Copyright (C) 2019 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.hardware.light;
18
19import android.hardware.light.LightType;
20
21/**
22 * A description of a single light. Multiple lights can map to the same physical
23 * LED. Separate physical LEDs are always represented by separate instances.
24 */
25@VintfStability
26parcelable HwLight {
27 /**
28 * Integer ID used for controlling this light
29 */
30 int id;
31
32 /**
33 * For a group of lights of the same logical type, sorting by ordinal should
34 * be give their physical order. No other meaning is carried by it.
35 */
36 int ordinal;
37
38 /**
39 * Logical type use of this light.
40 */
41 LightType type;
42}