> ## 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 內容)

> GDK 燈光 API 參考，用於列舉鍵盤、滑鼠和耳機等 LampArray 周邊裝置，並控制其 RGB 燈光。

# 燈光 API 參考

Microsoft Game Development Kit (GDK) 的燈光 API 參考資料。使用這些 API 來列舉相容的 LampArray 周邊裝置 (鍵盤、滑鼠、耳機和其他 HID 燈光裝置)，並控制其 RGB 燈光。

## 列舉相容的周邊裝置

若要探索相容的周邊裝置，請註冊狀態回呼，LampArray API 會針對每個已連接的裝置叫用此回呼，並在每次連接或移除裝置時再次叫用。

1. 實作 [LampArrayStatusCallback](https://docs.xbox.com/zh-TW/reference/lighting/lamparray/functions/lamparraystatuscallback.md) 函式以接收裝置連接和中斷連接事件。
2. 呼叫 [RegisterLampArrayStatusCallback](https://docs.xbox.com/zh-TW/reference/lighting/lamparray/functions/registerlamparraystatuscallback.md) 以註冊回呼。傳遞 [LampArrayEnumerationKind](https://docs.xbox.com/zh-TW/reference/lighting/lamparray/enums/lamparrayenumerationkind.md) 值，以控制初始列舉要以非同步方式執行，還是封鎖直到所有已連接的裝置都已回報為止。
3. 在回呼中，檢查 [ILampArray](https://docs.xbox.com/zh-TW/reference/lighting/lamparray/interfaces/ilamparray/ilamparray.md) 執行個體以讀取裝置屬性，例如 [DeviceId](https://docs.xbox.com/zh-TW/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getdeviceid.md)、[LampArrayKind](https://docs.xbox.com/zh-TW/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getlamparraykind.md)、[LampCount](https://docs.xbox.com/zh-TW/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getlampcount.md)、[VendorId](https://docs.xbox.com/zh-TW/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getvendorid.md) 和 [ProductId](https://docs.xbox.com/zh-TW/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getproductid.md)。
4. 當您不再需要通知時，請呼叫 [UnregisterLampArrayCallback](https://docs.xbox.com/zh-TW/reference/lighting/lamparray/functions/unregisterlamparraycallback.md) 以停止接收事件。

如需包含範例程式碼的完整逐步解說，請參閱 [LampArray 基本概念](https://docs.xbox.com/zh-TW/build/core-features/common/lighting/lighting-basics.md)。

## 本節內容

[LampArray](https://docs.xbox.com/zh-TW/reference/lighting/lamparray/lamparray_members.md)\
LampArray API 成員，包括用於列舉裝置和控制燈光的函式、介面、列舉和結構。

## 另請參閱

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


## Related topics

- [API 參考 (內容)](https://docs.xbox.com/zh-TW/reference/gc-reference-toc.md)
- [聊天 API 參考 (內容)](https://docs.xbox.com/zh-TW/reference/chat/gc-reference-chat-toc.md)
- [HttpClient API 參考 (內容)](https://docs.xbox.com/zh-TW/reference/live/httpclient/atoc-httpclient.md)
- [XGameSave Wrapper 參考 (API 內容)](https://docs.xbox.com/zh-TW/reference/system/Wrappers/xgamesave_wrapper_members.md)
- [Windows Device Portal REST API 參考 (API 內容)](https://docs.xbox.com/zh-TW/reference/deviceportal/atoc-deviceportal-reference.md)