> ## 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.

# Referência da API de iluminação (conteúdo da API)

> Referência da API de iluminação do GDK para enumerar periféricos LampArray, como teclados, mouses e headsets, e controlar sua iluminação RGB.

# Referência da API de iluminação

Material de referência da API de iluminação para o Microsoft Game Development Kit (GDK). Use essas APIs para enumerar periféricos LampArray compatíveis (teclados, mouses, headsets e outros dispositivos de iluminação HID) e controlar sua iluminação RGB.

## Enumerar periféricos compatíveis

Para descobrir periféricos compatíveis, registre um retorno de chamada de status que a API LampArray invoca para cada dispositivo conectado e novamente sempre que um dispositivo é conectado ou removido.

1. Implemente uma função [LampArrayStatusCallback](https://docs.xbox.com/pt-BR/reference/lighting/lamparray/functions/lamparraystatuscallback.md) para receber eventos de conexão e desconexão de dispositivos.
2. Chame [RegisterLampArrayStatusCallback](https://docs.xbox.com/pt-BR/reference/lighting/lamparray/functions/registerlamparraystatuscallback.md) para registrar o retorno de chamada. Passe um valor de [LampArrayEnumerationKind](https://docs.xbox.com/pt-BR/reference/lighting/lamparray/enums/lamparrayenumerationkind.md) para controlar se a enumeração inicial é executada de forma assíncrona ou fica bloqueada até que todos os dispositivos conectados tenham sido relatados.
3. No retorno de chamada, inspecione a instância de [ILampArray](https://docs.xbox.com/pt-BR/reference/lighting/lamparray/interfaces/ilamparray/ilamparray.md) para ler propriedades do dispositivo, como [DeviceId](https://docs.xbox.com/pt-BR/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getdeviceid.md), [LampArrayKind](https://docs.xbox.com/pt-BR/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getlamparraykind.md), [LampCount](https://docs.xbox.com/pt-BR/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getlampcount.md), [VendorId](https://docs.xbox.com/pt-BR/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getvendorid.md) e [ProductId](https://docs.xbox.com/pt-BR/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getproductid.md).
4. Quando não precisar mais de notificações, chame [UnregisterLampArrayCallback](https://docs.xbox.com/pt-BR/reference/lighting/lamparray/functions/unregisterlamparraycallback.md) para parar de receber eventos.

Para obter um passo a passo completo com código de exemplo, consulte [Noções básicas do LampArray](https://docs.xbox.com/pt-BR/build/core-features/common/lighting/lighting-basics.md).

## Nesta seção

[LampArray](https://docs.xbox.com/pt-BR/reference/lighting/lamparray/lamparray_members.md)\
Membros da API LampArray, incluindo as funções, interfaces, enumerações e structs usadas para enumerar dispositivos e controlar a iluminação.

## Confira também

[Visão geral da API de iluminação](https://docs.xbox.com/pt-BR/build/core-features/common/lighting/gc-lighting-toc.md)


## Related topics

- [Referência da API de chat (conteúdo)](https://docs.xbox.com/pt-BR/reference/chat/gc-reference-chat-toc.md)
- [Referência da API REST do Windows Device Portal (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/deviceportal/atoc-deviceportal-reference.md)
- [Referência da API HttpClient (conteúdo)](https://docs.xbox.com/pt-BR/reference/live/httpclient/atoc-httpclient.md)
- [XStore (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/system/xstore/xstore_members.md)
- [Referência da API REST](https://docs.xbox.com/pt-BR/services/playfab/api-references/index.md)