> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 光照 API 参考（API 内容）

> 光照 API 参考

# 光照 API 参考

Microsoft Game Development Kit (GDK) 的光照 API 参考资料。使用这些 API 可以枚举兼容的 LampArray 外围设备（键盘、鼠标、耳机以及其他 HID 光照设备），并控制它们的 RGB 光照。

## 枚举兼容的外围设备

要发现兼容的外围设备，请注册一个状态回调，LampArray API 会针对每个已连接的设备调用该回调，并在每次设备连接或断开时再次调用。

1. 实现一个 [LampArrayStatusCallback](https://docs.xbox.com/zh-CN/reference/lighting/lamparray/functions/lamparraystatuscallback.md) 函数以接收设备连接和断开事件。
2. 调用 [RegisterLampArrayStatusCallback](https://docs.xbox.com/zh-CN/reference/lighting/lamparray/functions/registerlamparraystatuscallback.md) 来注册回调。传入 [LampArrayEnumerationKind](https://docs.xbox.com/zh-CN/reference/lighting/lamparray/enums/lamparrayenumerationkind.md) 值以控制初始枚举是异步执行，还是阻塞直到每个已连接设备都被上报。
3. 在回调中，检查 [ILampArray](https://docs.xbox.com/zh-CN/reference/lighting/lamparray/interfaces/ilamparray/ilamparray.md) 实例，读取设备属性，例如 [DeviceId](https://docs.xbox.com/zh-CN/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getdeviceid.md)、[LampArrayKind](https://docs.xbox.com/zh-CN/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getlamparraykind.md)、[LampCount](https://docs.xbox.com/zh-CN/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getlampcount.md)、[VendorId](https://docs.xbox.com/zh-CN/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getvendorid.md) 和 [ProductId](https://docs.xbox.com/zh-CN/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getproductid.md)。
4. 当不再需要通知时，调用 [UnregisterLampArrayStatusCallback](https://docs.xbox.com/zh-CN/reference/lighting/lamparray/functions/unregisterlamparraycallback.md) 停止接收事件。

有关包含示例代码的完整演练，请参阅 [LampArray 基础](https://docs.xbox.com/zh-CN/build/core-features/common/lighting/lighting-basics.md)。

## 本节内容

[LampArray](https://docs.xbox.com/zh-CN/reference/lighting/lamparray/lamparray_members.md)\
LampArray API 成员，包括用于枚举设备和控制光照的函数、接口、枚举和结构。

## 另请参阅

[光照 API 概览](https://docs.xbox.com/zh-CN/build/core-features/common/lighting/gc-lighting-toc.md)


## Related topics

- [API 参考（内容）](https://docs.xbox.com/zh-CN/reference/gc-reference-toc.md)
- [聊天 API 参考（内容）](https://docs.xbox.com/zh-CN/reference/chat/gc-reference-chat-toc.md)
- [HttpClient API 参考（内容）](https://docs.xbox.com/zh-CN/reference/live/httpclient/atoc-httpclient.md)
- [输入 API 参考](https://docs.xbox.com/zh-CN/reference/input/gc-reference-input-toc.md)
- [XGameSave Wrapper 参考（API 内容）](https://docs.xbox.com/zh-CN/reference/system/Wrappers/xgamesave_wrapper_members.md)