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

# 光照 API 参考

> 光照 API 参考

# 光照 API 参考

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

## 枚举兼容的外围设备

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

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

有关包含示例代码的完整演练，请参阅 [LampArray 基础](/build/core-features/common/lighting/lighting-basics)。

## 本节内容

[LampArray](/reference/lighting/lamparray/lamparray_members)<br />LampArray API 成员，包括用于枚举设备和控制光照的函数、接口、枚举和结构。

## 另请参阅

[光照 API 概览](/build/core-features/common/lighting/gc-lighting-toc)


## Related topics

- [光照 API 概览](/zh-CN/build/core-features/common/lighting/gc-lighting-toc.md)
- [系统 API 参考](/zh-CN/reference/system/gc-reference-system-toc.md)
- [输入 API 参考](/zh-CN/reference/input/gc-reference-input-toc.md)
- [聊天 API 参考](/zh-CN/reference/chat/gc-reference-chat-toc.md)
- [音频 API 参考](/zh-CN/reference/audio/gc-reference-audio-toc.md)