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

# Referência da API de iluminação para periféricos LampArray

> 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](/pt-BR/reference/lighting/lamparray/functions/lamparraystatuscallback) para receber eventos de conexão e desconexão de dispositivos.
2. Chame [RegisterLampArrayStatusCallback](/pt-BR/reference/lighting/lamparray/functions/registerlamparraystatuscallback) para registrar o retorno de chamada. Passe um valor de [LampArrayEnumerationKind](/pt-BR/reference/lighting/lamparray/enums/lamparrayenumerationkind) 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](/pt-BR/reference/lighting/lamparray/interfaces/ilamparray/ilamparray) para ler propriedades do dispositivo, como [DeviceId](/pt-BR/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getdeviceid), [LampArrayKind](/pt-BR/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getlamparraykind), [LampCount](/pt-BR/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getlampcount), [VendorId](/pt-BR/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getvendorid) e [ProductId](/pt-BR/reference/lighting/lamparray/interfaces/ilamparray/methods/ilamparray_getproductid).
4. Quando não precisar mais de notificações, chame [UnregisterLampArrayCallback](/pt-BR/reference/lighting/lamparray/functions/unregisterlamparraycallback) para parar de receber eventos.

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

## Nesta seção

[LampArray](/pt-BR/reference/lighting/lamparray/lamparray_members)<br />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](/pt-BR/build/core-features/common/lighting/gc-lighting-toc)


## Related topics

- [Referencia de la API de iluminación para periféricos LampArray](/es/reference/lighting/gc-reference-lighting-toc.md)
- [Referencia de miembros de la API LampArray](/es/reference/lighting/lamparray/lamparray_members.md)
- [Referencia de la función RegisterLampArrayCallback](/es/reference/lighting/lamparray/functions/registerlamparraycallback.md)
- [Referencia de la interfaz ILampArray](/es/reference/lighting/lamparray/interfaces/ilamparray/ilamparray.md)
- [Referencia de la función LampArrayCallback](/es/reference/lighting/lamparray/functions/lamparraycallback.md)